diff --git a/docs/contribution/contribution_flow/contribution_flow.md b/docs/contribution/contribution_flow/contribution_flow.md index acc7d36b..1de2a7b2 100644 --- a/docs/contribution/contribution_flow/contribution_flow.md +++ b/docs/contribution/contribution_flow/contribution_flow.md @@ -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 @@ -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 diff --git a/docs/design/autoware_ml_design.md b/docs/design/autoware_ml_design.md index 8ac8b091..fcc7c178 100644 --- a/docs/design/autoware_ml_design.md +++ b/docs/design/autoware_ml_design.md @@ -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/ @@ -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/ + +`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.