docs: update document for evaluation APIs (#151)

ktro2828 · web-flow · commit d0618b7bce8f · 2025-05-16T02:45:59.000+09:00
Signed-off-by: ktro2828 &lt;kotaro.uetake@tier4.jp&gt;
diff --git a/docs/apis/evaluation/dataset.md b/docs/apis/evaluation/dataset.md
@@ -0,0 +1,3 @@
+<!-- prettier-ignore-start -->
+::: t4_devkit.evaluation.dataset
+<!-- prettier-ignore-end -->
diff --git a/docs/apis/evaluation/index.md b/docs/apis/evaluation/index.md
@@ -0,0 +1,7 @@
+# `evaluation`
+
+- [Evaluation Tasks](./task.md)
+- [Load Dataset](./dataset.md)
+- [Matching Boxes](./matching.md)
+- [Matching Results](./result.md)
+- [Metrics](./metric.md)
diff --git a/docs/apis/evaluation/matching.md b/docs/apis/evaluation/matching.md
@@ -1,23 +1,9 @@
-# `evaluation`
-
-## `matching`
-
 <!-- prettier-ignore-start -->
 ::: t4_devkit.evaluation.matching.parameter
 
-::: t4_devkit.evaluation.matching.context
-
 ::: t4_devkit.evaluation.matching.scorer
 
 ::: t4_devkit.evaluation.matching.policy
 
 ::: t4_devkit.evaluation.matching.algorithm
 <!-- prettier-ignore-end -->
-
-## `result`
-
-<!-- prettier-ignore-start -->
-::: t4_devkit.evaluation.result.box
-
-::: t4_devkit.evaluation.result.status
-<!-- prettier-ignore-end -->
diff --git a/docs/apis/evaluation/metric.md b/docs/apis/evaluation/metric.md
@@ -0,0 +1,5 @@
+<!-- prettier-ignore-start -->
+::: t4_devkit.evaluation.metric.ap
+
+::: t4_devkit.evaluation.metric.clear
+<!-- prettier-ignore-end -->
diff --git a/docs/apis/evaluation/result.md b/docs/apis/evaluation/result.md
@@ -0,0 +1,5 @@
+<!-- prettier-ignore-start -->
+::: t4_devkit.evaluation.result.box
+
+::: t4_devkit.evaluation.result.status
+<!-- prettier-ignore-end -->
diff --git a/docs/apis/evaluation/task.md b/docs/apis/evaluation/task.md
@@ -0,0 +1,3 @@
+<!-- prettier-ignore-start -->
+::: t4_devkit.evaluation.task
+<!-- prettier-ignore-end -->
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -23,7 +23,13 @@ nav:
           - Serialize Schema: apis/schema/serialize.md
       - t4_devkit.dataclass: apis/dataclass.md
       - t4_devkit.filtering: apis/filtering.md
-      - t4_devkit.evaluation: apis/evaluation.md
+      - t4_devkit.evaluation:
+          - Home: apis/evaluation/index.md
+          - Evaluation Tasks: apis/evaluation/task.md
+          - Load Dataset: apis/evaluation/dataset.md
+          - Matching Boxes: apis/evaluation/matching.md
+          - Matching Results: apis/evaluation/result.md
+          - Metrics: apis/evaluation/metric.md
       - t4_devkit.viewer: apis/viewer.md
       - t4_devkit.common: apis/common.md
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<!-- prettier-ignore-start -->`
	`2`	`+::: t4_devkit.evaluation.dataset`
	`3`	`+<!-- prettier-ignore-end -->`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<!-- prettier-ignore-start -->`
	`2`	`+::: t4_devkit.evaluation.task`
	`3`	`+<!-- prettier-ignore-end -->`