Skip to content

[Docs] Refine the docstring of EvalHook #2576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhouzaida merged 3 commits into from
Jan 31, 2023
Merged

[Docs] Refine the docstring of EvalHook #2576

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0bf2a6
📃 docs(hooks): EvalHook comments
Yan-Daojiang Jan 31, 2023
caec3e6
Refine comments EvalHook
Yan-Daojiang Jan 31, 2023
3544a3a
📃 docs(Hooks): update Eval Hook
Yan-Daojiang Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions mmcv/runner/hooks/evaluation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ class EvalHook(Hook):
Args:
dataloader (DataLoader): A PyTorch dataloader, whose dataset has
implemented ``evaluate`` function.
start (int | None, optional): Evaluation starting epoch. It enables
evaluation before the training starts if ``start`` <= the resuming
epoch. If None, whether to evaluate is merely decided by
``interval``. Default: None.
start (int | None, optional): Evaluation starting epoch or iteration.
It enables evaluation before the training starts if ``start`` <=
the resuming epoch or iteration. If None, whether to evaluate is
merely decided by ``interval``. Default: None.
interval (int): Evaluation interval. Default: 1.
by_epoch (bool): Determine perform evaluation by epoch or by iteration.
If set to True, it will perform by epoch. Otherwise, by iteration.
Expand Down