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: class_with_accessors.rst

   EstimatorReport

.. rubric:: Methods

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

   EstimatorReport.help
   EstimatorReport.cache_predictions
   EstimatorReport.clear_cache
   EstimatorReport.get_predictions

.. rubric:: Accessors

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

   EstimatorReport.data
   EstimatorReport.inspection
   EstimatorReport.metrics

.. _estimator_data:

Data
----

The `data` accessor helps you to get insights about the dataset used to train and test
your estimator.

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

    EstimatorReport.data.help
    EstimatorReport.data.analyze

.. _estimator_metrics:

Metrics
-------

The `metrics` accessor helps you to evaluate the statistical performance of your
estimator.

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

    EstimatorReport.metrics.help
    EstimatorReport.metrics.summarize

    EstimatorReport.metrics.accuracy
    EstimatorReport.metrics.brier_score
    EstimatorReport.metrics.confusion_matrix
    EstimatorReport.metrics.custom_metric
    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
    EstimatorReport.metrics.timings

Inspection
----------

The `inspection` accessor helps you inspect your model by e.g. evaluating the importance
of the features in your model.

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

    EstimatorReport.inspection.help
    EstimatorReport.inspection.coefficients
    EstimatorReport.inspection.impurity_decrease
    EstimatorReport.inspection.permutation_importance