Concrete Framework's documentation
===========================================


.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   README.md
   user/howto/INSTALLING.md
   benchmarks.md

.. toctree::
   :maxdepth: 2
   :caption: Tutorial

   user/tutorial/ARITHMETIC_OPERATIONS.md
   user/tutorial/TABLE_LOOKUP.md
   user/tutorial/WORKING_WITH_FLOATING_POINTS.md
   user/tutorial/COMPILATION_ARTIFACTS.md

.. toctree::
   :maxdepth: 2
   :caption: How to

   user/howto/COMPILING_AND_EXECUTING.md
   user/howto/PRINTING_AND_DRAWING.md
   user/howto/REDUCE_NEEDED_PRECISION.md
   user/howto/DEBUG_SUPPORT_SUBMIT_ISSUES.md
   user/howto/FAQ.md

.. toctree::
   :maxdepth: 2
   :caption: Advanced Examples

   user/advanced_examples/QuantizedLinearRegression.ipynb
   user/advanced_examples/QuantizedLogisticRegression.ipynb

.. toctree::
   :maxdepth: 2
   :caption: Explanation

   user/explanation/WHAT_IS_FHE.md
   user/explanation/FHE_AND_FRAMEWORK_LIMITS.md
   user/explanation/QUANTIZATION.md
   user/explanation/FUTURE_FEATURES.md

.. toctree::
   :maxdepth: 5
   :caption: Reference

   API <_apidoc/modules.rst>

.. toctree::
   :maxdepth: 2
   :caption: Developer - How To

   dev/howto/PROJECT_SETUP.md
   dev/howto/DOCKER.md
   dev/howto/DOCUMENTING.md
   Releasing on GitHub <dev/howto/RELEASING.md>
   dev/howto/CONTRIBUTING.md

.. toctree::
   :maxdepth: 2
   :caption: Developer - Explanation

   dev/explanation/COMPILATION.md
   dev/explanation/TERMINOLOGY_AND_STRUCTURE.md
   dev/explanation/FLOAT-FUSING.md
   dev/explanation/MLIR.md