docs: update README (#23)

Signed-off-by: ktro2828 <[email protected]>
tier4 · Oct 23, 2024 · 4bde9e8 · 4bde9e8
1 parent e6dc14d
commit 4bde9e8
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -14,14 +14,14 @@ A toolkit to load and operate T4 dataset.
 
 ### Installation
 
-#### For users
+#### Install via GitHub
 
 ```shell
 # e.g) with poetry
 poetry add git+https://github.com/tier4/t4-devkit.git
 ```
 
-#### For developers
+#### Install from source
 
 ```shell
 git clone [email protected]:tier4/t4-devkit.git
@@ -31,8 +31,30 @@ poetry install
 
 ## Feature supports
 
-|      Feature       | Supported |
-| :----------------: | :-------: |
-| Loading T4 Dataset |    ✅     |
-|   Visualization    |    ✅     |
-|     Evaluation     |           |
+### Visualization
+
+| Feature | Task                    | Support |
+| :------ | :---------------------- | :-----: |
+| 3D      | 3D Boxes                |   ✅    |
+|         | PointCloud Segmentation |         |
+|         | Raw PointCloud          |   ✅    |
+|         | 3D Trajectories         |         |
+|         | TF Links                |   ✅    |
+|         | Vector Map              |         |
+| 2D      | 2D Boxes                |   ✅    |
+|         | Image Segmentation      |   ✅    |
+|         | Raw Image               |   ✅    |
+|         | Raw PointCloud on Image |   ✅    |
+
+### Evaluation
+
+| Feature | Task                    | Support |
+| :------ | :---------------------- | :-----: |
+| 3D      | 3D Detection            |         |
+|         | 3D Tracking             |         |
+|         | 3D Motion Prediction    |         |
+|         | PointCloud Segmentation |         |
+| 2D      | 2D Detection            |         |
+|         | 2D Tracking             |         |
+|         | Image Segmentation      |         |
+|         | Classification          |         |
diff --git a/docs/index.md b/docs/index.md
@@ -8,8 +8,30 @@
 
 ## Feature supports
 
-|      Feature       | Supported |
-| :----------------: | :-------: |
-| Loading T4 Dataset |    ✅     |
-|   Visualization    |    ✅     |
-|     Evaluation     |           |
+### Visualization
+
+| Feature | Task                    | Support |
+| :------ | :---------------------- | :-----: |
+| 3D      | 3D Boxes                |   ✅    |
+|         | PointCloud Segmentation |         |
+|         | Raw PointCloud          |   ✅    |
+|         | 3D Trajectories         |         |
+|         | TF Links                |   ✅    |
+|         | Vector Map              |         |
+| 2D      | 2D Boxes                |   ✅    |
+|         | Image Segmentation      |   ✅    |
+|         | Raw Image               |   ✅    |
+|         | Raw PointCloud on Image |   ✅    |
+
+### Evaluation
+
+| Feature | Task                    | Support |
+| :------ | :---------------------- | :-----: |
+| 3D      | 3D Detection            |         |
+|         | 3D Tracking             |         |
+|         | 3D Motion Prediction    |         |
+|         | PointCloud Segmentation |         |
+| 2D      | 2D Detection            |         |
+|         | 2D Tracking             |         |
+|         | Image Segmentation      |         |
+|         | Classification          |         |