snowflake.ml.modeling.decomposition.IncrementalPCAΒΆ
- class snowflake.ml.modeling.decomposition.IncrementalPCA(*, n_components=None, whiten=False, copy=True, batch_size=None, input_cols: Optional[Union[str, Iterable[str]]] = None, output_cols: Optional[Union[str, Iterable[str]]] = None, label_cols: Optional[Union[str, Iterable[str]]] = None, passthrough_cols: Optional[Union[str, Iterable[str]]] = None, drop_input_cols: Optional[bool] = False, sample_weight_col: Optional[str] = None)ΒΆ
Bases:
BaseTransformer
Incremental principal components analysis (IPCA) For more details on this class, see sklearn.decomposition.IncrementalPCA
- 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, sample_weight_col, and passthrough_cols parameters are considered input columns. Input columns can also be set after initialization with the set_input_cols method.
- label_cols: Optional[Union[str, List[str]]]
This parameter is optional and will be ignored during fit. It is present here for API consistency by convention.
- 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 must match the expected number of output columns from the specific predictor or transformer class used. If you omit this parameter, output column names are derived by adding an OUTPUT_ prefix to the label column names for supervised estimators, or OUTPUT_<IDX>for unsupervised estimators. These inferred output column names work for predictors, but output_cols must be set explicitly for transformers. In general, explicitly specifying output column names is clearer, especially if you donβt specify the input column names. To transform in place, pass the same names for input_cols and output_cols. be set explicitly for transformers. Output columns can also be set after initialization with the set_output_cols method.
- sample_weight_col: Optional[str]
A string representing the column name containing the sample weights. This argument is only required when working with weighted datasets. Sample weight column can also be set after initialization with the set_sample_weight_col method.
- passthrough_cols: Optional[Union[str, List[str]]]
A string or a list of strings indicating column names to be excluded from any operations (such as train, transform, or inference). These specified column(s) will remain untouched throughout the process. This option is helpful in scenarios requiring automatic input_cols inference, but need to avoid using specific columns, like index columns, during training or inference. Passthrough columns can also be set after initialization with the set_passthrough_cols method.
- drop_input_cols: Optional[bool], default=False
If set, the response of predict(), transform() methods will not contain input columns.
- n_components: int, default=None
Number of components to keep. If
n_components
isNone
, thenn_components
is set tomin(n_samples, n_features)
.- whiten: bool, default=False
When True (False by default) the
components_
vectors are divided byn_samples
timescomponents_
to ensure uncorrelated outputs with unit component-wise variances.Whitening will remove some information from the transformed signal (the relative variance scales of the components) but can sometimes improve the predictive accuracy of the downstream estimators by making data respect some hard-wired assumptions.
- copy: bool, default=True
If False, X will be overwritten.
copy=False
can be used to save memory but is unsafe for general use.- batch_size: int, default=None
The number of samples to use for each batch. Only used when calling
fit
. Ifbatch_size
isNone
, thenbatch_size
is inferred from the data and set to5 * n_features
, to provide a balance between approximation accuracy and memory consumption.
Methods
fit
(dataset)Fit the model with X, using minibatches of size batch_size For more details on this function, see sklearn.decomposition.IncrementalPCA.fit
get_input_cols
()Input columns getter.
get_label_cols
()Label column getter.
get_output_cols
()Output columns getter.
get_params
([deep])Get parameters for this transformer.
get_passthrough_cols
()Passthrough columns getter.
get_sample_weight_col
()Sample weight column getter.
get_sklearn_args
([default_sklearn_obj, ...])Get sklearn keyword arguments.
set_drop_input_cols
([drop_input_cols])set_input_cols
(input_cols)Input columns setter.
set_label_cols
(label_cols)Label column setter.
set_output_cols
(output_cols)Output columns setter.
set_params
(**params)Set the parameters of this transformer.
set_passthrough_cols
(passthrough_cols)Passthrough columns setter.
set_sample_weight_col
(sample_weight_col)Sample weight column setter.
to_sklearn
()Get sklearn.decomposition.IncrementalPCA object.
transform
(dataset)Apply dimensionality reduction to X For more details on this function, see sklearn.decomposition.IncrementalPCA.transform
Attributes
model_signatures
Returns model signature of current class.