Source code for gemseo.mlearning.core.algos.unsupervised_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 for the unsupervised machine learning algorithms."""

from __future__ import annotations

from collections.abc import Sequence  # noqa: TC003

from pydantic import Field

from gemseo.mlearning.core.algos.ml_algo_settings import BaseMLAlgoSettings




class BaseMLUnsupervisedAlgoSettings(BaseMLAlgoSettings):
    """The settings common to all the unsupervised machine learning algorithms."""

    var_names: Sequence[str] = Field(
        default=(), description="The names of the variables."
    )