Evaluate metric(s) by cross-validation and also record fit/score times.
Read more in the User Guide.
The object to use to fit the data.
The data to fit. Can be for example a list, or an array.
The target variable to try to predict in the case of supervised learning.
Group labels for the samples used while splitting the dataset into train/test set. Only used in conjunction with a “Group” cv instance (e.g., GroupKFold
).
Changed in version 1.4: groups
can only be passed if metadata routing is not enabled via sklearn.set_config(enable_metadata_routing=True)
. When routing is enabled, pass groups
alongside other metadata via the params
argument instead. E.g.: cross_validate(..., params={'groups': groups})
.
Strategy to evaluate the performance of the estimator
across cross-validation splits.
If scoring
represents a single score, one can use:
a single string (see String name scorers);
a callable (see Callable scorers) that returns a single value.
None
, the estimator
’s default evaluation criterion is used.
If scoring
represents multiple scores, one can use:
a list or tuple of unique strings;
a callable returning a dictionary where the keys are the metric names and the values are the metric scores;
a dictionary with metric names as keys and callables a values.
See Specifying multiple metrics for evaluation for an example.
Determines the cross-validation splitting strategy. Possible inputs for cv are:
None, to use the default 5-fold cross validation,
int, to specify the number of folds in a (Stratified)KFold
,
An iterable yielding (train, test) splits as arrays of indices.
For int/None inputs, if the estimator is a classifier and y
is either binary or multiclass, StratifiedKFold
is used. In all other cases, KFold
is used. These splitters are instantiated with shuffle=False
so the splits will be the same across calls.
Refer 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.
Number of jobs to run in parallel. Training the estimator and computing the score are parallelized over the cross-validation splits. None
means 1 unless in a joblib.parallel_backend
context. -1
means using all processors. See Glossary for more details.
The verbosity level.
Parameters to pass to the underlying estimator’s fit
, the scorer, and the CV splitter.
Added in version 1.4.
Controls the number of jobs that get dispatched during parallel execution. Reducing this number can be useful to avoid an explosion of memory consumption when more jobs get dispatched than CPUs can process. This parameter can be:
An int, giving the exact number of total jobs that are spawned
A str, giving an expression as a function of n_jobs, as in ‘2*n_jobs’
Whether to include train scores. Computing training scores is used to get insights on how different parameter settings impact the overfitting/underfitting trade-off. However computing the scores on the training set can be computationally expensive and is not strictly required to select the parameters that yield the best generalization performance.
Added in version 0.19.
Changed in version 0.21: Default value was changed from True
to False
Whether to return the estimators fitted on each split.
Added in version 0.20.
Whether to return the train-test indices selected for each split.
Added in version 1.3.
Value to assign to the score if an error occurs in estimator fitting. If set to ‘raise’, the error is raised. If a numeric value is given, FitFailedWarning is raised.
Added in version 0.20.
Array of scores of the estimator for each run of the cross validation.
A dict of arrays containing the score/time arrays for each scorer is returned. The possible keys for this dict
are:
test_score
The score array for test scores on each cv split. Suffix _score
in test_score
changes to a specific metric like test_r2
or test_auc
if there are multiple scoring metrics in the scoring parameter.
train_score
The score array for train scores on each cv split. Suffix _score
in train_score
changes to a specific metric like train_r2
or train_auc
if there are multiple scoring metrics in the scoring parameter. This is available only if return_train_score
parameter is True
.
fit_time
The time for fitting the estimator on the train set for each cv split.
score_time
The time for scoring the estimator on the test set for each cv split. (Note: time for scoring on the train set is not included even if return_train_score
is set to True
).
estimator
The estimator objects for each cv split. This is available only if return_estimator
parameter is set to True
.
indices
The train/test positional indices for each cv split. A dictionary is returned where the keys are either "train"
or "test"
and the associated values are a list of integer-dtyped NumPy arrays with the indices. Available only if return_indices=True
.
Examples
>>> from sklearn import datasets, linear_model >>> from sklearn.model_selection import cross_validate >>> from sklearn.metrics import make_scorer >>> from sklearn.metrics import confusion_matrix >>> from sklearn.svm import LinearSVC >>> diabetes = datasets.load_diabetes() >>> X = diabetes.data[:150] >>> y = diabetes.target[:150] >>> lasso = linear_model.Lasso()
Single metric evaluation using cross_validate
>>> cv_results = cross_validate(lasso, X, y, cv=3) >>> sorted(cv_results.keys()) ['fit_time', 'score_time', 'test_score'] >>> cv_results['test_score'] array([0.3315057 , 0.08022103, 0.03531816])
Multiple metric evaluation using cross_validate
(please refer the scoring
parameter doc for more information)
>>> scores = cross_validate(lasso, X, y, cv=3, ... scoring=('r2', 'neg_mean_squared_error'), ... return_train_score=True) >>> print(scores['test_neg_mean_squared_error']) [-3635.5 -3573.3 -6114.7] >>> print(scores['train_r2']) [0.28009951 0.3908844 0.22784907]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4