Skip to content

Conversation

scepter914
Copy link
Collaborator

Summary

Update document according to #95.

Change point

  • chore(docs): update document

Add document for /data and /work_dirs.

Note

None

Test performed

None

Copy link
Collaborator

@KSeangTan KSeangTan left a comment

Choose a reason for hiding this comment

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

LGTM overall

Each tool has `README.md` for developers.
The target of `README.md` is a developer of `AWML`.

### data/
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we really data? I suppose we should avoid adding any artifacts/data, unless we are using them for some unit tests

Copy link
Collaborator Author

@scepter914 scepter914 Sep 12, 2025

Choose a reason for hiding this comment

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

Sorry for misleading documents.
I mean data/ directory is gitignored and is intended for datasets and other training-related data.
Therefore, please do not add tool-specific .gitignore files under data/, as in https://github.com/tier4/AWML/pull/82.”

Using data/ in this way is consistent with the official usage (e.g., https://mmdetection3d.readthedocs.io/en/latest/advanced_guides/datasets/nuscenes.html).
However, I thought it would be good to formally declare where data should be placed, so I added this clarification.

Would the following wording work?

The `data/` directory is gitignored and manages the input files to use for `AWML` including datasets and info files.
This way to use come from the usage of `mmdetection3d` as https://mmdetection3d.readthedocs.io/en/latest/advanced_guides/datasets/nuscenes.html.
Please change the directory name accordingly.

Copy link
Collaborator

Choose a reason for hiding this comment

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

LGTM overall, let's rephrase it a little

`data/` directory is gitignored, and it refers to inputs for `AWML`, for example, datasets and info files.
The design follows `mmdetection3d` as recommended in  https://mmdetection3d.readthedocs.io/en/latest/advanced_guides/datasets/nuscenes.html. Please change the directory name for different use cases accordingly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you for reviewing.
Fixed at 4bc4097

@KSeangTan KSeangTan added the documentation Improvements or additions to documentation label Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants