| cv | Determines the cross-validation splitting strategy
Possible inputs for cv are:
- None, to use the default 3-fold cross validation,
- integer, to specify the number of folds in a `(Stratified)KFold`,
- :term:`CV splitter`,
- An iterable yielding (train, test) splits as arrays of indices
For integer/None inputs, if the estimator is a classifier and ``y`` is
either binary or multiclass, :class:`StratifiedKFold` is used. In all
other cases, :class:`KFold` is used
Refer :ref:`User Guide ` for the various
cross-validation strategies that can be used here
.. versionchanged:: 0.20
``cv`` default value if None will change from 3-fold to 5-fold
in v0.22 | default: "warn" |
| error_score | 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. This parameter does not affect the refit
step, which will always raise the error. Default is 'raise' but from
version 0.22 it will change to np.nan | default: "raise-deprecating" |
| estimator | A object of that type is instantiated for each grid point
This is assumed to implement the scikit-learn estimator interface
Either estimator needs to provide a ``score`` function,
or ``scoring`` must be passed | default: {"oml-python:serialized_object": "component_reference", "value": {"key": "estimator", "step_name": null}} |
| iid | If True, return the average score across folds, weighted by the number
of samples in each test set. In this case, the data is assumed to be
identically distributed across the folds, and the loss minimized is
the total loss per sample, and not the mean loss across the folds. If
False, return the average score across folds. Default is True, but
will change to False in version 0.22, to correspond to the standard
definition of cross-validation
.. versionchanged:: 0.20
Parameter ``iid`` will change from True to False by default in
version 0.22, and will be removed in 0.24 | default: "warn" |
| n_iter | Number of parameter settings that are sampled. n_iter trades
off runtime vs quality of the solution | default: 10 |
| n_jobs | Number of jobs to run in parallel
``None`` means 1 unless in a :obj:`joblib.parallel_backend` context
``-1`` means using all processors. See :term:`Glossary `
for more details | default: null |
| param_distributions | Dictionary with parameters names (string) as keys and distributions
or lists of parameters to try. Distributions must provide a ``rvs``
method for sampling (such as those from scipy.stats.distributions)
If a list is given, it is sampled uniformly | default: {"columntransformer__numeric__imputer__strategy": ["mean", "median", "most_frequent"], "decisiontreeclassifier__criterion": ["gini", "entropy"], "decisiontreeclassifier__max_features": [1.0], "decisiontreeclassifier__min_impurity_decrease": [0.0], "decisiontreeclassifier__min_samples_leaf": {"oml-python:serialized_object": "rv_frozen", "value": {"dist": "scipy.stats._discrete_distns.randint_gen", "a": 0, "b": Infinity, "args": [1, 21], "kwds": {}}}, "decisiontreeclassifier__min_samples_split": {"oml-python:serialized_object": "rv_frozen", "value": {"dist": "scipy.stats._discrete_distns.randint_gen", "a": 0, "b": Infinity, "args": [2, 21], "kwds": {}}}, "decisiontreeclassifier__min_weight_fraction_leaf": [0.0]} |
| pre_dispatch | 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:
- None, in which case all the jobs are immediately
created and spawned. Use this for lightweight and
fast-running jobs, to avoid delays due to on-demand
spawning of the jobs
- An int, giving the exact number of total jobs that are
spawned
- A string, giving an expression as a function of n_jobs,
as in '2*n_jobs' | default: "2*n_jobs" |
| random_state | Pseudo random number generator state used for random uniform sampling
from lists of possible values instead of scipy.stats distributions
If int, random_state is the seed used by the random number generator;
If RandomState instance, random_state is the random number generator;
If None, the random number generator is the RandomState instance used
by `np.random` | default: 0 |
| refit | Refit an estimator using the best found parameters on the whole
dataset
For multiple metric evaluation, this needs to be a string denoting the
scorer that would be used to find the best parameters for refitting
the estimator at the end
Where there are considerations other than maximum score in
choosing a best estimator, ``refit`` can be set to a function which
returns the selected ``best_index_`` given the ``cv_results``
The refitted estimator is made available at the ``best_estimator_``
attribute and permits using ``predict`` directly on this
``RandomizedSearchCV`` instance
Also for multiple metric evaluation, the attributes ``best_index_``,
``best_score_`` and ``best_params_`` will only be available if
``refit`` is set and all of them will be determined w.r.t this specific
scorer. When refit is callable, ``best_score_`` is disabled
See ``scoring`` parameter to know more about multiple metric
evaluation
.. versionchanged:: 0.20
... | default: true |
| return_train_score | If ``False``, the ``cv_results_`` attribute will not include training
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. | default: false |
| scoring | A single string (see :ref:`scoring_parameter`) or a callable
(see :ref:`scoring`) to evaluate the predictions on the test set
For evaluating multiple metrics, either give a list of (unique) strings
or a dict with names as keys and callables as values
NOTE that when using custom scorers, each scorer should return a single
value. Metric functions returning a list/array of values can be wrapped
into multiple scorers that return one value each
See :ref:`multimetric_grid_search` for an example
If None, the estimator's score method is used | default: null |
| verbose | Controls the verbosity: the higher, the more messages | default: 0 |