[Docs] Refine the docstring of EvalHook ()

* 📃 docs(hooks): EvalHook comments

Refine the EvalHook comments

* Refine comments EvalHook

Update mmcv/runner/hooks/evaluation.py

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* 📃 docs(Hooks): update Eval Hook

Slove line too long

---------

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
pull/2579/head
Daojiang 2023-01-31 17:31:03 +08:00 committed by GitHub
parent 7e063e3e61
commit 98766f4def
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
mmcv/runner/hooks

View File

@ -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.