econml.sklearn_extensions.linear_model.WeightedLasso

class econml.sklearn_extensions.linear_model.WeightedLasso(alpha=1.0, fit_intercept=True, precompute=False, copy_X=True, max_iter=1000, tol=0.0001, warm_start=False, positive=False, random_state=None, selection='cyclic')[source]

Bases: econml.sklearn_extensions.linear_model.WeightedModelMixin, sklearn.linear_model._coordinate_descent.Lasso

Version of sklearn Lasso that accepts weights.

Parameters

alpha (float, optional) – Constant that multiplies the L1 term. Defaults to 1.0. alpha = 0 is equivalent to ordinary least squares, solved by the LinearRegression object. For numerical reasons, using alpha = 0 with Lasso is not advised. Given this, you should use the LinearRegression object.
fit_intercept (bool, default True) – Whether to calculate the intercept for this model. If set to False, no intercept will be used in calculations (e.g. data is expected to be already centered).
precompute (True | False | array_like, default False) – Whether to use a precomputed Gram matrix to speed up calculations. If set to 'auto' let us decide. The Gram matrix can also be passed as argument. For sparse input this option is always True to preserve sparsity.
copy_X (bool, default True) – If True, X will be copied; else, it may be overwritten.
max_iter (int, optional) – The maximum number of iterations
tol (float, optional) – The tolerance for the optimization: if the updates are smaller than tol, the optimization code checks the dual gap for optimality and continues until it is smaller than tol.
warm_start (bool, optional) – When set to True, reuse the solution of the previous call to fit as initialization, otherwise, just erase the previous solution. See the Glossary.
positive (bool, optional) – When set to True, forces the coefficients to be positive.
random_state (int, RandomState instance, or None, default None) – The seed of the pseudo random number generator that selects a random feature to update. 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 selection='random'.
selection (str, default ‘cyclic’) – If set to ‘random’, a random coefficient is updated every iteration rather than looping over features sequentially by default. This (setting to ‘random’) often leads to significantly faster convergence especially when tol is higher than 1e-4.

coef_

parameter vector (w in the cost function formula)

Type: array, shape (n_features,) | (n_targets, n_features)

intercept_

independent term in decision function.

Type: float | array, shape (n_targets,)

n_iter_

number of iterations run by the coordinate descent solver to reach the specified tolerance.

Type: int | array_like, shape (n_targets,)

__init__(alpha=1.0, fit_intercept=True, precompute=False, copy_X=True, max_iter=1000, tol=0.0001, warm_start=False, positive=False, random_state=None, selection='cyclic')[source]

Methods

`__init__`([alpha, fit_intercept, precompute, ...])
`fit`(X, y[, sample_weight, check_input])	Fit model with coordinate descent.
`get_params`([deep])	Get parameters for this estimator.
`path`(X, y, *[, l1_ratio, eps, n_alphas, ...])	Compute elastic net path with coordinate descent.
`predict`(X)	Predict using the linear model.
`score`(X, y[, sample_weight])	Return the coefficient of determination of the prediction.
`set_params`(**params)	Set the parameters of this estimator.

Attributes

sparse_coef_

Sparse representation of the fitted coef_.

fit(X, y, sample_weight=None, check_input=True)[source]

Fit model with coordinate descent.

Parameters

X (ndarray or scipy.sparse matrix, (n_samples, n_features)) – Data
y (ndarray, shape (n_samples,) or (n_samples, n_targets)) – Target. Will be cast to X’s dtype if necessary
sample_weight (numpy array of shape [n_samples]) – Individual weights for each sample. The weights will be normalized internally.
check_input (bool, default True) – Allow to bypass several input checking. Don’t use this parameter unless you know what you do.

get_params(deep=True)

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

static path(X, y, *, l1_ratio=0.5, eps=0.001, n_alphas=100, alphas=None, precompute='auto', Xy=None, copy_X=True, coef_init=None, verbose=False, return_n_iter=False, positive=False, check_input=True, **params)

Compute elastic net path with coordinate descent.

The elastic net optimization function varies for mono and multi-outputs.

For mono-output tasks it is:

1 / (2 * n_samples) * ||y - Xw||^2_2
+ alpha * l1_ratio * ||w||_1
+ 0.5 * alpha * (1 - l1_ratio) * ||w||^2_2

For multi-output tasks it is:

(1 / (2 * n_samples)) * ||Y - XW||_Fro^2
+ alpha * l1_ratio * ||W||_21
+ 0.5 * alpha * (1 - l1_ratio) * ||W||_Fro^2

Where:

||W||_21 = \sum_i \sqrt{\sum_j w_{ij}^2}

i.e. the sum of norm of each row.