asterism.base#

Module contents#

class asterism.base.Asterism(desc=None, seed=None, *, check=True, ensure_min_samples=2, ensure_min_features=1, accept_complex=False, accept_sparse=False, accept_large_sparse=False, ensure_all_finite=True)#

Bases: ClusterMixin, BaseEstimator

Test

Parameters:

desc (str, optional) – Test

fit(x, y=None, locs=None, n_steps=None, verbosity=1, display_rate=10, **kwargs)#
set_fit_request(*, display_rate: bool | None | str = '$UNCHANGED$', locs: bool | None | str = '$UNCHANGED$', n_steps: bool | None | str = '$UNCHANGED$', verbosity: bool | None | str = '$UNCHANGED$', x: bool | None | str = '$UNCHANGED$') → Asterism#

Configure whether metadata should be requested to be passed to the fit method.

Note that this method is only relevant when this estimator is used as a sub-estimator within a meta-estimator and metadata routing is enabled with enable_metadata_routing=True (see sklearn.set_config()). Please check the User Guide on how the routing mechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed to fit if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it to fit.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Parameters#

display_ratestr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for display_rate parameter in fit.

locsstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for locs parameter in fit.

n_stepsstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for n_steps parameter in fit.

verbositystr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for verbosity parameter in fit.

xstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for x parameter in fit.

Returns#

selfobject

The updated object.