-
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
Conversation
Codecov Report
@@ 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. Continue to review full report at Codecov.
|
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
* fix doc patch1 * fix docstring * fix docstring * fix dataset * fix dataset * fix docstring * resolve warnings * fix multilines
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: