chore(docs): add design docs (#16)

Signed-off-by: scepter914 <[email protected]>

Author: scepter914

README.md

@@ -5,6 +5,8 @@ This repository is ML library for Autoware.
 ## Docs
 
 - [Get started](docs/get_started.md)
+- [Design docs](docs/design.md)
+- [Release note](docs/release_note.md)
 
 ## Supported environment
 

docs/design.md

@@ -0,0 +1,75 @@
+# Design
+## Software architecture
+### Data Pipeline
+
+TBD
+
+### Architecture
+
+The architecture of Autoware-ML is based on [mmdetection3d v1.4](https://github.com/open-mmlab/mmdetection3d/tree/v1.4.0).
+
+- /docs
+
+Documents for Autoware-ML.
+
+- /configs
+
+Base configs for datase and train parameters.
+
+- /tools
+
+Tools script like dataset converter.
+
+- /autoware_ml
+
+The core library.
+
+- /projects
+
+The projects directory.
+This directory has each model projects.
+
+## Contribute
+### Add a new model
+
+If you want to add a new model, you should add codes to `/projects/{model_name}`.
+If you want to add a project to improve model performance like some training and data pipeline for pseudo label, you should also add codes to `/projects/{model_name}`.
+
+For PR review list with code owner for Autoware-ML
+- [ ] Add `/projects/{model_name}/README.md`
+- [ ] Performing test for new model
+- [ ] Update [release note](/docs/release_note.md)
+
+### Add/Fix functions to use for many projects
+
+If you want to add/fix functions to use for many projects, you should commit to `autoware_ml/*`.
+
+For PR review list with code owner for Autoware-ML
+- [ ] Performing test for function
+- [ ] Check/Add/Update/ unit test
+
+### Add/Fix tools
+
+If you want to add/fix tools to use for many projects, you should commit to `tools/*`.
+
+For PR review list with code owner for Autoware-ML
+- [ ] Performing test for function
+- [ ] Check/Add/Update/ unit test
+
+### Fix code in a project.
+
+You can fix code in a project more casually than fixing codes with `autoware_ml`.
+
+For PR review list with code owner for the project
+- [ ] Performing test with the model
+- [ ] Update [release note](/docs/release_note.md)
+
+### Add/Fix config file in a project
+
+If you want to add/fix config file in a project, you should add/fix `projects/{model_name}/configs/{dataset_name}/*.py`.
+
+For PR review list with code owner for the project
+- [ ] Performing test with the model
+- [ ] Update `projects/{model_name}/README.md` adding evaluation result for new config.
+- [ ] Delete unused config file
+- [ ] Update [release note](/docs/release_note.md)

docs/release_note.md

@@ -1,9 +1,28 @@
 ## For next release
+### New feature
 
-- Add BEVFusion model (#1, #2, #12)
-- Update docs (#3, #4, #5, #6, #7, #8, #10, #11, #13)
-- Add dataset converter (#9)
-- Add train code for 2D (#14)
+- Add BEVFusion model
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/1
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/2
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/12
+- Add dataset converter
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/9
+- Add train code for 2D
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/14
+
+### Chore
+
+- Update docs
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/3
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/4
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/5
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/6
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/7
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/8
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/10
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/11
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/13
+  - https://github.com/tier4/mmdetection3d_bevfusion/pull/16
 
 ## v0.1.0