.. _f-ar:

module ``timeseries.ar``
========================





.. inheritance-diagram:: mlinsights.timeseries.ar


Short summary
+++++++++++++

module ``mlinsights.timeseries.ar``

Auto-regressor for timeseries.


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| class                                                                           | truncated documentation                                                                                                |
+=================================================================================+========================================================================================================================+
| :class:`ARTimeSeriesRegressor <mlinsights.timeseries.ar.ARTimeSeriesRegressor>` | Base class to build a regressor on timeseries. The class computes one or several predictions at each time, between ... |
+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| property                                                                            | truncated documentation                                                                                          |
+=====================================================================================+==================================================================================================================+
| :py:meth:`_repr_html_ <mlinsights.timeseries.ar.ARTimeSeriesRegressor._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__ <mlinsights.timeseries.ar.ARTimeSeriesRegressor.__init__>` |                         |
+-------------------------------------------------------------------------------+-------------------------+
| :meth:`fit <mlinsights.timeseries.ar.ARTimeSeriesRegressor.fit>`              | Trains the model.       |
+-------------------------------------------------------------------------------+-------------------------+
| :meth:`predict <mlinsights.timeseries.ar.ARTimeSeriesRegressor.predict>`      | Returns the prediction  |
+-------------------------------------------------------------------------------+-------------------------+


Documentation
+++++++++++++

.. automodule:: mlinsights.timeseries.ar
    :members:
    :special-members: __init__
    :show-inheritance: