.. fp documentation master file

funprogram
==========

Welcome to the `fp`_ package documentation! 

This lightweight library aims at providing a functional-language-like 
interface to the industrial-grade computation backends the python ecosystem benefits from, 
namely `jax`_, `torch`_ and `numpy`_. 

* 📦 install with `pip install funprogram` ✨
* 📝 the `manual`_ will get you started with the basics of `fp` 🛩️
* 📚 the `docstrings`_ may grant you deeper understanding of the internals ⚙️

See the `fp`_ repository on more details on installation options. 

This package is still under development.
We hope that you'll give it a try, whether you're familiar with functional programming or not!

.. _fp: https://github.com/opeltre/fp
.. _manual: manual/toc.html
.. _docstrings: API/modules.html
.. _jax: https://jax.readthedocs.io/en/latest/
.. _torch: https://pytorch.org
.. _numpy: https://numpy.org 


.. toctree::
     :maxdepth: 2
     :caption: Contents
     
     manual/toc
     API/modules

..  .. toctree::
       :maxdepth: 2
       :caption: module documentations

        API/tensors.rst

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

* :ref:`genindex`