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

[Doc] fix api reference #1792

Merged
merged 11 commits into from
Nov 11, 2022
Merged

[Doc] fix api reference #1792

merged 11 commits into from
Nov 11, 2022

Conversation

ly015
Copy link
Member

@ly015 ly015 commented Nov 8, 2022

Motivation

Fix issues in API reference of MMPose docs

Modification

  1. Remove redundant codes of transformer modules that cause unsuccessful doc compiling.
  2. Add webcam API reference
  3. Fix Windows CI

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 Nov 8, 2022

Codecov Report

❗ No coverage uploaded for pull request base (1.x@2489991). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head cbe7194 differs from pull request most recent head b02215c. Consider uploading reports for the commit b02215c to get more accurate results

Additional details and impacted files
@@          Coverage Diff           @@
##             1.x    #1792   +/-   ##
======================================
  Coverage       ?   79.51%           
======================================
  Files          ?      203           
  Lines          ?    11348           
  Branches       ?     1913           
======================================
  Hits           ?     9023           
  Misses         ?     1934           
  Partials       ?      391           
Flag Coverage Δ
unittests 79.51% <0.00%> (?)

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

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.

@ly015 ly015 changed the title [Doc] fix api reference of mmpose.evaluation [Doc] fix api reference Nov 11, 2022
@ly015 ly015 merged commit c6de39c into open-mmlab:1.x Nov 11, 2022
@ly015 ly015 deleted the fix-api-refs branch November 11, 2022 09:40
ly015 added a commit to jack0rich/mmpose that referenced this pull request Feb 13, 2023
Ben-Louis pushed a commit to Ben-Louis/mmpose that referenced this pull request Feb 13, 2023
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