Move evaluation metrics docs under API reference

VectorInstitute · Feb 9, 2024 · 7727e76 · 7727e76
1 parent 0b1e34d
commit 7727e76
Show file tree

Hide file tree

Showing 18 changed files with 33 additions and 78 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -2,9 +2,11 @@ API Reference
 =============
 
 .. toctree::
+   :maxdepth: 1
+   :glob:
 
    reference/api/cyclops.data.rst
    reference/api/cyclops.tasks.rst
-   reference/api/cyclops.evaluate.rst
+   reference/api/index.rst
    reference/api/cyclops.monitor.rst
    reference/api/cyclops.report.rst
diff --git a/docs/source/pages/evaluate/evaluator.rst b/docs/source/pages/evaluate/evaluator.rst
@@ -0,0 +1,10 @@
+.. role:: hidden
+    :class: hidden-section
+
+#########
+Evaluator
+#########
+
+evaluator
+^^^^^^^^^
+.. autofunction:: cyclops.evaluate.evaluator.evaluate
diff --git a/.../evaluate/fairness/fairness_evaluator.rst → ...rce/pages/evaluate/fairness_evaluator.rst b/.../evaluate/fairness/fairness_evaluator.rst → ...rce/pages/evaluate/fairness_evaluator.rst
@@ -1,7 +1,10 @@
+.. role:: hidden
+    :class: hidden-section
+
 ##################
 Fairness Evaluator
 ##################
 
 evaluate_fairness
 ^^^^^^^^^^^^^^^^^^
-.. autofunction:: cyclops.evaluate.fairness.evaluator.evaluate_fairness
+.. autofunction:: cyclops.evaluate.fairness.evaluator.evaluate_fairness
diff --git a/docs/source/pages/evaluate/index.rst b/docs/source/pages/evaluate/index.rst
@@ -2,8 +2,9 @@ Evaluation
 ^^^^^^^^^^
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
     :glob:
 
-    metrics/*
-    fairness/*
+    fairness_evaluator.rst
+    evaluator.rst
+
diff --git a/docs/source/reference/api/cyclops.evaluate.rst b/docs/source/reference/api/cyclops.evaluate.rst
diff --git a/...ource/pages/evaluate/metrics/accuracy.rst → ...ource/reference/api/evaluate/accuracy.rst b/...ource/pages/evaluate/metrics/accuracy.rst → ...ource/reference/api/evaluate/accuracy.rst
diff --git a/docs/source/pages/evaluate/metrics/auroc.rst → docs/source/reference/api/evaluate/auroc.rst b/docs/source/pages/evaluate/metrics/auroc.rst → docs/source/reference/api/evaluate/auroc.rst
diff --git a/...es/evaluate/metrics/average_precision.rst → ...erence/api/evaluate/average_precision.rst b/...es/evaluate/metrics/average_precision.rst → ...erence/api/evaluate/average_precision.rst
diff --git a/...source/pages/evaluate/metrics/f1score.rst → ...source/reference/api/evaluate/f1score.rst b/...source/pages/evaluate/metrics/f1score.rst → ...source/reference/api/evaluate/f1score.rst
diff --git a/.../source/pages/evaluate/metrics/f_beta.rst → .../source/reference/api/evaluate/f_beta.rst b/.../source/pages/evaluate/metrics/f_beta.rst → .../source/reference/api/evaluate/f_beta.rst
diff --git a/...urce/pages/evaluate/metrics/precision.rst → ...urce/reference/api/evaluate/precision.rst b/...urce/pages/evaluate/metrics/precision.rst → ...urce/reference/api/evaluate/precision.rst
diff --git a/...aluate/metrics/precision_recall_curve.rst → ...e/api/evaluate/precision_recall_curve.rst b/...aluate/metrics/precision_recall_curve.rst → ...e/api/evaluate/precision_recall_curve.rst
diff --git a/.../source/pages/evaluate/metrics/recall.rst → .../source/reference/api/evaluate/recall.rst b/.../source/pages/evaluate/metrics/recall.rst → .../source/reference/api/evaluate/recall.rst
diff --git a/docs/source/pages/evaluate/metrics/roc.rst → docs/source/reference/api/evaluate/roc.rst b/docs/source/pages/evaluate/metrics/roc.rst → docs/source/reference/api/evaluate/roc.rst
diff --git a/...ce/pages/evaluate/metrics/sensitivity.rst → ...ce/reference/api/evaluate/sensitivity.rst b/...ce/pages/evaluate/metrics/sensitivity.rst → ...ce/reference/api/evaluate/sensitivity.rst
diff --git a/...ce/pages/evaluate/metrics/specificity.rst → ...ce/reference/api/evaluate/specificity.rst b/...ce/pages/evaluate/metrics/specificity.rst → ...ce/reference/api/evaluate/specificity.rst
diff --git a/...ce/pages/evaluate/metrics/stat_scores.rst → ...ce/reference/api/evaluate/stat_scores.rst b/...ce/pages/evaluate/metrics/stat_scores.rst → ...ce/reference/api/evaluate/stat_scores.rst
diff --git a/docs/source/reference/api/index.rst b/docs/source/reference/api/index.rst
@@ -0,0 +1,12 @@
+.. role:: hidden
+    :class: hidden-section
+
+
+Evaluation Metrics
+==================
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    evaluate/*