:py:mod:`ForeTiS.utils.helper_functions`
========================================

.. py:module:: ForeTiS.utils.helper_functions


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


Functions
~~~~~~~~~

.. autoapisummary::

   ForeTiS.utils.helper_functions.get_list_of_implemented_models
   ForeTiS.utils.helper_functions.get_mapping_name_to_class
   ForeTiS.utils.helper_functions.set_all_seeds
   ForeTiS.utils.helper_functions.get_indexes
   ForeTiS.utils.helper_functions.get_datasplit_config_info_for_resultfolder



.. py:function:: get_list_of_implemented_models()

   Create a list of all implemented models based on files existing in 'model' subdirectory of the repository.


.. py:function:: get_mapping_name_to_class()

   Get a mapping from model name (naming in package model without .py) to class name.

   :return: dictionary with mapping model name to class name


.. py:function:: set_all_seeds(seed = 42)

   Set all seeds of libs with a specific function for reproducibility of results

   :param seed: seed to use


.. py:function:: get_indexes(df, datasplit, folds, seasonal_valtest, valtest_seasons, seasonal_periods, val_set_size_percentage)

   Get the indexes for cv

   :param df: data that should be splited
   :param datasplit: splitting method
   :param folds: number of folds of the hyperparameter optimization
   :param valtest_seasons: the number of seasons to be used for validation and testing when seasonal_valtest is True
   :param seasonal_periods: how many datapoints one season has
   :param test_set_size_percentage: size of the test set relevant for cv-test and train-val-test
   :param val_set_size_percentage: size of the validation set relevant for train-val-test

   :return: train and test indexes


.. py:function:: get_datasplit_config_info_for_resultfolder(resultfolder)

   Get all datasplit info for a result folder

   :param resultfolder: path to retrieve info

   :return: datasplit info with datasplit, n_outerfolds, n_innerfolds, val_set_size_percentage, test_set_size_percentage, maf_percentage