diff --git a/docs/apis/evaluation/dataset.md b/docs/apis/evaluation/dataset.md new file mode 100644 index 0000000..52d3660 --- /dev/null +++ b/docs/apis/evaluation/dataset.md @@ -0,0 +1,3 @@ + +::: t4_devkit.evaluation.dataset + diff --git a/docs/apis/evaluation/index.md b/docs/apis/evaluation/index.md new file mode 100644 index 0000000..429ca69 --- /dev/null +++ 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.md b/docs/apis/evaluation/matching.md similarity index 50% rename from docs/apis/evaluation.md rename to docs/apis/evaluation/matching.md index 66299b6..2d62864 100644 --- a/docs/apis/evaluation.md +++ b/docs/apis/evaluation/matching.md @@ -1,23 +1,9 @@ -# `evaluation` - -## `matching` - ::: 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 - -## `result` - - -::: t4_devkit.evaluation.result.box - -::: t4_devkit.evaluation.result.status - diff --git a/docs/apis/evaluation/metric.md b/docs/apis/evaluation/metric.md new file mode 100644 index 0000000..034a203 --- /dev/null +++ b/docs/apis/evaluation/metric.md @@ -0,0 +1,5 @@ + +::: t4_devkit.evaluation.metric.ap + +::: t4_devkit.evaluation.metric.clear + diff --git a/docs/apis/evaluation/result.md b/docs/apis/evaluation/result.md new file mode 100644 index 0000000..beee5a2 --- /dev/null +++ b/docs/apis/evaluation/result.md @@ -0,0 +1,5 @@ + +::: t4_devkit.evaluation.result.box + +::: t4_devkit.evaluation.result.status + diff --git a/docs/apis/evaluation/task.md b/docs/apis/evaluation/task.md new file mode 100644 index 0000000..da4912f --- /dev/null +++ b/docs/apis/evaluation/task.md @@ -0,0 +1,3 @@ + +::: t4_devkit.evaluation.task + diff --git a/mkdocs.yaml b/mkdocs.yaml index 6ceac12..3ccae23 100644 --- 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