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] Fix the docstring of model sub-package #573

Merged
merged 1 commit into from
Oct 8, 2022

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

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
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

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@ZwwWayne ZwwWayne added this to the 0.2.0 milestone Oct 8, 2022
@ZwwWayne ZwwWayne merged commit a5eb179 into open-mmlab:main Oct 8, 2022
@zhouzaida zhouzaida deleted the fix-docstring branch October 8, 2022 03:23
austinmw pushed a commit to austinmw/mmengine that referenced this pull request Oct 8, 2022
ZwwWayne pushed a commit that referenced this pull request Oct 8, 2022
* Add smddp dist backend option

* [Dev]: Upgrade pre commit hooks (#576)

* Upgrade the versions of pre-commit-hooks

* update zh-cn.yaml

* [Docs] Fix the docstring of model sub-package (#573)

* [Doc]: Update config.md (#562)

* Update config.md

* Update config.md

* [Doc] delete the error comment  in docs (#514)

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Zhengfei-0311 <78833899+Zhengfei-0311@users.noreply.github.com>
Co-authored-by: vansin <msnode@163.com>
C1rN09 pushed a commit to C1rN09/mmengine that referenced this pull request Nov 1, 2022
* Add smddp dist backend option

* [Dev]: Upgrade pre commit hooks (open-mmlab#576)

* Upgrade the versions of pre-commit-hooks

* update zh-cn.yaml

* [Docs] Fix the docstring of model sub-package (open-mmlab#573)

* [Doc]: Update config.md (open-mmlab#562)

* Update config.md

* Update config.md

* [Doc] delete the error comment  in docs (open-mmlab#514)

Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com>
Co-authored-by: Zhengfei-0311 <78833899+Zhengfei-0311@users.noreply.github.com>
Co-authored-by: vansin <msnode@163.com>
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.

2 participants