sortedl1.Slope#

class sortedl1.Slope(lam: None | ArrayLike = None, alpha: float = 1.0, fit_intercept: bool = True, standardize: bool = False, max_iter: int = 100000, tol: float = 0.0001)[source]#

Bases: BaseEstimator, RegressorMixin

Sorted L-One Penalized Estimation.

Parameters:

lam – The lambda parameter vector for the Sorted L1 Penalty.
alpha – A multiplier for the Sorted L1 Penalty.
fit_intercept – Whether to fit an intercept term.
standardize – Whether to standardize the features.
max_iter – Maximum number of iterations for the inner loop.
tol – Tolerance for the stopping criterion.

Variables:

intercept (float) – The estimated intercept.
coef (ndarray) – The estimated regression coefficients in a sparse format.
sparse_coef (scipy.sparse.csc_matrix) – The estimated regression coefficients in a dense format.
lambda (ndarray) – The lambda parameter vector for the Sorted L1 Penalty.
n_iter (int) – The total number of iterations from the inner loop.
n_features_in (int) – The number of features seen by the estimator.

Methods

`fit`	Fit the model according to the given training data.
`get_metadata_routing`	Get metadata routing of this object.
`get_params`	Get parameters for this estimator.
`predict`	Generate predictions for new data.
`score`	Return the coefficient of determination of the prediction.
`set_params`	Set the parameters of this estimator.
`set_score_request`	Request metadata passed to the `score` method.

fit(X: ndarray | csc_array, y: ArrayLike)[source]#

Fit the model according to the given training data.

Parameters:

X – Training vector, where n_samples is the number of samples and n_features is the number of features.
y – Target vector relative to X.

Returns:

self – Returns self.

Return type:

object

get_metadata_routing()[source]#

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:: routing – A MetadataRequest encapsulating routing information.
Return type:: MetadataRequest

get_params(deep=True)[source]#

Get parameters for this estimator.

Parameters:: deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.
Returns:: params – Parameter names mapped to their values.
Return type:: dict

predict(X: ArrayLike | sparse.sparray) → np.ndarray[source]#

Generate predictions for new data.

Parameters:: X – Samples.
Returns:: C – Returns predicted values.
Return type:: array, shape (n_samples,)

score(X, y, sample_weight=None)[source]#

Return the coefficient of determination of the prediction.

The coefficient of determination $R^2$ is defined as $(1 - \frac{u}{v})$, where $u$ is the residual sum of squares ((y_true - y_pred)** 2).sum() and $v$ is the total sum of squares ((y_true - y_true.mean()) ** 2).sum(). The best possible score is 1.0 and it can be negative (because the model can be arbitrarily worse). A constant model that always predicts the expected value of y, disregarding the input features, would get a $R^2$ score of 0.0.

Parameters:

X (array-like of shape (n_samples, n_features)) – Test samples. For some estimators this may be a precomputed kernel matrix or a list of generic objects instead with shape (n_samples, n_samples_fitted), where n_samples_fitted is the number of samples used in the fitting for the estimator.
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – True values for X.
sample_weight (array-like of shape (n_samples,), default=None) – Sample weights.

Returns:

score – $R^2$ of self.predict(X) w.r.t. y.

Return type:

float

Notes

The $R^2$ score used when calling score on a regressor uses multioutput='uniform_average' from version 0.23 to keep consistent with default value of r2_score(). This influences the score method of all the multioutput regressors (except for MultiOutputRegressor).

set_params(**params)[source]#

Set the parameters of this estimator.

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

Parameters:: **params (dict) – Estimator parameters.
Returns:: self – Estimator instance.
Return type:: estimator instance

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → Slope[source]#

Request metadata passed to the score method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

True: metadata is requested, and passed to score if provided. The request is ignored if metadata is not provided.
False: metadata is not requested and the meta-estimator will not pass it to score.
None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.
str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

New in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:: sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for sample_weight parameter in score.
Returns:: self – The updated object.
Return type:: object