Source code for gemseo.mlearning.clustering.factory
# 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.
# Contributors:
# INITIAL AUTHORS - initial API and implementation and/or initial
# documentation
# :author: Matthias De Lozzo, Syver Doving Agdestein
# OTHER AUTHORS - MACROSCOPIC CHANGES
"""A factory to create clustering models.
This module contains a factory to instantiate an :class:`.MLClusteringAlgo` from its
class name. It also provides a list of available clustering models and allows testing if
a clustering model type is available.
"""
from __future__ import annotations
from gemseo.mlearning.clustering.clustering import MLClusteringAlgo
from gemseo.mlearning.core.factory import MLAlgoFactory
[docs]
class ClusteringModelFactory(MLAlgoFactory):
"""This factory instantiates an :class:`.MLClusteringAlgo` from its class name.
The class can be either internal or external. In this second case, it can be either
implemented in a module referenced in the "GEMSEO_PATH" or in a module The class can
be either internal or external. In the second case, it can be either implemented in
a module referenced in the GEMSEO_PATH environment variable or in a module starting
with "gemseo_" and referenced in the PYTHONPATH environment variable.
"""
_CLASS = MLClusteringAlgo
_MODULE_NAMES = ("gemseo.mlearning.clustering",)