Skip to content
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.

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

[Docs] Add the documentation of Hook #1606

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

zhouzaida
Copy link
Collaborator

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Add the documentation of Hook.

Modification

  • Add docs/zh_cn/understand_mmcv/hook.md

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

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.

docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
事实上,只要你喜欢,你可以同时使用的所有 LoggerHook。

```{note}
MMCV 目前提供的 LoggerHook 功能有限,只用于记录标量数据,例如 loss、acc 等,暂不支持可视化图像或特征图等。欢迎提 PR 完善 LoggerHook。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a little problem with the rendering of loss、acc.

docs/zh_cn/understand_mmcv/hook.md Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved
docs/zh_cn/understand_mmcv/hook.md Outdated Show resolved Hide resolved

##### 梯度累积

可用于显存不足的情况下训练训练更大的 batch size,更多细节可参考 https://github.com/open-mmlab/mmcv/pull/1221。
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could be better if the URL can be accessed.

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.

5 participants