diff --git a/docs/source/api.rst b/docs/source/api.rst index caf347cc6..9db92ee49 100644 --- 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 new file mode 100644 index 000000000..9aab49732 --- /dev/null +++ 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/docs/source/pages/evaluate/fairness/fairness_evaluator.rst b/docs/source/pages/evaluate/fairness_evaluator.rst similarity index 78% rename from docs/source/pages/evaluate/fairness/fairness_evaluator.rst rename to docs/source/pages/evaluate/fairness_evaluator.rst index 626295fdd..8d67c0a94 100644 --- a/docs/source/pages/evaluate/fairness/fairness_evaluator.rst +++ b/docs/source/pages/evaluate/fairness_evaluator.rst @@ -1,3 +1,6 @@ +.. role:: hidden + :class: hidden-section + ################## Fairness Evaluator ################## diff --git a/docs/source/pages/evaluate/index.rst b/docs/source/pages/evaluate/index.rst index aa92d8986..070292c72 100644 --- a/docs/source/pages/evaluate/index.rst +++ b/docs/source/pages/evaluate/index.rst @@ -2,8 +2,8 @@ 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 deleted file mode 100644 index db916df82..000000000 --- a/docs/source/reference/api/cyclops.evaluate.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. role:: hidden - :class: hidden-section - - -cyclops.evaluate -================ - -.. automodule:: cyclops.evaluate - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - :template: custom-module-template.rst - - evaluator - - -cyclops.evaluate.metrics ------------------------- - -.. automodule:: cyclops.evaluate.metrics - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - :template: custom-module-template.rst - - metric - factory - accuracy - auroc - precision_recall - precision_recall_curve - roc - sensitivity - specificity - f_beta - stat_scores - - -cyclops.evaluate.metrics.functional ------------------------------------ - -.. automodule:: cyclops.evaluate.metrics.functional - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - :template: custom-module-template.rst - - accuracy - auroc - precision_recall - precision_recall_curve - roc - sensitivity - specificity - f_beta - stat_scores - - -cyclops.evaluate.fairness --------------------------- - -.. automodule:: cyclops.evaluate.fairness - -.. autosummary:: - :toctree: _autosummary - :nosignatures: - :template: custom-module-template.rst - - evaluator - config diff --git a/docs/source/pages/evaluate/metrics/accuracy.rst b/docs/source/reference/api/evaluate/accuracy.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/accuracy.rst rename to docs/source/reference/api/evaluate/accuracy.rst diff --git a/docs/source/pages/evaluate/metrics/auroc.rst b/docs/source/reference/api/evaluate/auroc.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/auroc.rst rename to docs/source/reference/api/evaluate/auroc.rst diff --git a/docs/source/pages/evaluate/metrics/average_precision.rst b/docs/source/reference/api/evaluate/average_precision.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/average_precision.rst rename to docs/source/reference/api/evaluate/average_precision.rst diff --git a/docs/source/pages/evaluate/metrics/f1score.rst b/docs/source/reference/api/evaluate/f1score.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/f1score.rst rename to docs/source/reference/api/evaluate/f1score.rst diff --git a/docs/source/pages/evaluate/metrics/f_beta.rst b/docs/source/reference/api/evaluate/f_beta.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/f_beta.rst rename to docs/source/reference/api/evaluate/f_beta.rst diff --git a/docs/source/pages/evaluate/metrics/precision.rst b/docs/source/reference/api/evaluate/precision.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/precision.rst rename to docs/source/reference/api/evaluate/precision.rst diff --git a/docs/source/pages/evaluate/metrics/precision_recall_curve.rst b/docs/source/reference/api/evaluate/precision_recall_curve.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/precision_recall_curve.rst rename to docs/source/reference/api/evaluate/precision_recall_curve.rst diff --git a/docs/source/pages/evaluate/metrics/recall.rst b/docs/source/reference/api/evaluate/recall.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/recall.rst rename to docs/source/reference/api/evaluate/recall.rst diff --git a/docs/source/pages/evaluate/metrics/roc.rst b/docs/source/reference/api/evaluate/roc.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/roc.rst rename to docs/source/reference/api/evaluate/roc.rst diff --git a/docs/source/pages/evaluate/metrics/sensitivity.rst b/docs/source/reference/api/evaluate/sensitivity.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/sensitivity.rst rename to docs/source/reference/api/evaluate/sensitivity.rst diff --git a/docs/source/pages/evaluate/metrics/specificity.rst b/docs/source/reference/api/evaluate/specificity.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/specificity.rst rename to docs/source/reference/api/evaluate/specificity.rst diff --git a/docs/source/pages/evaluate/metrics/stat_scores.rst b/docs/source/reference/api/evaluate/stat_scores.rst similarity index 100% rename from docs/source/pages/evaluate/metrics/stat_scores.rst rename to docs/source/reference/api/evaluate/stat_scores.rst diff --git a/docs/source/reference/api/index.rst b/docs/source/reference/api/index.rst new file mode 100644 index 000000000..0bdd4ddfa --- /dev/null +++ b/docs/source/reference/api/index.rst @@ -0,0 +1,12 @@ +.. role:: hidden + :class: hidden-section + + +Evaluation Metrics +================== + +.. toctree:: + :maxdepth: 1 + :glob: + + evaluate/*