Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Doc] Add more detailed comments #2982

Merged
merged 2 commits into from
Mar 13, 2024
Merged

Conversation

Tau-J
Copy link
Collaborator

@Tau-J Tau-J commented Mar 13, 2024

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.

Comment on lines 107 to 113
# ann file is stored at {data_root}/{ann_file}
# e.g. aaa/annotations/xxx.json
ann_file='annotations/xxx.json',
# img is stored at {data_root}/{img}/
# e.g. aaa/train/c.jpg
data_prefix=dict(img='train'),
# specify dataset meta information
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps we can translate these comments into Chinese?

@Tau-J Tau-J merged commit f84ccf7 into open-mmlab:dev-1.x Mar 13, 2024
8 checks passed
@Tau-J Tau-J deleted the fix_docs_train_path branch March 13, 2024 07:22
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants