-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[Doc] Fix docstring warnings #1084
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-0.22 #1084 +/- ##
===========================================
Coverage ? 82.42%
===========================================
Files ? 202
Lines ? 16032
Branches ? 2860
===========================================
Hits ? 13215
Misses ? 2095
Partials ? 722
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ly015
approved these changes
Dec 22, 2021
ly015
approved these changes
Dec 22, 2021
ly015
pushed a commit
that referenced
this pull request
Jan 4, 2022
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
ly015
pushed a commit
that referenced
this pull request
Jan 5, 2022
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
shuheilocale
pushed a commit
to shuheilocale/mmpose
that referenced
this pull request
May 6, 2023
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
ajgrafton
pushed a commit
to ajgrafton/mmpose
that referenced
this pull request
Mar 6, 2024
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Fix most of the docstring warnings. Make mmpose.api look good in the doc.
Check https://mmpose--1084.org.readthedocs.build/en/1084/api.html
Modification
For example:
The example below does not look good.
Please consider modifying it as follows. (1) Remove the variable name (2) change () -> []
torch.Tensor[NxCxHxW] --> torch.Tensor[N,C,H,W]
BC-breaking (Optional)
Use cases (Optional)
Checklist
Before PR:
After PR: