Source code for gemseo.mlearning.classification.algos.knn_settings

# Copyright 2021 IRT Saint Exupéry, https://www.irt-saintexupery.com
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
"""Settings of the k-nearest neighbors classification algorithm."""

from __future__ import annotations

from pydantic import Field
from pydantic import PositiveInt

from gemseo.mlearning.classification.algos.base_classifier_settings import (
    BaseClassifierSettings,
)




class KNNClassifier_Settings(BaseClassifierSettings):  # noqa: N801
    """The settings of the k-nearest neighbors classification algorithm."""

    n_neighbors: PositiveInt = Field(default=5, description="The number of neighbors.")