snowflake.ml.modeling.covariance.ShrunkCovariance¶

class snowflake.ml.modeling.covariance.ShrunkCovariance(*, store_precision=True, assume_centered=False, shrinkage=0.1, input_cols: Optional[Union[str, Iterable[str]]] = None, output_cols: Optional[Union[str, Iterable[str]]] = None, label_cols: Optional[Union[str, Iterable[str]]] = None, drop_input_cols: Optional[bool] = False, sample_weight_col: Optional[str] = None)¶

Bases: BaseTransformer

Covariance estimator with shrinkage For more details on this class, see sklearn.covariance.ShrunkCovariance

store_precision: bool, default=True

Specify if the estimated precision is stored.

assume_centered: bool, default=False

If True, data will not be centered before computation. Useful when working with data whose mean is almost, but not exactly zero. If False, data will be centered before computation.

shrinkage: float, default=0.1

Coefficient in the convex combination used for the computation of the shrunk estimate. Range is [0, 1].

input_cols: Optional[Union[str, List[str]]]

A string or list of strings representing column names that contain features. If this parameter is not specified, all columns in the input DataFrame except the columns specified by label_cols and sample-weight_col parameters are considered input columns.

label_cols: Optional[Union[str, List[str]]]

A string or list of strings representing column names that contain labels. This is a required param for estimators, as there is no way to infer these columns. If this parameter is not specified, then object is fitted without labels(Like a transformer).

output_cols: Optional[Union[str, List[str]]]

A string or list of strings representing column names that will store the output of predict and transform operations. The length of output_cols mus match the expected number of output columns from the specific estimator or transformer class used. If this parameter is not specified, output column names are derived by adding an OUTPUT_ prefix to the label column names. These inferred output column names work for estimator’s predict() method, but output_cols must be set explicitly for transformers.

sample_weight_col: Optional[str]

A string representing the column name containing the examples’ weights. This argument is only required when working with weighted datasets.

drop_input_cols: Optional[bool], default=False

If set, the response of predict(), transform() methods will not contain input columns.

Methods

fit(dataset)	Fit the shrunk covariance model to X For more details on this function, see sklearn.covariance.ShrunkCovariance.fit
score(dataset)	Compute the log-likelihood of X_test under the estimated Gaussian model For more details on this function, see sklearn.covariance.ShrunkCovariance.score
set_input_cols(input_cols)	Input columns setter.
to_sklearn()	Get sklearn.covariance.ShrunkCovariance object.

Attributes

model_signatures

Returns model signature of current class.