Parameters:

estimator : estimator object implementing
‘fit’

The object to use to fit the data.

X : array-like

The data to fit. Can be, for example a list, or an
array at least 2d.

y : array-like, optional, default: None

The target variable to try to predict in the case of
supervised learning.

scoring : string, callable or None, optional, default:
None

A string (see model evaluation documentation) or a
scorer callable object / function with signature scorer(estimator, X, y).

cv : int, cross-validation generator or an iterable,
optional

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.
• An object to be used as a cross-validation
  generator.
• An iterable yielding train/test splits.

For integer/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.

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

n_jobs : integer, optional

The number of CPUs to use to do the computation. -1
means ‘all CPUs’.

verbose : integer, optional

The verbosity level.

fit_params : dict, optional

Parameters to pass to the fit method of the
estimator.

pre_dispatch : int, or string, optional

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’

Returns:

scores : array of float,
shape=(len(list(cv)),)

Array of scores of the estimator for each run of the
cross validation.

Parameters:

estimator : estimator object.

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.

param_grid : dict or list of dictionaries

Dictionary with parameters names (string) as keys and
lists of parameter settings to try as values, or a list of such dictionaries,
in which case the grids spanned by each dictionary in the list are explored.
This enables searching over any sequence of parameter settings.

scoring : string, callable or None,
default=None

A string (see model evaluation documentation) or a
scorer callable object / function with signature scorer(estimator, X, y). If None, the score method of the estimator is used.

fit_params : dict, optional

Parameters to pass to the fit method.

n_jobs : int, default=1

Number of jobs to run in parallel.

Changed in version 0.17: Upgraded to joblib 0.9.3.

pre_dispatch : int, or string, optional

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’

iid : boolean, default=True

If True, 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.

cv : int, cross-validation generator or an iterable,
optional

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.
• An object to be used as a cross-validation
  generator.
• An iterable yielding train/test splits.

For integer/None inputs, if the estimator is a
classifier and y is either binary or
multiclass, sklearn.model_selection.StratifiedKFold is used. In all other
cases, sklearn.model_selection.KFold is used.

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

refit : boolean, default=True

Refit the best estimator with the entire dataset. If
“False”, it is impossible to make predictions using this GridSearchCV instance
after fitting.

verbose : integer

Controls the verbosity: the higher, the more
messages.

error_score : ‘raise’ (default) or numeric

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.

Attributes:

grid_scores_ : list of named tuples

Contains scores for all parameter combinations in
param_grid. Each entry corresponds to one parameter setting. Each named tuple
has the attributes:

·         parameters, a dict of parameter settings

·         mean_validation_score,
the mean score over the cross-validation folds

·         cv_validation_scores,
the list of scores for each fold

best_estimator_ :
estimator

Estimator that was chosen by the search, i.e.
estimator which gave highest score (or smallest loss if specified) on the left
out data. Not available if refit=False.

best_score_ : float

Score of best_estimator on the left out
data.

best_params_ : dict

Parameter setting that gave the best results on the
hold out data.

scorer_ : function

Scorer function used on the held out data to choose
the best parameters for the model.

Parameters:

X : array-like, shape = [n_samples,
n_features]

Training vector, where n_samples is the number of
samples and n_features is the number of features.

y : array-like, shape = [n_samples] or [n_samples,
n_output], optional

Target relative to X for classification or regression;
None for unsupervised learning.

Parameters:

Cs : list of floats | int

Each of the values in Cs describes the inverse of
regularization strength. If Cs is as an int, then a grid of Cs values are
chosen in a logarithmic scale between 1e-4 and 1e4. Like in support vector
machines, smaller values specify stronger regularization.

fit_intercept :
bool, default: True

Specifies if a constant (a.k.a. bias or intercept)
should be added to the decision function.

class_weight : dict or ‘balanced’, optional

Weights associated with classes in the
form {class_label: weight}.
If not given, all classes are supposed to have weight one.

The “balanced” mode uses the values of y to
automatically adjust weights inversely proportional to class frequencies in the
input data as n_samples / (n_classes * np.bincount(y)).

Note that these weights will be multiplied with
sample_weight (passed through the fit method) if sample_weight is
specified.

New in version 0.17: class_weight
== ‘balanced’

cv : integer or cross-validation
generator

The default cross-validation generator used is
Stratified K-Folds. If an integer is provided, then it is the number of folds
used. See the module sklearn.model_selection module
for the list of possible cross-validation objects.

penalty : str, ‘l1’ or ‘l2’

Used to specify the norm used in the penalization. The
‘newton-cg’, ‘sag’ and ‘lbfgs’ solvers support only l2 penalties.

dual : bool

Dual or primal formulation. Dual formulation is only
implemented for l2 penalty with liblinear solver. Prefer dual=False when
n_samples > n_features.

scoring : callabale

Scoring function to use as cross-validation criteria.
For a list of scoring functions that can be used, look at sklearn.metrics.
The default scoring option used is accuracy_score.

solver : {‘newton-cg’, ‘lbfgs’, ‘liblinear’,
‘sag’}

Algorithm to use in the optimization
problem.

• For small datasets, ‘liblinear’ is a good
  choice, whereas ‘sag’ is

faster for large ones.

• For multiclass problems, only ‘newton-cg’, ‘sag’
  and ‘lbfgs’ handle

multinomial loss; ‘liblinear’ is limited to
one-versus-rest schemes.

• ‘newton-cg’, ‘lbfgs’ and ‘sag’ only handle L2
  penalty.
• ‘liblinear’ might be slower in
  LogisticRegressionCV because it does

not handle warm-starting.

Note that ‘sag’ fast convergence is only guaranteed on
features with approximately the same scale. You can preprocess the data with a
scaler from sklearn.preprocessing.

New in version 0.17: Stochastic
Average Gradient descent solver.

tol : float, optional

Tolerance for stopping criteria.

max_iter : int, optional

Maximum number of iterations of the optimization
algorithm.

n_jobs : int, optional

Number of CPU cores used during the cross-validation
loop. If given a value of -1, all cores are used.

verbose : int

For the ‘liblinear’, ‘sag’ and ‘lbfgs’ solvers set
verbose to any positive number for verbosity.

refit : bool

If set to True, the scores are averaged across all
folds, and the coefs and the C that corresponds to the best score is taken, and
a final refit is done using these parameters. Otherwise the coefs, intercepts
and C that correspond to the best scores across folds are averaged.

multi_class : str, {‘ovr’, ‘multinomial’}

Multiclass option can be either ‘ovr’ or ‘multinomial’.
If the option chosen is ‘ovr’, then a binary problem is fit for each label.
Else the loss minimised is the multinomial loss fit across the entire
probability distribution. Works only for the ‘newton-cg’, ‘sag’ and ‘lbfgs’
solver.

New in version 0.18: Stochastic
Average Gradient descent solver for ‘multinomial’ case.

intercept_scaling :
float, default 1.

Useful only when the solver ‘liblinear’ is used and
self.fit_intercept is set to True. In this case, x becomes [x,
self.intercept_scaling], i.e. a “synthetic” feature with constant value equal
to intercept_scaling is appended to the instance vector. The intercept
becomes intercept_scaling * synthetic_feature_weight.

Note! the synthetic feature weight is subject to l1/l2
regularization as all other features. To lessen the effect of regularization on
synthetic feature weight (and therefore on the intercept) intercept_scaling has
to be increased.

random_state : int seed, RandomState instance, or None
(default)

The seed of the pseudo random number generator to use
when shuffling the data.

Attributes:

coef_ : array, shape (1, n_features) or (n_classes,
n_features)

Coefficient of the features in the decision
function.

coef_ is of shape (1, n_features) when the given
problem is binary. coef_ is readonly property derived
from raw_coef_ that follows the internal memory layout of
liblinear.

intercept_ : array, shape (1,) or (n_classes,)

Intercept (a.k.a. bias) added to the decision
function. It is available only when parameter intercept is set to True and is
of shape(1,) when the problem is binary.

Cs_ : array

Array of C i.e. inverse of regularization parameter
values used for cross-validation.

coefs_paths_ : array, shape (n_folds, len(Cs_), n_features) or (n_folds, len(Cs_), n_features + 1)

dict with classes as the keys, and the path of
coefficients obtained during cross-validating across each fold and then across
each Cs after doing an OvR for the corresponding class as values. If the
‘multi_class’ option is set to ‘multinomial’, then the coefs_paths are the
coefficients corresponding to each class. Each dict value has
shape (n_folds, len(Cs_), n_features) or (n_folds, len(Cs_), n_features + 1) depending on whether the intercept is fit or
not.

scores_ : dict

dict with classes as the keys, and the values as the
grid of scores obtained during cross-validating each fold, after doing an OvR
for the corresponding class. If the ‘multi_class’ option given is ‘multinomial’
then the same scores are repeated across all classes, since this is the
multinomial class. Each dict value has shape (n_folds, len(Cs))

C_ : array, shape (n_classes,) or (n_classes -
1,)

Array of C that maps to the best scores across every
class. If refit is set to False, then for each class, the best C is the average
of the C’s that correspond to the best scores for each fold.

n_iter_ : array, shape (n_classes, n_folds, n_cs) or (1,
n_folds, n_cs)

Actual number of iterations for all classes, folds and
Cs. In the binary or multinomial cases, the first dimension is equal to
1.