pyFTS/docs/index.rst
2020-08-18 17:06:41 -03:00

78 lines
3.5 KiB
ReStructuredText

.. pyFTS documentation master file, created by
sphinx-quickstart on Wed Aug 29 13:47:28 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
pyFTS - Fuzzy Time Series for Python
====================================
What is pyFTS Library?
----------------------
.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
.. image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
.. raw:: html
<style>
#forkongithub a{ background:#000; color:#fff; text-decoration:none; font-family:arial,sans-serif;
text-align:center;font-weight:bold;padding:5px 40px;font-size:1rem;line-height:2rem;position:relative;transition:0.5s;}#forkongithub a:hover{background:#c11;color:#fff;}
#forkongithub a::before,#forkongithub a::after{content:"";width:100%;display:block;position:absolute;top:1px;left:0;height:1px;background:#fff;}
#forkongithub a::after{bottom:1px;top:auto;}@media screen and (min-width:800px){
#forkongithub{position:fixed;display:block;top:0;right:0;width:200px;overflow:hidden;height:200px;z-index:9999;}
#forkongithub a{width:200px;position:absolute;top:60px;right:-60px;transform:rotate(45deg);-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);-moz-transform:rotate(45deg);-o-transform:rotate(45deg);box-shadow:4px 4px 10px rgba(0,0,0,0.8);}}
</style>
<span id="forkongithub"><a href="https://github.com/PYFTS/pyFTS">Fork me on GitHub</a></span>
This package is intended for students, researchers, data scientists or whose want to exploit the Fuzzy Time Series methods. These methods provide simple, easy to use, computationally cheap and human-readable models, suitable from statistic laymans to experts.
This tool is developed on `MINDS Lab <http://www.minds.eng.ufmg.br/>`_,
headed by Prof. Frederico Gadelha Guimarães from `Electrical
Engineering Departament <https://www.ppgee.ufmg.br/>`_ of `Federal University
of Minas Gerais (UFMG) <https://ufmg.br/>`_ at Brazil. Also colaborate
with this tool the Brazilian instituitions `Federal Institute of
North of Minas Gerais (IFNMG) <http://www.ifnmg.edu.br>`_ and `Federal Institute of Minas Gerais
(IFMG) <http://www.ifmg.edu.br>`_ .
.. raw:: html
<center>
<table><tr><td> <a href="http://www.minds.eng.ufmg.br/"><img src="https://github.com/petroniocandido/pyFTS/raw/master/img/minds_logo_medium.jpeg" alt="MINDS - Machine Intelligence and Data Science Lab" width="100"/></a></td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td><a href="https://www.ufmg.br/"><img src="https://www.ufmg.br/marca/ass3.jpg" alt="UFMG" width="100"/></a></td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td><a href="https://www.ifnmg.edu.br/"><img
src="https://www.ifnmg.edu.br/arquivos/2016/reitoria/Not%C3%ADcias/ifnmg_vertical_jpg.jpg" alt="IFNMG" width="130"/></a></td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td><a href="https://www.ifmg.edu.br/"><img
src="http://www.ifmg.edu.br/portal/imagens/logovertical.jpg" alt="IFMG" width="100"/></a></td>
</tr>
</table>
</center>
.. toctree::
:maxdepth: 3
:caption: API Documentation:
quickstart
modules
How to reference pyFTS?
-----------------------
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.597359.svg
:target: https://doi.org/10.5281/zenodo.597359
Silva, P. C. L. et al. *pyFTS: Fuzzy Time Series for Python.* Belo Horizonte. 2018. DOI: 10.5281/zenodo.597359. Url: <https://doi.org/10.5281/zenodo.597359>
Indexes
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`