Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

chore(docs): update document #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0f4da04
chore(docs): update document
scepter914 Sep 8, 2025
60d7944
fix documents
scepter914 Sep 12, 2025
467ce16
update documents
scepter914 Sep 12, 2025
2bd5c2b
Merge branch 'main' into chore/contribution_docs
scepter914 Sep 12, 2025
0b18cc9
Merge branch 'main' into chore/contribution_docs
scepter914 Sep 17, 2025
2130c3f
Merge branch 'main' into chore/contribution_docs
scepter914 Sep 17, 2025
4bc4097
fix document
scepter914 Sep 17, 2025
20fa518
Merge branch 'main' into chore/contribution_docs
scepter914 Sep 19, 2025
f662137
Merge branch 'main' into chore/contribution_docs
scepter914 Sep 20, 2025
773efd5
Merge branch 'main' into chore/contribution_docs
scepter914 Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/contribution/contribution_flow/contribution_flow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
## 1. Report issue

If you want to add/fix some code, please make the issue at first.
You should comment and show the issue and show what you want to fix before implementation.
Please comment and show any issues that need to be fixed before creating a PR.

## 2. Implementation

You should fork from autoware-ml to own repository and make new branch.
Please check [AWML design document](/docs/design/autoware_ml_design.md) before implementation.

## 3. Formatting

Expand Down Expand Up @@ -53,18 +54,18 @@ The target of document is as below.
- `/docs/*`: Design documents for developers

Design documents aims for developers.
So you should write "why we should do" for documents.
So please comment and show "why we should do" for documents.

- `/tools/*`: Process documents for engineer users

Process documents aims for engineer users.
So you should write "how we should do" for documents assuming that users know basic command linux around machine learning.
So please comment and show "how we should do" for documents assuming that users know basic command linux around machine learning.
You can assume the user can fix the bug in the tools on their own.

- `/pipelines/*`: Process documents for non-engineer users

Process documents aims for non-engineer users.
So you should write "how we should do" for documents assuming that users do not know basic linux command.
So please comment and show "how we should do" for documents assuming that users do not know basic linux command.

## 5. Test by CI/CD

Expand Down
11 changes: 10 additions & 1 deletion docs/design/autoware_ml_design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,6 @@ The directory of `tools/` manages the tools for each tasks.
`tools/` scripts are abstracted. For example, `tools/detection3d` can be used for any 3D detection models such as TransFusion and BEVFusion.
This directory can depend on `/autoware_ml` and other `/tools`.


```
- tools/
- detection3d/
Expand All @@ -208,6 +207,16 @@ This directory can depend on `/autoware_ml` and other `/tools`.
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 •
edited
Loading

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


`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.

### work_dirs/

The directory manages any artifacts and files generated from `AWML`, for example, training/evaluation/visualization.
Please change the directory name accordingly.

## Support priority

We define "support priority" for each tools and projects. Maintainers handle handle the issues according to the priority as below.
Expand Down