pykoop.Centers

class Centers

Bases: BaseEstimator

Base class for all center generation estimators.

All attributes with a trailing underscore must be set in the subclass’ fit().

centers_

Centers, shape (n_centers, n_features).

Type:: np.ndarray

n_centers_

Number of centers generated.

Type:: int

n_features_in_

Number of features input.

Type:: int

__init__()

Methods

`__init__`()
`fit`(X[, y])	Generate centers from data.
`get_metadata_routing`()	Get metadata routing of this object.
`get_params`([deep])	Get parameters for this estimator.
`set_params`(**params)	Set the parameters of this estimator.

abstract fit(X, y=None)

Generate centers from data.

Parameters:

X (np.ndarray) – Data matrix.
y (Optional[np.ndarray]) – Ignored.

Returns:

Instance of itself.

Return type:

Centers

Raises:

ValueError – If any of the constructor parameters are incorrect.

get_metadata_routing()

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)

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

set_params(**params)

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