.. LightOnML documentation master file, created by
   sphinx-quickstart.

LightOnML documentation
===========================================

LightOnML is a Python3 library to perform computations on optical processing units.

Version |version|

.. toctree::
    :glob:
    :maxdepth: 1
    :caption: Notes

    notes/introduction.rst
    notes/opu.rst
    notes/get_started.ipynb
    notes/opu_in_depth.rst
    notes/migration_guide.rst
    notes/release_notes.rst

.. toctree::
    :glob:
    :maxdepth: 1
    :caption: Examples

    examples/kernels_and_random_features.ipynb
    examples/pipeline_and_crossval_OPU.ipynb
    examples/saving_and_loading.ipynb
    examples/bitplan_encoding_tutorial.rst
    examples/transfer_learning.ipynb
    examples/randomized_svd.ipynb
    examples/newma_online.ipynb
    examples/autoencoder_tutorial.ipynb
    examples/others.rst

.. toctree::
   :maxdepth: 1
   :caption: API Reference

   lightonml.encoding
   lightonml.projections
   lightonml.opu
   lightonml.datasets
   lightonml.utils


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: Advanced

   advanced/extending.rst