:py:mod:`ForeTiS.model._stat_model`
===================================

.. py:module:: ForeTiS.model._stat_model


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   ForeTiS.model._stat_model.StatModel




.. py:class:: StatModel(optuna_trial, datasets, featureset_name, optimize_featureset, current_model_name = None, target_column = None, pca_transform = None)

   Bases: :py:obj:`ForeTiS.model._base_model.BaseModel`, :py:obj:`abc.ABC`

   Parent class based on BaseModel for all models with a statsmodels-like API to share functionalities.
   See :obj:`~ForeTiS.model._base_model.BaseModel` for more information.

   .. py:method:: retrain(retrain)

      Implementation of the retraining for models with statsmodels-like API.
      See :obj:`~ForeTiS.model._base_model.BaseModel` for more information.


   .. py:method:: update(update, period)

      Update existing model due to new samples.
      See :obj:`~ForeTiS.model._base_model.BaseModel` for more information.


   .. py:method:: predict(X_in)

      Implementation of a prediction based on input features for models with statsmodels-like API.
      See :obj:`~ForeTiS.model._base_model.BaseModel` for more information.


   .. py:method:: train_val_loop(train, val)

      Implementation of a train and validation loop for models with statsmodels-like API.
      See :obj:`~ForeTiS.model._base_model.BaseModel` for more information.


   .. py:method:: get_transformed_set(df, target_column, transf, power_transformer, only_transform=False)

      Function returning dataset with (log or power) transformed column

      :param df: dataset to transform
      :param target_column: column to transform
      :param transf: type of transformation
      :param power_transformer: if power transforming was applied, the used transformer
      :param only_transform: whether to only transform or not

      :return: dataset with transformed column


   .. py:method:: get_inverse_transformed_set(y, transf, power_transformer, is_conf = False)

      Function returning inverse (log or power) transformed column

      :param y: array to be inverse transformed
      :param power_transformer: if power transforming was applied, the used transformer
      :param transf: type of transformation

      :return: transformed column


   .. py:method:: common_hyperparams()
      :staticmethod:

      Add hyperparameters that are common for PyTorch models.
      Do not need to be included in optimization for every child model.
      See :obj:`~ForeTiS.model._base_model.BaseModel` for more information.