.. title:: sinflow documentation

sinflow
=======

   ``sinflow`` is a Python implementation of the sliced iterative normalizing flow (SINF) algorithm
   for density estimation and sampling. The package has minimal dependencies, requiring only
   ``numpy`` and ``scipy``. The code is designed to be easy to use and flexible, with a focus on
   performance and scalability. The package is designed to be used in a similar way to ``scikit-learn``,
   with a simple and consistent API.

.. admonition:: Where to start?
    :class: tip

    🖥 A good place to get started is with the :doc:`install` and then the
    :doc:`quickstart` guide. 

    📖 For more details, check out the :doc:`api`.

    🐛 If you encounter any problems, or if you find bugs,
    then head on over to the `GitHub issues page <https://github.com/minaskar/pocomc/issues>`_.

    👈 Check out the sidebar to find the full table of contents.



.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Contents:

   install
   quickstart.ipynb
   api
   GitHub Repository <https://github.com/minaskar/sinflow>


Attribution & Citation
----------------------

Please cite the following if you find this code useful in your
research. The BibTeX entry for the paper is::

    @article{karamanis2024sinflow,
        title={---},
        author={---},
        journal={---},
        year={2024}
    }


Authors & License
-----------------

Copyright 2024 Minas Karamanis and contributors.

``sinflow`` is free software made available under the ``GPL-3.0 License``.


Changelog
---------

**0.0.1 (09/10/24)**

- First working release.