.. skfore: A library in Python for time series forecasting documentation master file, created by
   sphinx-quickstart on Sun Jun 24 20:37:30 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to skfore: A library in Python for time series forecasting's documentation!
============================================================================================

**Date**: Jun 30, 2018  **Version**: 0.0.1

**Binary Installers:** https://pypi.org/project/skfore

**Source Repository**: https://github.com/jdvelasq/skfore

**Documentation**: http://skfore.readthedocs.io/en/latest/

**skfore** is an open source (distributed under the MIT license) and friendly-user
package to forecast. The package was developed and tested in Python
version 3.6. It can be installed from the command line using:

``$ pip install skfore``

**skfore** can be used interactively at the Python’s command prompt, but a better
experience is achieved when IPython or Jupyter’s notebook are used, allows the
user to fully document the analysis and draw conclusions. Due to the design of
the package, it is easy to use skfore with the tools available in the ecosystem
of open source tools for data science.

**skfore** is well suited for predicting time series and it can be used to:

* Time series forecast



Table of Contents
===============================================================================

**skfore** is organized in the following modules:

.. toctree::
   :maxdepth: 4

   skfore
   base_model
   extras
   transformer
   AR
   HoltWinters
   MA



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


MIT license
===============================================================================

Copyright (c) 2018 Juan David Velásquez-Henao, María Alejandra Arango-González

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.