Skip to content

Conversation

@Yan-Daojiang
Copy link

Refine the EvalHook comments

Motivation

I noticed that according to the implementation of EvalHook, its parameter start can also work in iteration mode. However, only the epoch mode was stated in the original comment, so I improved the comment.

Modification

Improve the comments for EvalHook.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

Refine the EvalHook comments
@CLAassistant
Copy link

CLAassistant commented Jan 31, 2023

CLA assistant check
All committers have signed the CLA.

Yan-Daojiang and others added 2 commits January 31, 2023 15:12
Update mmcv/runner/hooks/evaluation.py

Co-authored-by: Zaida Zhou <[email protected]>
@zhouzaida zhouzaida changed the title 📃 docs(hooks): EvalHook comments [Docs] Refine the docstring of EvalHook Jan 31, 2023
@zhouzaida zhouzaida merged commit 98766f4 into open-mmlab:master Jan 31, 2023
CokeDong pushed a commit to CokeDong/mmcv that referenced this pull request Apr 24, 2023
* 📃 docs(hooks): EvalHook comments

Refine the EvalHook comments

* Refine comments EvalHook

Update mmcv/runner/hooks/evaluation.py

Co-authored-by: Zaida Zhou <[email protected]>

* 📃 docs(Hooks): update Eval Hook

Slove line too long

---------

Co-authored-by: Zaida Zhou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants