.. lsqfitgp/docs/index.rst
..
.. Copyright (c) 2020, 2022, Giacomo Petrillo
..
.. This file is part of lsqfitgp.
..
.. lsqfitgp is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, either version 3 of the License, or
.. (at your option) any later version.
..
.. lsqfitgp is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU General Public License for more details.
..
.. You should have received a copy of the GNU General Public License
.. along with lsqfitgp.  If not, see <http://www.gnu.org/licenses/>.

.. module:: lsqfitgp

lsqfitgp
========

This is the documentation for the python module :mod:`lsqfitgp`. It provides a
simple but powerful interface to use Gaussian processes for fitting. The code
is open source, available on `github
<https://github.com/Gattocrucco/lsqfitgp>`_ under the `GNU General Public
License <https://www.gnu.org/licenses/gpl-3.0.html>`_.

Briefly, Gaussian processes are a statistical tool for fitting unknown
functions. If you want to know more about Gaussian processes, the book
`Gaussian Processes for Machine Learning <http://gaussianprocess.org/gpml/>`_
is a good reference available for free. However, understanding the technical
details is not necessary to use the basic functionality of the module.

To start, read the :ref:`installation` section, and then :ref:`sine`. To report
bugs or request features, `open an issue
<https://github.com/Gattocrucco/lsqfitgp/issues>`_ on github.

.. toctree::
    :maxdepth: 2
    :caption: Contents:
    
    userguide.rst
    reference.rst
    examples.rst
    
Indices and tables
==================

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