From 280cb78b858e5fe23baf20b49c5d7bcb275c0c5a Mon Sep 17 00:00:00 2001 From: ktro2828 Date: Fri, 14 Nov 2025 18:00:34 +0900 Subject: [PATCH] docs: update readme Signed-off-by: ktro2828 --- README.md | 12 +++++++++++- docs/index.md | 10 ++++++++++ mkdocs.yaml | 2 +- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ca8659..b4656de 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# T4 devkit +# t4-devkit A toolkit to load and operate T4 dataset. @@ -52,6 +52,10 @@ source .venv/bin/activate ### Visualization +`t4-devkit` provides a set of visualization tools to help you understand the data. + +More details, please refer to [`t4viz` CLI](./docs/cli/t4viz.md) or [API usage](./docs/tutorials/render.md). + | Feature | Task | Support | | :------ | :-------------------------- | :-----: | | 3D | 3D Boxes | ✅ | @@ -65,3 +69,9 @@ source .venv/bin/activate | | Raw PointCloud on Image | ✅ | | Map | Vector Map | ✅ | | | Ego Position on Street View | ✅ | + +### Sanity Checks + +`t4-devkit` provides a set of sanity checks to ensure the correctness of the data. + +More details, please refer to [`t4sanity` CLI](./docs/cli/t4sanity.md) or [API usage](./docs/tutorials/sanity.md). diff --git a/docs/index.md b/docs/index.md index 5818990..aacbba6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,6 +10,10 @@ ### Visualization +`t4-devkit` provides a set of visualization tools to help you understand the data. + +More details, please refer to [`t4viz` CLI](./cli/t4viz.md) or [API usage](./tutorials/render.md). + | Feature | Task | Support | | :------ | :-------------------------- | :-----: | | 3D | 3D Boxes | ✅ | @@ -23,3 +27,9 @@ | | Raw PointCloud on Image | ✅ | | Map | Vector Map | ✅ | | | Ego Position on Street View | ✅ | + +### Sanity Checks + +`t4-devkit` provides a set of sanity checks to ensure the correctness of the data. + +More details, please refer to [`t4sanity` CLI](./cli/t4sanity.md) or [API usage](./tutorials/sanity.md). diff --git a/mkdocs.yaml b/mkdocs.yaml index 0c3b126..d0c39ae 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,4 +1,4 @@ -site_name: T4 dataset devkit +site_name: t4-devkit repo_url: https://github.com/tier4/t4-devkit repo_name: tier4/t4-devkit