gemseo.mlearning.classification.algos.knn_settings module#

Settings of the k-nearest neighbors classification algorithm.

Settings KNNClassifier_Settings(*, transformer=<factory>, parameters=<factory>, input_names=(), output_names=(), n_neighbors=5)[source]#

Bases: BaseClassifierSettings

The settings of the k-nearest neighbors classification algorithm.

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

    By default it is set to <factory>.

  • parameters (Mapping[str, Any]) --

    By default it is set to <factory>.

  • input_names (Sequence[str]) --

    By default it is set to ().

  • output_names (Sequence[str]) --

    By default it is set to ().

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

    By default it is set to 5.

Return type:

None

n_neighbors: PositiveInt = 5#

The number of neighbors.

Constraints:

  • gt = 0

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None