Report for a cross-validation of an estimator
=============================================

.. currentmodule:: skore

The class :class:`CrossValidationReport` performs cross-validation and provides a report
to inspect and evaluate a scikit-learn estimator in an interactive way. The
functionalities of the report are exposed through accessors.

.. autosummary::
   :toctree: ../api/
   :template: base.rst

   CrossValidationReport

.. rubric:: Methods

.. autosummary::
   :toctree: ../api/
   :template: autosummary/accessor_method.rst

   CrossValidationReport.help

.. rubric:: Metrics

.. autosummary::
   :toctree: ../api/
   :template: autosummary/accessor.rst

   CrossValidationReport.metrics

Metrics
-------

The `metrics` accessor helps you to evaluate the statistical performance of your
estimator across cross-validation folds.

.. autosummary::
    :toctree: ../api/
    :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