github/concrete
1
1
Fork 0
mirror of https://github.com/zama-ai/concrete.git synced 2026-02-08 19:44:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): fix docs following the renaming

Browse Source
This commit is contained in:
Mayeul@Zama
2022-01-03 16:02:45 +01:00
committed by mayeul-zama
parent c276e13d97
commit a4e8227692
15 changed files with 47 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Doxyfile.in
View File

@@ -871,7 +871,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = "../compiler/include" "../compiler/build/tools/zamalang/include"
INPUT = "../compiler/include" "../compiler/build/tools/concretelang/include"
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

4
docs/Makefile
View File

@@ -2,8 +2,8 @@ doc:
cd ../compiler; make doc python-bindings
bash symlink_md.bash
bash symlink_py.bash
sphinx-apidoc -o python_api/ links_to_compiler_build/py/zamalang_core/zamalang -f
PYTHONPATH=links_to_compiler_build/py/zamalang_core sphinx-build -M html . _build
sphinx-apidoc -o python_api/ links_to_compiler_build/py/concretelang_core/concretelang -f
PYTHONPATH=links_to_compiler_build/py/concretelang_core sphinx-build -M html . _build
clean:
rm -rf _build/

36
docs/cpp_api/conversion.rst
View File

@@ -1,50 +1,50 @@
Conversion
==========
HLFHETensorOpsToLinalg:
FHETensorOpsToLinalg:
^^^^^^^^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/HLFHETensorOpsToLinalg/Pass.h
.. doxygenfile:: concretelang/Conversion/FHETensorOpsToLinalg/Pass.h
HLFHEToMidLFHE:
FHEToTFHE:
^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/HLFHEToMidLFHE/Patterns.h
.. doxygenfile:: concretelang/Conversion/FHEToTFHE/Patterns.h
.. doxygenfile:: zamalang/Conversion/HLFHEToMidLFHE/Pass.h
.. doxygenfile:: concretelang/Conversion/FHEToTFHE/Pass.h
MidLFHEGlobalParametrization:
TFHEGlobalParametrization:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/MidLFHEGlobalParametrization/Pass.h
.. doxygenfile:: concretelang/Conversion/TFHEGlobalParametrization/Pass.h
MidLFHEToLowLFHE:
TFHEToConcreteFHE:
^^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/MidLFHEToLowLFHE/Patterns.h
.. doxygenfile:: concretelang/Conversion/TFHEToConcrete/Patterns.h
.. doxygenfile:: zamalang/Conversion/MidLFHEToLowLFHE/Pass.h
.. doxygenfile:: concretelang/Conversion/TFHEToConcrete/Pass.h
LowLFHEToStd:
ConcreteToStd:
^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Conversion/LowLFHEToConcreteCAPI/Pass.h
.. doxygenfile:: concretelang/Conversion/ConcreteToConcreteCAPI/Pass.h
.. doxygenfile:: zamalang/Conversion/LowLFHEUnparametrize/Pass.h
.. doxygenfile:: concretelang/Conversion/ConcreteUnparametrize/Pass.h
.. doxygenfile:: zamalang/Conversion/MLIRLowerableDialectsToLLVM/Pass.h
.. doxygenfile:: concretelang/Conversion/MLIRLowerableDialectsToLLVM/Pass.h
Utils:
^^^^^^
.. doxygenfile:: zamalang/Conversion/Utils/TensorOpTypeConversion.h
.. doxygenfile:: concretelang/Conversion/Utils/TensorOpTypeConversion.h
.. doxygenfile:: zamalang/Conversion/Utils/LinalgGenericTypeConverterPattern.h
.. doxygenfile:: concretelang/Conversion/Utils/RegionOpTypeConverterPattern.h
.. doxygenfile:: zamalang/Conversion/Utils/GenericOpTypeConversionPattern.h
.. doxygenfile:: concretelang/Conversion/Utils/GenericOpTypeConversionPattern.h
.. doxygenfile:: zamalang/Conversion/Utils/GlobalFHEContext.h
.. doxygenfile:: concretelang/Conversion/Utils/GlobalFHEContext.h

2
docs/cpp_api/runtime/context.rst
View File

@@ -1,4 +1,4 @@
Context:
========
.. doxygenfile:: zamalang/Runtime/context.h
.. doxygenfile:: concretelang/Runtime/context.h

4
docs/cpp_api/runtime/dataflow_runtime.rst
View File

@@ -1,8 +1,8 @@
DataflowRuntime:
================
.. doxygenfile:: zamalang/Runtime/DFRuntime.hpp
.. doxygenfile:: concretelang/Runtime/DFRuntime.hpp
Debug interface:
^^^^^^^^^^^^^^^^
.. doxygenfile:: zamalang/Runtime/dfr_debug_interface.h
.. doxygenfile:: concretelang/Runtime/dfr_debug_interface.h

2
docs/cpp_api/runtime/distributed_generic_task_server.rst
View File

@@ -1,4 +1,4 @@
Distributed generic task server:
================================
.. doxygenfile:: zamalang/Runtime/distributed_generic_task_server.hpp
.. doxygenfile:: concretelang/Runtime/distributed_generic_task_server.hpp

2
docs/cpp_api/runtime/key_manager.rst
View File

@@ -1,4 +1,4 @@
Key Manager:
============
.. doxygenfile:: zamalang/Runtime/key_manager.hpp
.. doxygenfile:: concretelang/Runtime/key_manager.hpp

2
docs/cpp_api/runtime/runtime_api.rst
View File

@@ -1,4 +1,4 @@
Runtime API:
============
.. doxygenfile:: zamalang/Runtime/runtime_api.h
.. doxygenfile:: concretelang/Runtime/runtime_api.h

2
docs/cpp_api/runtime/wrappers.rst
View File

@@ -1,4 +1,4 @@
Wrappers:
=========
.. doxygenfile:: zamalang/Runtime/wrappers.h
.. doxygenfile:: concretelang/Runtime/wrappers.h

2
docs/cpp_api/support/compiler_engine.rst
View File

@@ -1,4 +1,4 @@
CompilerEngine:
===============
.. doxygenfile:: zamalang/Support/CompilerEngine.h
.. doxygenfile:: concretelang/Support/CompilerEngine.h

4
docs/dialects/concrete.md
View File

@@ -3,7 +3,7 @@
The concrete dialect maps to the [concrete library](https://github.com/zama-ai/concrete/).
[Types](../links_to_compiler_build/md/LowLFHETypes.md)
[Types](../links_to_compiler_build/md/ConcreteTypes.md)
[Operations](../links_to_compiler_build/md/LowLFHEOps.md)
[Operations](../links_to_compiler_build/md/ConcreteOps.md)

6
docs/dialects/fhe.md
View File

@@ -8,14 +8,14 @@ It allows to represent encrypted integers with a precision in bits.
## FHE Type
Only the last type is used (others come directly from mlir).
[Types](../links_to_compiler_build/md/HLFHETypes.md)
[Types](../links_to_compiler_build/md/FHETypes.md)
## FHE Operations
[Operations](../links_to_compiler_build/md/HLFHEOps.md)
[Operations](../links_to_compiler_build/md/FHEOps.md)
## Linalg FHE Operations
[Operations](../links_to_compiler_build/md/HLFHELinalgOps.md)
[Operations](../links_to_compiler_build/md/FHELinalgOps.md)

4
docs/dialects/tfhe.md
View File

@@ -6,9 +6,9 @@ The TFHE dialect allows to represent integers wencrypted with [LWE](https://en.w
## TFHE Type
Only the last types are used (others come directly from mlir).
[Types](../links_to_compiler_build/md/MidLFHETypes.md)
[Types](../links_to_compiler_build/md/TFHETypes.md)
## TFHE Operations
[Operations](../links_to_compiler_build/md/MidLFHEOps.md)
[Operations](../links_to_compiler_build/md/TFHEOps.md)

2
docs/symlink_md.bash
View File

@@ -4,7 +4,7 @@ mkdir -p links_to_compiler_build/md
cd links_to_compiler_build/md
yourfilenames=`find ../../../compiler/build/tools/zamalang/docs/zamalang -name "*.md"`
yourfilenames=`find ../../../compiler/build/tools/concretelang/docs/concretelang -name "*.md"`
for entry in $yourfilenames
do

19
docs/symlink_py.bash
View File

@@ -1,18 +1,19 @@
#!/bin/bash
mkdir -p links_to_compiler_build/py/zamalang_core
mkdir -p links_to_compiler_build/py/concretelang_core
cd links_to_compiler_build/py/zamalang_core
cd links_to_compiler_build/py/concretelang_core
ln -s ../../../../compiler/build/tools/zamalang/python_packages/zamalang_core/mlir
ln -s ../../../../compiler/build/tools/concretelang/python_packages/concretelang_core/mlir
mkdir zamalang
cd zamalang
mkdir -p concretelang
ln -s ../../../../../compiler/build/tools/zamalang/python_packages/zamalang_core/zamalang/dialects/_HLFHE_ops_gen.py hlfhe.py -f
ln -s ../../../../../compiler/build/tools/zamalang/python_packages/zamalang_core/zamalang/dialects/_HLFHELinalg_ops_gen.py hlfhelinalg.py -f
ln -s ../../../../../compiler/build/tools/zamalang/python_packages/zamalang_core/zamalang/dialects/_ods_common.py _ods_common.py -f
cd concretelang
ln -s ../../../../../compiler/build/tools/zamalang/python_packages/zamalang_core/zamalang/compiler.py compiler.py -f
ln -s ../../../../../compiler/build/tools/concretelang/python_packages/concretelang_core/concrete/lang/dialects/_FHE_ops_gen.py fhe.py -f
ln -s ../../../../../compiler/build/tools/concretelang/python_packages/concretelang_core/concrete/lang/dialects/_FHELinalg_ops_gen.py fhelinalg.py -f
ln -s ../../../../../compiler/build/tools/concretelang/python_packages/concretelang_core/concrete/lang/dialects/_ods_common.py _ods_common.py -f
ln -s ../../../../../compiler/build/tools/concretelang/python_packages/concretelang_core/concrete/compiler.py compiler.py -f
touch __init__.py