diff --git a/sphinx/api.rst b/sphinx/api.rst deleted file mode 100644 index b8be643ce..000000000 --- a/sphinx/api.rst +++ /dev/null @@ -1,153 +0,0 @@ -API -=== - -.. currentmodule:: skore - -This page lists all the public functions and classes of the skore package. - -.. warning :: - - This code is still in development. **The API is subject to change.** - -Project -------- - -These functions and classes are meant for managing a Project. - -.. autosummary:: - :toctree: generated/ - :template: base.rst - :caption: Managing a project - - Project - Project.put - Project.get - -Get assistance when developing ML/DS projects ---------------------------------------------- - -These functions and classes enhance scikit-learn's ones. - -.. autosummary:: - :toctree: generated/ - :template: base.rst - :caption: ML Assistance - - train_test_split - -Report for a single estimator -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The class :class:`EstimatorReport` provides a report allowing to inspect and -evaluate a scikit-learn estimator in an interactive way. The functionalities of the -report are accessible through accessors. - -.. autosummary:: - :toctree: generated/ - :template: base.rst - - EstimatorReport - -.. autosummary:: - :toctree: generated/ - :nosignatures: - :template: autosummary/accessor_method.rst - - EstimatorReport.help - -.. autosummary:: - :toctree: generated/ - :nosignatures: - :template: autosummary/accessor.rst - - EstimatorReport.metrics - -Metrics -""""""" - -The `metrics` accessor helps you to evaluate the statistical performance of your -estimator. - -.. autosummary:: - :toctree: generated/ - :nosignatures: - :template: autosummary/accessor_method.rst - - EstimatorReport.metrics.help - EstimatorReport.metrics.report_metrics - EstimatorReport.metrics.custom_metric - EstimatorReport.metrics.accuracy - EstimatorReport.metrics.brier_score - EstimatorReport.metrics.log_loss - EstimatorReport.metrics.precision - EstimatorReport.metrics.precision_recall - EstimatorReport.metrics.prediction_error - EstimatorReport.metrics.r2 - EstimatorReport.metrics.recall - EstimatorReport.metrics.rmse - EstimatorReport.metrics.roc - EstimatorReport.metrics.roc_auc - - -Cross-validation report for an estimator -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The class :class:`CrossValidationReport` provides a report allowing to inspect and -evaluate a scikit-learn estimator through cross-validation in an interactive way. The -functionalities of the report are accessible through accessors. - -.. autosummary:: - :toctree: generated/ - :template: base.rst - - CrossValidationReport - -.. autosummary:: - :toctree: generated/ - :nosignatures: - :template: autosummary/accessor_method.rst - - CrossValidationReport.help - -.. autosummary:: - :toctree: generated/ - :nosignatures: - :template: autosummary/accessor.rst - - CrossValidationReport.metrics - -Metrics -""""""" - -The `metrics` accessor helps you to evaluate the statistical performance of your -estimator during a cross-validation. - -.. autosummary:: - :toctree: generated/ - :nosignatures: - :template: autosummary/accessor_method.rst - - CrossValidationReport.metrics.help - CrossValidationReport.metrics.report_metrics - CrossValidationReport.metrics.custom_metric - CrossValidationReport.metrics.accuracy - CrossValidationReport.metrics.brier_score - CrossValidationReport.metrics.log_loss - CrossValidationReport.metrics.precision - CrossValidationReport.metrics.precision_recall - CrossValidationReport.metrics.prediction_error - CrossValidationReport.metrics.r2 - CrossValidationReport.metrics.recall - CrossValidationReport.metrics.rmse - CrossValidationReport.metrics.roc - CrossValidationReport.metrics.roc_auc - -.. Deprecated -.. ---------- - -.. These functions and classes are deprecated. - -.. .. autosummary:: -.. :toctree: generated/ -.. :template: base.rst -.. :caption: Deprecated \ No newline at end of file diff --git a/sphinx/conf.py b/sphinx/conf.py index c3f5b557b..a1bdf1a5b 100644 --- a/sphinx/conf.py +++ b/sphinx/conf.py @@ -94,7 +94,7 @@ def reset_mpl(gallery_conf, fname): # The module you locally document uses None "skore": None, }, - "backreferences_dir": "generated", + "backreferences_dir": "reference/api", "doc_module": "skore", "reset_modules": (reset_mpl, "seaborn"), "abort_on_example_error": True, diff --git a/sphinx/index.rst b/sphinx/index.rst index 61a5c8dfc..d03e14fa0 100644 --- a/sphinx/index.rst +++ b/sphinx/index.rst @@ -58,5 +58,5 @@ Skore is just at the beginning of its journey, but we’re shipping fast! Freque install auto_examples/index - api + reference/index contributing_link \ No newline at end of file diff --git a/sphinx/reference/index.rst b/sphinx/reference/index.rst new file mode 100644 index 000000000..2fdb11946 --- /dev/null +++ b/sphinx/reference/index.rst @@ -0,0 +1,15 @@ +API +=== + +This page lists all the public functions and classes of the skore package. + +.. warning :: + + This code is still in development. **The API is subject to change.** + +.. currentmodule:: skore + +.. toctree:: + :maxdepth: 2 + + report diff --git a/sphinx/reference/report.rst b/sphinx/reference/report.rst new file mode 100644 index 000000000..80c06d596 --- /dev/null +++ b/sphinx/reference/report.rst @@ -0,0 +1,18 @@ +Report +====== + +.. currentmodule:: skore + +This section contains documentation for different types of reports available in skore. + +Single Estimator Report +----------------------- + +The :doc:`report/estimator_report` provides comprehensive reporting capabilities for individual +scikit-learn estimators, including metrics, visualizations, and evaluation tools. + +.. toctree:: + :maxdepth: 2 + :hidden: + + report/estimator_report diff --git a/sphinx/reference/report/estimator_report.rst b/sphinx/reference/report/estimator_report.rst new file mode 100644 index 000000000..27e402bd4 --- /dev/null +++ b/sphinx/reference/report/estimator_report.rst @@ -0,0 +1,56 @@ +Report for a single estimator +============================ + +.. currentmodule:: skore + +The class :class:`EstimatorReport` provides a report allowing to inspect and +evaluate a scikit-learn estimator in an interactive way. The functionalities of the +report are accessible through accessors. + +.. autosummary:: + :toctree: ../api/ + :template: base.rst + + EstimatorReport + +.. rubric:: Methods + +.. autosummary:: + :toctree: ../api/ + :template: autosummary/accessor_method.rst + + EstimatorReport.help + +.. rubric:: Metrics + +.. autosummary:: + :toctree: ../api/ + :template: autosummary/accessor.rst + + EstimatorReport.metrics + +Metrics +------- + +The `metrics` accessor helps you to evaluate the statistical performance of your +estimator. + +.. autosummary:: + :toctree: ../api/ + :nosignatures: + :template: autosummary/accessor_method.rst + + EstimatorReport.metrics.help + EstimatorReport.metrics.report_metrics + EstimatorReport.metrics.custom_metric + EstimatorReport.metrics.accuracy + EstimatorReport.metrics.brier_score + EstimatorReport.metrics.log_loss + EstimatorReport.metrics.precision + EstimatorReport.metrics.precision_recall + EstimatorReport.metrics.prediction_error + EstimatorReport.metrics.r2 + EstimatorReport.metrics.recall + EstimatorReport.metrics.rmse + EstimatorReport.metrics.roc + EstimatorReport.metrics.roc_auc