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] Refine docs #1656

Merged
merged 31 commits into from
Sep 26, 2022
Merged

[Docs] Refine docs #1656

merged 31 commits into from
Sep 26, 2022

Conversation

Tau-J
Copy link
Collaborator

@Tau-J Tau-J commented Sep 14, 2022

Motivation

Modification

BC-breaking (Optional)

Use cases (Optional)

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 tests to ensure correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • CLA has been signed and all committers have signed the CLA in this PR.

@codecov
Copy link

codecov bot commented Sep 14, 2022

Codecov Report

Base: 78.69% // Head: 77.78% // Decreases project coverage by -0.91% ⚠️

Coverage data is based on head (29dff81) compared to base (fc7f090).
Patch coverage: 13.46% of modified lines in pull request are covered.

❗ Current head 29dff81 differs from pull request most recent head 0e67d65. Consider uploading reports for the commit 0e67d65 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           dev-1.x    #1656      +/-   ##
===========================================
- Coverage    78.69%   77.78%   -0.92%     
===========================================
  Files          203      204       +1     
  Lines        11575    11712     +137     
  Branches      2022     2050      +28     
===========================================
+ Hits          9109     9110       +1     
- Misses        2072     2206     +134     
- Partials       394      396       +2     
Flag Coverage Δ
unittests 77.78% <13.46%> (-0.92%) ⬇️

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

Impacted Files Coverage Δ
mmpose/models/heads/heatmap_heads/mix_head.py 0.00% <0.00%> (ø)
mmpose/models/heads/regression_heads/dsnt_head.py 86.48% <ø> (ø)
mmpose/models/losses/classification_loss.py 76.71% <ø> (ø)
mmpose/models/losses/loss_wrappers.py 100.00% <ø> (ø)
mmpose/models/heads/heatmap_heads/simcc_head.py 72.97% <45.45%> (-2.27%) ⬇️
mmpose/codecs/simcc_label.py 80.64% <94.11%> (-0.04%) ⬇️
mmpose/codecs/utils/refinement.py 97.05% <0.00%> (-1.48%) ⬇️
mmpose/datasets/transforms/common_transforms.py 83.19% <0.00%> (-0.57%) ⬇️

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.

@@ -17,7 +17,7 @@
dict(
type='MultiStepLR',
begin=0,
end=210,
Copy link
Member

Choose a reason for hiding this comment

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

What about using the default value infinite?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think end=train_cfg['max_epochs'] is more intuitive for users to understand

mmpose/codecs/simcc_label.py Outdated Show resolved Hide resolved
Comment on lines 9 to 14
@InProceedings{10.1007/978-3-030-01231-1_33,
author={Sun, Xiao and Xiao, Bin and Wei, Fangyin and Liang, Shuang and Wei, Yichen},
title={Integral Human Pose Regression},
booktitle="Computer Vision -- ECCV 2018",
year="2018",
pages="536--553",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
@InProceedings{10.1007/978-3-030-01231-1_33,
author={Sun, Xiao and Xiao, Bin and Wei, Fangyin and Liang, Shuang and Wei, Yichen},
title={Integral Human Pose Regression},
booktitle="Computer Vision -- ECCV 2018",
year="2018",
pages="536--553",
@inproceedings{sun2018integral,
title={Integral human pose regression},
author={Sun, Xiao and Xiao, Bin and Wei, Fangyin and Liang, Shuang and Wei, Yichen},
booktitle={Proceedings of the European conference on computer vision (ECCV)},
pages={529--545},
year={2018}
}

Copy link
Member

Choose a reason for hiding this comment

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

And may also need to update the citation in the .md files under configs/

docs/zh_cn/overview.md Outdated Show resolved Hide resolved
@ly015 ly015 merged commit fbc1e34 into open-mmlab:dev-1.x Sep 26, 2022
ly015 pushed a commit that referenced this pull request Oct 14, 2022
ly015 pushed a commit that referenced this pull request Oct 14, 2022
shuheilocale pushed a commit to shuheilocale/mmpose that referenced this pull request May 6, 2023
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