Source code for gemseo.mlearning.linear_model_fitting.lars_cv

# 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.

"""Scikit-learn least angle regression (LARS) algorithm with built-in cross-validation."""  # noqa: E501

from __future__ import annotations

from sklearn.linear_model import LarsCV as SKLearnLarsCV

from gemseo.mlearning.linear_model_fitting.base_sklearn_linear_model_fitter import (
    BaseSKLearnLinearModelFitter,
)
from gemseo.mlearning.linear_model_fitting.lars_cv_settings import LARSCV_Settings
from gemseo.mlearning.linear_model_fitting.lars_settings import LARS_Settings




class LARSCV(BaseSKLearnLinearModelFitter[SKLearnLarsCV, LARS_Settings]):
    """Scikit-learn least angle regression (LARS) algorithm with built-in cross-validation."""  # noqa: E501

    Settings = LARSCV_Settings

    _FITTER_CLASS = SKLearnLarsCV