Logistic Regression (aka logit, MaxEnt) classifier.

In the multiclass case, the training algorithm uses the one-vs-rest (OvR) scheme if the ‘multi_class’ option is set to ‘ovr’, and uses the cross-entropy loss if the ‘multi_class’ option is set to ‘multinomial’. (Currently the ‘multinomial’ option is supported only by the ‘lbfgs’, ‘sag’, ‘saga’ and ‘newton-cg’ solvers.)

This class implements regularized logistic regression using the ‘liblinear’ library, ‘newton-cg’, ‘sag’, ‘saga’ and ‘lbfgs’ solvers. **Note that regularization is applied by default**. It can handle both dense and sparse input. Use C-ordered arrays or CSR matrices containing 64-bit floats for optimal performance; any other input format will be converted (and copied).

The ‘newton-cg’, ‘sag’, and ‘lbfgs’ solvers support only L2 regularization with primal formulation, or no regularization. The ‘liblinear’ solver supports both L1 and L2 regularization, with a dual formulation only for the L2 penalty. The Elastic-Net regularization is only supported by the ‘saga’ solver.

Parameters:penalty : str, ‘l1’, ‘l2’, ‘elasticnet’ or ‘none’, optional (default=’l2’)Used to specify the norm used in the penalization. The ‘newton-cg’, ‘sag’ and ‘lbfgs’ solvers support only l2 penalties. ‘elasticnet’ is only supported by the ‘saga’ solver. If ‘none’ (not supported by the liblinear solver), no regularization is applied. New in version 0.19: l1 penalty with SAGA solver (allowing ‘multinomial’ + L dual : bool, optional (default=False)Dual or primal formulation. Dual formulation is only implemented for l2 penalty with liblinear solver. Prefer dual=False when n_samples > n_features. tol : float, optional (default=1e-4)Tolerance for stopping criteria. C : float, optional (default=1.0)Inverse of regularization strength; must be a positive float. Like in support vector machines, smaller values specify stronger regularization fit_intercept : bool, optional (default=True)Specifies if a constant (a.k.a. bias or intercept) should be added to the decision function. intercept_scaling : float, optional (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. class_weight : dict or ‘balanced’, optional (default=None)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’ random_state : int, RandomState instance or None, optional (default=None)The seed of the pseudo random number generator to use when shuffling the data. 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` . Used when `solver` == ‘sag’ or ‘liblinear’. solver : str, {‘newton-cg’, ‘lbfgs’, ‘liblinear’, ‘sag’, ‘saga’}, optional (default=’liblinear’).Algorithm to use in the optimization problem. For small datasets, ‘liblinear’ is a good choice, whereas ‘sag’ and ‘saga’ are faster for large ones. For multiclass problems, only ‘newton-cg’, ‘sag’, ‘saga’ and ‘lbfgs’ handle multinomial loss; ‘liblinear’ is limited to one-versus-rest schemes. ‘newton-cg’, ‘lbfgs’, ‘sag’ and ‘saga’ handle L2 or no penalty ‘liblinear’ and ‘saga’ also handle L1 penalty ‘saga’ also supports ‘elasticnet’ penalty ‘liblinear’ does not handle no penalty Note that ‘sag’ and ‘saga’ 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.New in version 0.19: SAGA solver.Changed in version 0.20: Default will change from ‘liblinear’ to ‘lbfgs’ in 0.22. max_iter : int, optional (default=100)Maximum number of iterations taken for the solvers to converge. multi_class : str, {‘ovr’, ‘multinomial’, ‘auto’}, optional (default=’ovr’)If the option chosen is ‘ovr’, then a binary problem is fit for each label. For ‘multinomial’ the loss minimised is the multinomial loss fit across the entire probability distribution, even when the data is binary. ‘multinomial’ is unavailable when solver=’liblinear’. ‘auto’ selects ‘ovr’ if the data is binary, or if solver=’liblinear’, and otherwise selects ‘multinomial’. New in version 0.18: Stochastic Average Gradient descent solver for ‘multinomial’ case. Changed in version 0.20: Default will change from ‘ovr’ to ‘auto’ in 0.22. verbose : int, optional (default=0)For the liblinear and lbfgs solvers set verbose to any positive number for verbosity. warm_start : bool, optional (default=False)When set to True, reuse the solution of the previous call to fit as initialization, otherwise, just erase the previous solution. Useless for liblinear solver. See the Glossary. New in version 0.17: warm_start to support lbfgs, newton-cg, sag, saga solvers. n_jobs : int or None, optional (default=None)Number of CPU cores used when parallelizing over classes if multi_class=’ovr’”. This parameter is ignored when the `solver` is set to ‘liblinear’ regardless of whether ‘multi_class’ is specified or not. `None` means 1 unless in a `joblib.parallel_backend` context. `-1` means using all processors. See Glossary for more details. l1_ratio : float or None, optional (default=None)The Elastic-Net mixing parameter, with `0 <= l1_ratio <= 1` . Only used if `penalty='elasticnet'`. Setting ``l1_ratio=0` is equivalent to using `penalty='l2'` , while setting `l1_ratio=1` is equivalent to using `penalty='l1'` . For `0 < l1_ratio <1` , the penalty is a combination of L1 and L2. |

Attributes:classes_ : array, shape (n_classes, )A list of class labels known to the classifier. 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. In particular, when `multi_class='multinomial'` , coef_ corresponds to outcome 1 (True) and `-coef_` corresponds to outcome 0 (False). intercept_ : array, shape (1,) or (n_classes,)Intercept (a.k.a. bias) added to the decision function. If `fit_intercept` is set to False, the intercept is set to zero. `intercept_` is of shape (1,) when the given problem is binary. In particular, when `multi_class='multinomial'` , `intercept_` corresponds to outcome 1 (True) and `-intercept_` corresponds to outcome 0 (False). n_iter_ : array, shape (n_classes,) or (1, )Actual number of iterations for all classes. If binary or multinomial, it returns only 1 element. For liblinear solver, only the maximum number of iteration across all classes is given. Changed in version 0.20: In SciPy <= 1.0.0 the number of lbfgs iterations may exceed `max_iter` . `n_iter_` will now report at most `max_iter` . |

**Notes**: The underlying C implementation uses a random number generator to select features when fitting the model. It is thus not uncommon, to have slightly different results for the same input data. If that happens, try with a smaller tol parameter.

Predict output may not match that of standalone liblinear in certain cases. See differences from liblinear in the narrative documentation.

**References**

**LIBLINEAR **– A Library for Large Linear Classificationhttps://www.csie.ntu.edu.tw/~cjlin/liblinear/

**SAG **– Mark Schmidt, Nicolas Le Roux, and Francis BachMinimizing Finite Sums with the Stochastic Average Gradient https://hal.inria.fr/hal-00860051/document

**SAGA** – Defazio, A., Bach F. & Lacoste-Julien S. (2014).

SAGA: A Fast Incremental Gradient Method With Support for Non-Strongly Convex Composite Objectives https://arxiv.org/abs/1407.0202

**Hsiang-Fu Yu, Fang-Lan Huang, Chih-Jen Lin (2011). Dual coordinate descent** methods for logistic regression and maximum entropy models. Machine Learning 85(1-2):41-75. https://www.csie.ntu.edu.tw/~cjlin/papers/maxent_dual.pdf

**Examples**>>>

>>>fromsklearn.datasetsimportload_iris>>>fromsklearn.linear_modelimportLogisticRegression>>>X, y = load_iris(return_X_y=True)>>>clf = LogisticRegression(random_state=0, solver='lbfgs',...multi_class='multinomial').fit(X, y)>>>clf.predict(X[:2, :]) array([0, 0])>>>clf.predict_proba(X[:2, :]) array([[9.8...e-01, 1.8...e-02, 1.4...e-08], [9.7...e-01, 2.8...e-02, ...e-08]])>>>clf.score(X, y) 0.97...

**Methods**

`decision_function` (self, X) | Predict confidence scores for samples. |

`densify` (self) | Convert coefficient matrix to dense array format. |

`fit` (self, X, y[, sample_weight]) | Fit the model according to the given training data. |

`get_params` (self[, deep]) | Get parameters for this estimator. |

`predict` (self, X) | Predict class labels for samples in X. |

`predict_log_proba` (self, X) | Log of probability estimates. |

`predict_proba` (self, X) | Probability estimates. |

`score` (self, X, y[, sample_weight]) | Returns the mean accuracy on the given test data and labels. |

`set_params` (self, \*\*params) | Set the parameters of this estimator. |

`sparsify` (self) | Convert coefficient matrix to sparse format. |

`__init__`

(*self*, *penalty=’l2’*, *dual=False*, *tol=0.0001*, *C=1.0*, *fit_intercept=True*, *intercept_scaling=1*, *class_weight=None*, *random_state=None*, *solver=’warn’*, *max_iter=100*, *multi_class=’warn’*, *verbose=0*, *warm_start=False*, *n_jobs=None*, *l1_ratio=None*)[source]`decision_function`

(*self*, *X*)[source]

Predict confidence scores for samples.

The confidence score for a sample is the signed distance of that sample to the hyperplane.

Parameters:X : array_like or sparse matrix, shape (n_samples, n_features)Samples. | |

Returns:array, shape=(n_samples,) if n_classes == 2 else (n_samples, n_classes) Confidence scores per (sample, class) combination. In the binary case, confidence score for self.classes_[1] where >0 means this class would be predicted. |

Samples.

`densify`

(*self*)[source]

Convert coefficient matrix to dense array format.

Converts the `coef_`

member (back) to a numpy.ndarray. This is the default format of `coef_`

and is required for fitting, so calling this method is only required on models that have previously been sparsified; otherwise, it is a no-op.

Returns: | self : estimator |
---|

`fit`

(*self*, *X*, *y*, *sample_weight=None*)[source]

Fit the model according to the given training data.

Parameters:X : {array-like, sparse matrix}, 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,)Target vector relative to X. sample_weight : array-like, shape (n_samples,) optionalArray of weights that are assigned to individual samples. If not provided, then each sample is given unit weight. New in version 0.17: sample_weight support to LogisticRegression. |

Returns:self : object |

**Notes**

The SAGA solver supports both float64 and float32 bit arrays.`get_params`

(*self*, *deep=True*)[source]

Get parameters for this estimator.

Parameters:deep : boolean, optionalIf True, will return the parameters for this estimator and contained subobjects that are estimators. |

Returns:params : mapping of string to anyParameter names mapped to their values. |

`predict`

(*self*, *X*)[source]

Predict class labels for samples in X.

Parameters:X : array_like or sparse matrix, shape (n_samples, n_features)Samples. |

Returns:C : array, shape [n_samples]Predicted class label per sample. |

`predict_log_proba`

(*self*, *X*)[source]

Log of probability estimates.

The returned estimates for all classes are ordered by the label of classes.

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

Returns:T : array-like, shape = [n_samples, n_classes]Returns the log-probability of the sample for each class in the model, where classes are ordered as they are in `self.classes_` . |

`predict_proba`

(*self*, *X*)[source]

Probability estimates.

The returned estimates for all classes are ordered by the label of classes.

For a multi_class problem, if multi_class is set to be “multinomial” the softmax function is used to find the predicted probability of each class. Else use a one-vs-rest approach, i.e calculate the probability of each class assuming it to be positive using the logistic function. and normalize these values across all the classes.

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

Returns:T : array-like, shape = [n_samples, n_classes]Returns the probability of the sample for each class in the model, where classes are ordered as they are in `self.classes_` . |

`score`

(*self*, *X*, *y*, *sample_weight=None*)[source]

Returns 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:X : array-like, shape = (n_samples, n_features)Test samples. y : array-like, shape = (n_samples) or (n_samples, n_outputs)True labels for X. sample_weight : array-like, shape = [n_samples], optionalSample weights. |

Returns:score : floatMean accuracy of self.predict(X) wrt. y. |

`set_params`

(*self*, ***params*)[source]

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form `<component>__<parameter>`

so that it’s possible to update each component of a nested object.

Returns: | self |
---|

`sparsify`

(*self*)[source]

Convert coefficient matrix to sparse format.

Converts the `coef_`

member to a scipy.sparse matrix, which for L1-regularized models can be much more memory- and storage-efficient than the usual numpy.ndarray representation.

The `intercept_`

member is not converted.

Returns: | self : estimator |
---|

Notes

For non-sparse models, i.e. when there are not many zeros in `coef_`

, this may actually *increase* memory usage, so use this method with care. A rule of thumb is that the number of zero elements, which can be computed with `(coef_ == 0).sum()`

, must be more than 50% for this to provide significant benefits.

After calling this method, further fitting with the partial_fit method (if any) will not work until you call densify.

## Examples

using `sklearn.linear_model.LogisticRegression`

Compact estimator representations

Comparison of Calibration of Classifiers

Probability Calibration curves

Plot classification probability

Column Transformer with Mixed Types

Plot class probabilities calculated by the VotingClassifier

Feature transformations with ensembles of trees

Digits Classification Exercise

Regularization path of L1- Logistic Regression

Logistic Regression 3-class Classifier

Comparing various online solvers

MNIST classfification using multinomial logistic + L1

Plot multinomial and One-vs-Rest Logistic Regression

L1 Penalty and Sparsity in Logistic Regression

Multiclass sparse logisitic regression on newgroups20

Restricted Boltzmann Machine features for digit classification