"vscode:/vscode.git/clone" did not exist on "cef4a512238c5f1cd88c4890e344d64459f92bac"
Unverified Commit 98766f4d authored by Daojiang's avatar Daojiang Committed by GitHub
Browse files

[Docs] Refine the docstring of EvalHook (#2576)

* 📃

 docs(hooks): EvalHook comments

Refine the EvalHook comments

* Refine comments EvalHook

Update mmcv/runner/hooks/evaluation.py
Co-authored-by: default avatarZaida Zhou <58739961+zhouzaida@users.noreply.github.com>

* 📃

 docs(Hooks): update Eval Hook

Slove line too long

---------
Co-authored-by: default avatarZaida Zhou <58739961+zhouzaida@users.noreply.github.com>
parent 7e063e3e
...@@ -23,10 +23,10 @@ class EvalHook(Hook): ...@@ -23,10 +23,10 @@ class EvalHook(Hook):
Args: Args:
dataloader (DataLoader): A PyTorch dataloader, whose dataset has dataloader (DataLoader): A PyTorch dataloader, whose dataset has
implemented ``evaluate`` function. implemented ``evaluate`` function.
start (int | None, optional): Evaluation starting epoch. It enables start (int | None, optional): Evaluation starting epoch or iteration.
evaluation before the training starts if ``start`` <= the resuming It enables evaluation before the training starts if ``start`` <=
epoch. If None, whether to evaluate is merely decided by the resuming epoch or iteration. If None, whether to evaluate is
``interval``. Default: None. merely decided by ``interval``. Default: None.
interval (int): Evaluation interval. Default: 1. interval (int): Evaluation interval. Default: 1.
by_epoch (bool): Determine perform evaluation by epoch or by iteration. by_epoch (bool): Determine perform evaluation by epoch or by iteration.
If set to True, it will perform by epoch. Otherwise, by iteration. If set to True, it will perform by epoch. Otherwise, by iteration.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment