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] Improve documentation folder structure of ExLPose #2977

Merged
merged 1 commit into from
Mar 14, 2024

Conversation

drazicmartin
Copy link
Contributor

@drazicmartin drazicmartin commented Mar 6, 2024

Motivation

Make the documentation more clear and accurate about the ExLPose dataset.

Modification

In the folder structure :

  • Properly indented the folder structure to include all .json files inside the annotations/ExLPose folder.
    • usage example of the dataset here

    ann_file='annotations/ExLPose/ExLPose_test_LL-A.json',

  • Added bright annotations as well as the corresponding image folder
  • Renamed examples elements to match original files names

BC-breaking (Optional)

No

Use cases (Optional)

No

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

@CLAassistant
Copy link

CLAassistant commented Mar 6, 2024

CLA assistant check
All committers have signed the CLA.

@Ben-Louis
Copy link
Collaborator

Hi @drazicmartin, thank you for your contribution! Could you please sign the CLA so that we can proceed with reviewing your PR?

@Ben-Louis Ben-Louis changed the base branch from main to dev-1.x March 6, 2024 17:03
@drazicmartin drazicmartin changed the title [Doc] Improuve documentation folder structure of ExLPose [Doc] Improve documentation folder structure of ExLPose Mar 6, 2024
@Ben-Louis Ben-Louis merged commit c4dfd1e into open-mmlab:dev-1.x Mar 14, 2024
7 checks passed
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.

3 participants