snowflake.ml.modeling.manifold.SpectralEmbeddingΒΆ
- class snowflake.ml.modeling.manifold.SpectralEmbedding(*, n_components=2, affinity='nearest_neighbors', gamma=None, random_state=None, eigen_solver=None, eigen_tol='auto', n_neighbors=None, n_jobs=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
Spectral embedding for non-linear dimensionality reduction For more details on this class, see sklearn.manifold.SpectralEmbedding
- 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=2
The dimension of the projected subspace.
- affinity: {βnearest_neighborsβ, βrbfβ, βprecomputedβ, βprecomputed_nearest_neighborsβ} or callable, default=βnearest_neighborsβ
- How to construct the affinity matrix.
βnearest_neighborsβ: construct the affinity matrix by computing a graph of nearest neighbors.
βrbfβ: construct the affinity matrix by computing a radial basis function (RBF) kernel.
βprecomputedβ: interpret
X
as a precomputed affinity matrix.βprecomputed_nearest_neighborsβ: interpret
X
as a sparse graph of precomputed nearest neighbors, and constructs the affinity matrix by selecting then_neighbors
nearest neighbors.callable: use passed in function as affinity the function takes in data matrix (n_samples, n_features) and return affinity matrix (n_samples, n_samples).
- gamma: float, default=None
Kernel coefficient for rbf kernel. If None, gamma will be set to 1/n_features.
- random_state: int, RandomState instance or None, default=None
A pseudo random number generator used for the initialization of the lobpcg eigen vectors decomposition when eigen_solver == βamgβ, and for the K-Means initialization. Use an int to make the results deterministic across calls (See Glossary).
- eigen_solver: {βarpackβ, βlobpcgβ, βamgβ}, default=None
The eigenvalue decomposition strategy to use. AMG requires pyamg to be installed. It can be faster on very large, sparse problems. If None, then
'arpack'
is used.- eigen_tol: float, default=βautoβ
Stopping criterion for eigendecomposition of the Laplacian matrix. If eigen_tol=βautoβ then the passed tolerance will depend on the eigen_solver:
If eigen_solver=βarpackβ, then eigen_tol=0.0;
If eigen_solver=βlobpcgβ or eigen_solver=βamgβ, then eigen_tol=None which configures the underlying lobpcg solver to automatically resolve the value according to their heuristics. See,
scipy.sparse.linalg.lobpcg()
for details.
Note that when using eigen_solver=βlobpcgβ or eigen_solver=βamgβ values of tol<1e-5 may lead to convergence issues and should be avoided.
- n_neighbors: int, default=None
Number of nearest neighbors for nearest_neighbors graph building. If None, n_neighbors will be set to max(n_samples/10, 1).
- n_jobs: int, default=None
The number of parallel jobs to run.
None
means 1 unless in ajoblib.parallel_backend
context.-1
means using all processors. See Glossary for more details.
Methods
fit
(dataset)Fit the model from data in X For more details on this function, see sklearn.manifold.SpectralEmbedding.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.manifold.SpectralEmbedding object.
Attributes
model_signatures
Returns model signature of current class.