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.

Overview

The following table provides a quick reference to the public classes and functions in skore:

Project Management

Project

Main class for managing a skore project and its reports

ML Assistance

train_test_split()

Split arrays or matrices into random train and test subsets

EstimatorReport	Report for a fitted estimator Accessor methods Data: EstimatorReport.data analyze() Plot dataset statistics Metrics: EstimatorReport.metrics accuracy() Compute the accuracy score brier_score() Compute the Brier score confusion_matrix() Plot the confusion matrix custom_metric() Compute a custom metric log_loss() Compute the log loss precision() Compute the precision score precision_recall() Plot the precision-recall curve prediction_error() Plot the prediction error of a regression model r2() Compute the R² score recall() Compute the recall score rmse() Compute the root mean squared error roc() Plot the ROC curve roc_auc() Compute the ROC AUC score summarize() Report a set of metrics for our estimator timings() Get all measured processing times related to the estimator Inspection: EstimatorReport.inspection coefficients() Retrieve the coefficients of a linear model, including the intercept impurity_decrease() Retrieve the Mean Decrease in Impurity (MDI) of a tree-based model permutation_importance() Report the permutation feature importance
CrossValidationReport	Report for cross-validation results Accessor methods Data: CrossValidationReport.data analyze() Plot dataset statistics Metrics: CrossValidationReport.metrics accuracy() Compute the accuracy score brier_score() Compute the Brier score confusion_matrix() Plot the confusion matrix custom_metric() Compute a custom metric log_loss() Compute the log loss precision() Compute the precision score precision_recall() Plot the precision-recall curve prediction_error() Plot the prediction error of a regression model r2() Compute the R² score recall() Compute the recall score rmse() Compute the root mean squared error roc() Plot the ROC curve roc_auc() Compute the ROC AUC score summarize() Report a set of metrics for our estimator timings() Get all measured processing times related to the estimator Inspection: CrossValidationReport.inspection coefficients() Retrieve the coefficients across splits, including the intercept impurity_decrease() Retrieve the Mean Decrease in Impurity (MDI) across splits
ComparisonReport	Report for comparing reports Accessor methods Metrics: ComparisonReport.metrics accuracy() Compute the accuracy score brier_score() Compute the Brier score confusion_matrix() Plot the confusion matrix custom_metric() Compute a custom metric log_loss() Compute the log loss precision() Compute the precision score precision_recall() Plot the precision-recall curve prediction_error() Plot the prediction error of a regression model r2() Compute the R² score recall() Compute the recall score rmse() Compute the root mean squared error roc() Plot the ROC curve roc_auc() Compute the ROC AUC score summarize() Report a set of metrics for the estimators timings() Get all measured processing times related to the different estimators Inspection: ComparisonReport.inspection coefficients() Retrieve the coefficients for each report, including the intercepts

Display Classes

Data

TableReportDisplay

Display for tabular data reports

Metrics

MetricsSummaryDisplay	Display for summarizing multiple metrics
ConfusionMatrixDisplay	Confusion matrix visualization
RocCurveDisplay	ROC (Receiver Operating Characteristic) curve visualization
PrecisionRecallCurveDisplay	Precision-Recall curve visualization
PredictionErrorDisplay	Prediction error visualization

Inspection

CoefficientsDisplay	Display for visualizing model coefficients
PermutationImportanceDisplay	Display for permutation feature importance

Configuration

config_context()	Context manager for temporarily modifying skore configuration
get_config()	Get current skore configuration values
set_config()	Set skore configuration values

Utilities

show_versions()

Print version information for skore and its dependencies