8.15.2.3. sklearn.linear_model.sparse.SGDClassifier

class sklearn.linear_model.sparse.SGDClassifier(*args, **kwargs)

Methods

decision_function(X)	Predict signed ‘distance’ to the hyperplane (aka confidence score)
fit(X, y[, coef_init, intercept_init, ...])	Fit linear model with Stochastic Gradient Descent.
fit_transform(X[, y])	Fit to data, then transform it
get_params([deep])	Get parameters for the estimator
partial_fit(X, y[, classes, class_weight, ...])	Fit linear model with Stochastic Gradient Descent.
predict(X)	Predict using the linear model
predict_proba(X)	Predict class membership probability
score(X, y)	Returns the mean accuracy on the given test data and labels.
set_params(**params)	Set the parameters of the estimator.
transform(X[, threshold])	Reduce X to its most important features.

__init__(*args, **kwargs)

DEPRECATED: to be removed in v0.12; use sklearn.linear_model.SGDClassifier directly

classes

DEPRECATED: to be removed in v0.12; use classes_ instead.

decision_function(X)

Predict signed ‘distance’ to the hyperplane (aka confidence score)

Parameters :

X : {array-like, sparse matrix}, shape = [n_samples, n_features]

Returns :

array, shape = [n_samples] if n_classes == 2 else [n_samples,n_classes] :

The signed ‘distances’ to the hyperplane(s).

fit(X, y, coef_init=None, intercept_init=None, class_weight=None, sample_weight=None)

Fit linear model with Stochastic Gradient Descent.

Parameters :

X : {array-like, sparse matrix}, shape = [n_samples, n_features]

Training data

y : numpy array of shape [n_samples]

Target values

coef_init : array, shape = [n_classes,n_features]

The initial coeffients to warm-start the optimization.

intercept_init : array, shape = [n_classes]

The initial intercept to warm-start the optimization.

sample_weight : array-like, shape = [n_samples], optional

Weights applied to individual samples. If not provided, uniform weights are assumed.

Returns :

self : returns an instance of self.

fit_transform(X, y=None, **fit_params)

Fit to data, then transform it

Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.

Parameters :

X : numpy array of shape [n_samples, n_features]

Training set.

y : numpy array of shape [n_samples]

Target values.

Returns :

X_new : numpy array of shape [n_samples, n_features_new]

Transformed array.

Notes

This method just calls fit and transform consecutively, i.e., it is not an optimized implementation of fit_transform, unlike other transformers such as PCA.

get_params(deep=True)

Get parameters for the estimator

Parameters :

deep: boolean, optional :

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

partial_fit(X, y, classes=None, class_weight=None, sample_weight=None)

Fit linear model with Stochastic Gradient Descent.

Parameters :

X : {array-like, sparse matrix}, shape = [n_samples, n_features]

Subset of the training data

y : numpy array of shape [n_samples]

Subset of the target values

classes : array, shape = [n_classes]

Classes across all calls to partial_fit. Can be obtained by via np.unique(y_all), where y_all is the target vector of the entire dataset. This argument is required for the first call to partial_fit and can be omitted in the subsequent calls. Note that y doesn’t need to contain all labels in classes.

sample_weight : array-like, shape = [n_samples], optional

Weights applied to individual samples. If not provided, uniform weights are assumed.

Returns :

self : returns an instance of self.

predict(X)

Predict using the linear model

Parameters :

X : {array-like, sparse matrix}, shape = [n_samples, n_features]

Returns :

array, shape = [n_samples] :

Array containing the predicted class labels.

predict_proba(X)

Predict class membership probability

Parameters :

X : {array-like, sparse matrix}, shape = [n_samples, n_features]

Returns :

array, shape = [n_samples] if n_classes == 2 else [n_samples, :

n_classes] :

Contains the membership probabilities of the positive class.

score(X, y)

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

Parameters :

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

Training set.

y : array-like, shape = [n_samples]

Labels for X.

Returns :

z : float

set_params(**params)

Set the parameters of the estimator.

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

Returns :self :

transform(X, threshold=None)

Reduce X to its most important features.

Parameters :

X : array or scipy sparse matrix of shape [n_samples, n_features]

The input samples.

threshold : string, float or None, optional (default=None)

The threshold value to use for feature selection. Features whose importance is greater or equal are kept while the others are discarded. If “median” (resp. “mean”), then the threshold value is the median (resp. the mean) of the feature importances. A scaling factor (e.g., “1.25*mean”) may also be used. If None and if available, the object attribute threshold is used. Otherwise, “mean” is used by default.

Returns :

X_r : array of shape [n_samples, n_selected_features]

The input samples with only the selected features.