mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
docs: add first documentation
This commit is contained in:
committed by
Ayoub Benaissa
parent
a1a694a686
commit
7f88d6553e
50
docs/cpp_api/conversion.rst
Normal file
50
docs/cpp_api/conversion.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
Conversion
|
||||
==========
|
||||
|
||||
HLFHETensorOpsToLinalg:
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/HLFHETensorOpsToLinalg/Pass.h
|
||||
|
||||
HLFHEToMidLFHE:
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/HLFHEToMidLFHE/Patterns.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/HLFHEToMidLFHE/Pass.h
|
||||
|
||||
MidLFHEGlobalParametrization:
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/MidLFHEGlobalParametrization/Pass.h
|
||||
|
||||
|
||||
MidLFHEToLowLFHE:
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/MidLFHEToLowLFHE/Patterns.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/MidLFHEToLowLFHE/Pass.h
|
||||
|
||||
LowLFHEToStd:
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/LowLFHEToConcreteCAPI/Pass.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/LowLFHEUnparametrize/Pass.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/MLIRLowerableDialectsToLLVM/Pass.h
|
||||
|
||||
Utils:
|
||||
^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/Utils/TensorOpTypeConversion.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/Utils/LinalgGenericTypeConverterPattern.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/Utils/GenericOpTypeConversionPattern.h
|
||||
|
||||
.. doxygenfile:: zamalang/Conversion/Utils/GlobalFHEContext.h
|
||||
|
||||
|
||||
|
||||
13
docs/cpp_api/index.rst
Normal file
13
docs/cpp_api/index.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
.. _api:
|
||||
|
||||
API
|
||||
===
|
||||
|
||||
.. See https://breathe.readthedocs.io/en/latest/directives.html#doxygenfile for more info
|
||||
.. on doxygen sphinx format
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
*
|
||||
8
docs/cpp_api/runtime.rst
Normal file
8
docs/cpp_api/runtime.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
Runtime
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
runtime/*
|
||||
4
docs/cpp_api/runtime/context.rst
Normal file
4
docs/cpp_api/runtime/context.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Context:
|
||||
========
|
||||
|
||||
.. doxygenfile:: zamalang/Runtime/context.h
|
||||
0
docs/cpp_api/runtime/dataflow_runtime copy.rst
Normal file
0
docs/cpp_api/runtime/dataflow_runtime copy.rst
Normal file
8
docs/cpp_api/runtime/dataflow_runtime.rst
Normal file
8
docs/cpp_api/runtime/dataflow_runtime.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
DataflowRuntime:
|
||||
================
|
||||
.. doxygenfile:: zamalang/Runtime/DFRuntime.hpp
|
||||
|
||||
Debug interface:
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: zamalang/Runtime/dfr_debug_interface.h
|
||||
4
docs/cpp_api/runtime/distributed_generic_task_server.rst
Normal file
4
docs/cpp_api/runtime/distributed_generic_task_server.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Distributed generic task server:
|
||||
================================
|
||||
|
||||
.. doxygenfile:: zamalang/Runtime/distributed_generic_task_server.hpp
|
||||
4
docs/cpp_api/runtime/key_manager.rst
Normal file
4
docs/cpp_api/runtime/key_manager.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Key Manager:
|
||||
============
|
||||
|
||||
.. doxygenfile:: zamalang/Runtime/key_manager.hpp
|
||||
4
docs/cpp_api/runtime/runtime_api.rst
Normal file
4
docs/cpp_api/runtime/runtime_api.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Runtime API:
|
||||
============
|
||||
|
||||
.. doxygenfile:: zamalang/Runtime/runtime_api.h
|
||||
4
docs/cpp_api/runtime/wrappers.rst
Normal file
4
docs/cpp_api/runtime/wrappers.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Wrappers:
|
||||
=========
|
||||
|
||||
.. doxygenfile:: zamalang/Runtime/wrappers.h
|
||||
8
docs/cpp_api/support.rst
Normal file
8
docs/cpp_api/support.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
Support
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
support/*
|
||||
28
docs/cpp_api/support/bonus.rst
Normal file
28
docs/cpp_api/support/bonus.rst
Normal file
@@ -0,0 +1,28 @@
|
||||
Bonus:
|
||||
======
|
||||
|
||||
Logging:
|
||||
^^^^^^^^
|
||||
|
||||
.. doxygenfile:: logging.h
|
||||
|
||||
Math:
|
||||
^^^^^
|
||||
|
||||
.. doxygenfile:: math.h
|
||||
|
||||
|
||||
V0Curves:
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: V0Curves.h
|
||||
|
||||
V0Parameters:
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
.. doxygenfile:: V0Parameters.h
|
||||
|
||||
Error:
|
||||
^^^^^^
|
||||
|
||||
.. doxygenfile:: Error.h
|
||||
4
docs/cpp_api/support/client_parameters.rst
Normal file
4
docs/cpp_api/support/client_parameters.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
ClientParameters:
|
||||
===============
|
||||
|
||||
.. doxygenfile:: ClientParameters.h
|
||||
4
docs/cpp_api/support/compiler_engine.rst
Normal file
4
docs/cpp_api/support/compiler_engine.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
CompilerEngine:
|
||||
===============
|
||||
|
||||
.. doxygenfile:: zamalang/Support/CompilerEngine.h
|
||||
5
docs/cpp_api/support/jit.rst
Normal file
5
docs/cpp_api/support/jit.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
Jit:
|
||||
====
|
||||
|
||||
.. doxygenfile:: Jit.h
|
||||
.. doxygenfile:: JitCompilerEngine.h
|
||||
5
docs/cpp_api/support/key_set.rst
Normal file
5
docs/cpp_api/support/key_set.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
KeySet:
|
||||
=======
|
||||
|
||||
.. doxygenfile:: KeySet.h
|
||||
.. doxygenfile:: KeySetCache.h
|
||||
4
docs/cpp_api/support/lambda_argument.rst
Normal file
4
docs/cpp_api/support/lambda_argument.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
LambdaArgument:
|
||||
===============
|
||||
|
||||
.. doxygenfile:: LambdaArgument.h
|
||||
4
docs/cpp_api/support/llvm_emit_file.rst
Normal file
4
docs/cpp_api/support/llvm_emit_file.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
LLVMEmitFile:
|
||||
=============
|
||||
|
||||
.. doxygenfile:: LLVMEmitFile.h
|
||||
4
docs/cpp_api/support/pipeline.rst
Normal file
4
docs/cpp_api/support/pipeline.rst
Normal file
@@ -0,0 +1,4 @@
|
||||
Pipeline:
|
||||
=========
|
||||
|
||||
.. doxygenfile:: Pipeline.h
|
||||
Reference in New Issue
Block a user