Source code for deeptab.models.trompt

from ..base_models.trompt import Trompt
from ..configs.trompt_config import DefaultTromptConfig
from ..utils.docstring_generator import generate_docstring
from .utils.sklearn_base_classifier import SklearnBaseClassifier
from .utils.sklearn_base_lss import SklearnBaseLSS
from .utils.sklearn_base_regressor import SklearnBaseRegressor


class TromptRegressor(SklearnBaseRegressor):
    __doc__ = generate_docstring(
        DefaultTromptConfig,
        model_description="""
        Trompt regressor. This class extends the SklearnBaseRegressor
        class and uses the Trompt model with the default Trompt
        configuration.
        """,
        examples="""
        >>> from deeptab.models import TromptRegressor
        >>> model = TromptRegressor(d_model=64, n_layers=8)
        >>> model.fit(X_train, y_train)
        >>> preds = model.predict(X_test)
        >>> model.evaluate(X_test, y_test)
        """,
    )

    def __init__(self, **kwargs):
        super().__init__(model=Trompt, config=DefaultTromptConfig, **kwargs)


class TromptClassifier(SklearnBaseClassifier):
    __doc__ = generate_docstring(
        DefaultTromptConfig,
        """Trompt Classifier. This class extends the SklearnBaseClassifier class
        and uses the Trompt model with the default Trompt configuration.""",
        examples="""
        >>> from deeptab.models import TromptClassifier
        >>> model = TromptClassifier(d_model=64, n_layers=8)
        >>> model.fit(X_train, y_train)
        >>> preds = model.predict(X_test)
        >>> model.evaluate(X_test, y_test)
        """,
    )

    def __init__(self, **kwargs):
        super().__init__(model=Trompt, config=DefaultTromptConfig, **kwargs)


class TromptLSS(SklearnBaseLSS):
    __doc__ = generate_docstring(
        DefaultTromptConfig,
        """Trompt for distributional regression.
        This class extends the SklearnBaseLSS class and uses the
        Trompt model with the default Trompt configuration.""",
        examples="""
        >>> from deeptab.models import TromptLSS
        >>> model = TromptLSS(d_model=64, n_layers=8)
        >>> model.fit(X_train, y_train, family="normal")
        >>> preds = model.predict(X_test)
        >>> model.evaluate(X_test, y_test)
        """,
    )

    def __init__(self, **kwargs):
        super().__init__(model=Trompt, config=DefaultTromptConfig, **kwargs)