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 docstring and documentation used for hub.get_model #659

Merged
merged 3 commits into from
Nov 2, 2022

Conversation

zengyh1900
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

MMdetection has renamed some configs https://github.com/open-mmlab/mmdetection/tree/3.x/configs
The docstring and documentation used in mmengine.hub.get_model should be updated.

Modification

'faster_rcnn' -> 'faster-rcnn'

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.

zhouzaida
zhouzaida previously approved these changes Nov 1, 2022
@codecov
Copy link

codecov bot commented Nov 1, 2022

Codecov Report

Base: 78.40% // Head: 78.40% // No change to project coverage 👍

Coverage data is based on head (05b20d1) compared to base (3aba989).
Patch has no changes to coverable lines.

❗ Current head 05b20d1 differs from pull request most recent head 0f798b0. Consider uploading reports for the commit 0f798b0 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #659   +/-   ##
=======================================
  Coverage   78.40%   78.40%           
=======================================
  Files         127      127           
  Lines        9175     9175           
  Branches     1826     1826           
=======================================
  Hits         7194     7194           
  Misses       1670     1670           
  Partials      311      311           
Flag Coverage Δ
unittests 78.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mmengine/config/utils.py 58.49% <ø> (ø)
mmengine/hub/hub.py 25.71% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@zhouzaida zhouzaida merged commit 618a063 into main Nov 2, 2022
@zhouzaida zhouzaida deleted the fix-config-docs branch November 2, 2022 02:17
ly015 pushed a commit to ly015/mmengine that referenced this pull request Nov 9, 2022
…mlab#659)

* fix docstring and documentation used for hub.get_model

* fix config name in test_hub

* fix docstring mentioned faster-rcnn in utils
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.

[Bug] FileNotFoundError when using mmengine.hub.get_model
3 participants