-
Notifications
You must be signed in to change notification settings - Fork 15
chore(docs): update document #96
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: scepter914 <[email protected]>
There was a problem hiding this 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/ |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
Signed-off-by: scepter914 <[email protected]>
Signed-off-by: scepter914 <[email protected]>
Signed-off-by: scepter914 <[email protected]>
Summary
Update document according to #95.
Change point
Add document for
/data
and/work_dirs
.Note
None
Test performed
None