.. _f-base: module ``timeseries.base`` ========================== .. inheritance-diagram:: mlinsights.timeseries.base Short summary +++++++++++++ module ``mlinsights.timeseries.base`` Base class for timeseries. :githublink:`%|py|5` Classes +++++++ +---------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +===============================================================================================================+========================================================================================================================+ | :class:`BaseReciprocalTimeSeriesTransformer ` | Base for all timeseries preprocessing automatically applied within a predictor. | +---------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :class:`BaseTimeSeries ` | Base class to build a predictor on timeseries. The class computes one or several predictions at each time, between ... | +---------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :class:`TimeSeriesRegressorMixin ` | Addition to :epkg:`sklearn:base:RegressorMixin`. | +---------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +-----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ | property | truncated documentation | +=====================================================================================================+==================================================================================================================+ | :py:meth:`_repr_html_ ` | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... | +-----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_repr_html_ ` | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... | +-----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ Methods +++++++ +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +==============================================================================================================+========================================================================================================+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :py:meth:`_applies_preprocessing ` | Applies the preprocessing to the series. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :py:meth:`_applies_preprocessing_inv ` | Applies the preprocessing to the series. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :py:meth:`_base_fit_predict ` | Trains the preprocessing and returns the modified *X*, *y*, *sample_weight*. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :py:meth:`_fit_preprocessing ` | Applies the preprocessing. *X*, *y*, *sample_weight*. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :meth:`fit ` | Stores the first values. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :meth:`get_fct_inv ` | Returns the reverse tranform. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :meth:`has_preprocessing ` | Tells if there is one preprocessing. | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :meth:`score ` | Scores the prediction using :func:`ts_mape` | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ | :meth:`transform ` | Transforms both *X* and *y*. Returns *X* and *y*, returns *sample_weight* as well if not None. The ... | +--------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: mlinsights.timeseries.base :members: :special-members: __init__ :show-inheritance: