gemseo.mlearning.clustering.algos.kmeans_settings module

Settings of the k-means clustering model.

Settings KMeans_Settings(*, transformer=None, parameters=None, var_names=(), n_clusters=5, random_state=0)

Bases: BaseClustererSettings

The settings of the k-means clustering model.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• transformer (Mapping[str, Any])

• parameters (Mapping[str, Any])

• var_names (Sequence[str]) --

  By default it is set to ().

• n_clusters (Annotated[int, Gt(gt=0)]) --

  By default it is set to 5.

• random_state (Annotated[int, Ge(ge=0)] | None) --

  By default it is set to 0.

Return type:

None