CalibratedClassifierCV (original) (raw)

class sklearn.calibration.CalibratedClassifierCV(estimator=None, *, method='sigmoid', cv=None, n_jobs=None, ensemble='auto')[source]#

Probability calibration with isotonic regression or logistic regression.

This class uses cross-validation to both estimate the parameters of a classifier and subsequently calibrate a classifier. With defaultensemble=True, for each cv split it fits a copy of the base estimator to the training subset, and calibrates it using the testing subset. For prediction, predicted probabilities are averaged across these individual calibrated classifiers. Whenensemble=False, cross-validation is used to obtain unbiased predictions, via cross_val_predict, which are then used for calibration. For prediction, the base estimator, trained using all the data, is used. This is the prediction method implemented whenprobabilities=True for SVC and NuSVCestimators (see User Guide for details).

Already fitted classifiers can be calibrated by wrapping the model in aFrozenEstimator. In this case all provided data is used for calibration. The user has to take care manually that data for model fitting and calibration are disjoint.

The calibration is based on the decision_function method of theestimator if it exists, else on predict_proba.

Read more in the User Guide. In order to learn more on the CalibratedClassifierCV class, see the following calibration examples:Probability calibration of classifiers,Probability Calibration curves, andProbability Calibration for 3-class classification.

Parameters:

estimatorestimator instance, default=None

The classifier whose output need to be calibrated to provide more accurate predict_proba outputs. The default classifier is a LinearSVC.

Added in version 1.2.

method{‘sigmoid’, ‘isotonic’}, default=’sigmoid’

The method to use for calibration. Can be ‘sigmoid’ which corresponds to Platt’s method (i.e. a logistic regression model) or ‘isotonic’ which is a non-parametric approach. It is not advised to use isotonic calibration with too few calibration samples(<<1000) since it tends to overfit.

cvint, cross-validation generator, or iterable, default=None

Determines the cross-validation splitting strategy. Possible inputs for cv are:

For integer/None inputs, if y is binary or multiclass,StratifiedKFold is used. If y is neither binary nor multiclass, KFoldis used.

Refer to the User Guide for the various cross-validation strategies that can be used here.

Changed in version 0.22: cv default value if None changed from 3-fold to 5-fold.

Changed in version 1.6: "prefit" is deprecated. Use FrozenEstimatorinstead.

n_jobsint, default=None

Number of jobs to run in parallel.None means 1 unless in a joblib.parallel_backend context.-1 means using all processors.

Base estimator clones are fitted in parallel across cross-validation iterations. Therefore parallelism happens only when cv != "prefit".

See Glossary for more details.

Added in version 0.24.

ensemblebool, or “auto”, default=”auto”

Determines how the calibrator is fitted.

“auto” will use False if the estimator is aFrozenEstimator, and True otherwise.

If True, the estimator is fitted using training data, and calibrated using testing data, for each cv fold. The final estimator is an ensemble of n_cv fitted classifier and calibrator pairs, wheren_cv is the number of cross-validation folds. The output is the average predicted probabilities of all pairs.

If False, cv is used to compute unbiased predictions, viacross_val_predict, which are then used for calibration. At prediction time, the classifier used is theestimator trained on all the data. Note that this method is also internally implemented insklearn.svm estimators with the probabilities=True parameter.

Added in version 0.24.

Changed in version 1.6: "auto" option is added and is the default.

Attributes:

**classes_**ndarray of shape (n_classes,)

The class labels.

**n_features_in_**int

Number of features seen during fit. Only defined if the underlying estimator exposes such an attribute when fit.

Added in version 0.24.

**feature_names_in_**ndarray of shape (n_features_in_,)

Names of features seen during fit. Only defined if the underlying estimator exposes such an attribute when fit.

Added in version 1.0.

**calibrated_classifiers_**list (len() equal to cv or 1 if ensemble=False)

The list of classifier and calibrator pairs.

Changed in version 0.24: Single calibrated classifier case when ensemble=False.

See also

calibration_curve

Compute true and predicted probabilities for a calibration curve.

References

[1]

Obtaining calibrated probability estimates from decision trees and naive Bayesian classifiers, B. Zadrozny & C. Elkan, ICML 2001

[2]

Transforming Classifier Scores into Accurate Multiclass Probability Estimates, B. Zadrozny & C. Elkan, (KDD 2002)

[3]

Probabilistic Outputs for Support Vector Machines and Comparisons to Regularized Likelihood Methods, J. Platt, (1999)

[4]

Predicting Good Probabilities with Supervised Learning, A. Niculescu-Mizil & R. Caruana, ICML 2005

Examples

from sklearn.datasets import make_classification from sklearn.naive_bayes import GaussianNB from sklearn.calibration import CalibratedClassifierCV X, y = make_classification(n_samples=100, n_features=2, ... n_redundant=0, random_state=42) base_clf = GaussianNB() calibrated_clf = CalibratedClassifierCV(base_clf, cv=3) calibrated_clf.fit(X, y) CalibratedClassifierCV(...) len(calibrated_clf.calibrated_classifiers_) 3 calibrated_clf.predict_proba(X)[:5, :] array([[0.110..., 0.889...], [0.072..., 0.927...], [0.928..., 0.071...], [0.928..., 0.071...], [0.071..., 0.928...]]) from sklearn.model_selection import train_test_split X, y = make_classification(n_samples=100, n_features=2, ... n_redundant=0, random_state=42) X_train, X_calib, y_train, y_calib = train_test_split( ... X, y, random_state=42 ... ) base_clf = GaussianNB() base_clf.fit(X_train, y_train) GaussianNB() from sklearn.frozen import FrozenEstimator calibrated_clf = CalibratedClassifierCV(FrozenEstimator(base_clf)) calibrated_clf.fit(X_calib, y_calib) CalibratedClassifierCV(...) len(calibrated_clf.calibrated_classifiers_) 1 calibrated_clf.predict_proba([[-0.5, 0.5]]) array([[0.936..., 0.063...]])

fit(X, y, sample_weight=None, **fit_params)[source]#

Fit the calibrated model.

Parameters:

Xarray-like of shape (n_samples, n_features)

Training data.

yarray-like of shape (n_samples,)

Target values.

sample_weightarray-like of shape (n_samples,), default=None

Sample weights. If None, then samples are equally weighted.

**fit_paramsdict

Parameters to pass to the fit method of the underlying classifier.

Returns:

selfobject

Returns an instance of self.

get_metadata_routing()[source]#

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:

routingMetadataRouter

A MetadataRouter encapsulating routing information.

get_params(deep=True)[source]#

Get parameters for this estimator.

Parameters:

deepbool, default=True

If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

paramsdict

Parameter names mapped to their values.

predict(X)[source]#

Predict the target of new samples.

The predicted class is the class that has the highest probability, and can thus be different from the prediction of the uncalibrated classifier.

Parameters:

Xarray-like of shape (n_samples, n_features)

The samples, as accepted by estimator.predict.

Returns:

Cndarray of shape (n_samples,)

The predicted class.

predict_proba(X)[source]#

Calibrated probabilities of classification.

This function returns calibrated probabilities of classification according to each class on an array of test vectors X.

Parameters:

Xarray-like of shape (n_samples, n_features)

The samples, as accepted by estimator.predict_proba.

Returns:

Cndarray of shape (n_samples, n_classes)

The predicted probas.

score(X, y, sample_weight=None)[source]#

Return the mean accuracy on the given test data and labels.

In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that each label set be correctly predicted.

Parameters:

Xarray-like of shape (n_samples, n_features)

Test samples.

yarray-like of shape (n_samples,) or (n_samples, n_outputs)

True labels for X.

sample_weightarray-like of shape (n_samples,), default=None

Sample weights.

Returns:

scorefloat

Mean accuracy of self.predict(X) w.r.t. y.

set_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → CalibratedClassifierCV[source]#

Request metadata passed to the fit method.

Note that this method is only relevant ifenable_metadata_routing=True (see sklearn.set_config). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside aPipeline. Otherwise it has no effect.

Parameters:

sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for sample_weight parameter in fit.

Returns:

selfobject

The updated object.

set_params(**params)[source]#

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**paramsdict

Estimator parameters.

Returns:

selfestimator instance

Estimator instance.

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → CalibratedClassifierCV[source]#

Request metadata passed to the score method.

Note that this method is only relevant ifenable_metadata_routing=True (see sklearn.set_config). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside aPipeline. Otherwise it has no effect.

Parameters:

sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for sample_weight parameter in score.

Returns:

selfobject

The updated object.