From 75a852713d86450d9ff7efe3fc4deba32fdc1256 Mon Sep 17 00:00:00 2001 From: youben11 Date: Mon, 28 Apr 2025 15:08:14 +0100 Subject: [PATCH] docs(frontend/python): update docs --- docs/dev/api/README.md | 2 + docs/dev/api/concrete.compiler.md | 86 +++++++++++++++++++++++++++++-- 2 files changed, 84 insertions(+), 4 deletions(-) diff --git a/docs/dev/api/README.md b/docs/dev/api/README.md index 128954829..d4153ba20 100644 --- a/docs/dev/api/README.md +++ b/docs/dev/api/README.md @@ -90,6 +90,8 @@ ## Classes +- [`compiler.KeysetRestrictionHandler`](./concrete.compiler.md): Handler to serialize and deserialize keyset restrictions +- [`compiler.RangeRestrictionHandler`](./concrete.compiler.md): Handler to serialize and deserialize range restrictions - [`compilation_context.CompilationContext`](./concrete.compiler.compilation_context.md): Compilation context. - [`compilation_feedback.MoreCircuitCompilationFeedback`](./concrete.compiler.compilation_feedback.md): Helper class for compilation feedback. - [`tfhers_int.TfhersExporter`](./concrete.compiler.tfhers_int.md): A helper class to import and export TFHErs big integers. diff --git a/docs/dev/api/concrete.compiler.md b/docs/dev/api/concrete.compiler.md index 795a420aa..98ea36a10 100644 --- a/docs/dev/api/concrete.compiler.md +++ b/docs/dev/api/concrete.compiler.md @@ -20,7 +20,7 @@ Compiler submodule. --- - + ## function `init_dfr` @@ -35,7 +35,7 @@ It is not always required to initialize the dataflow runtime as it can be implic --- - + ## function `check_gpu_enabled` @@ -50,7 +50,7 @@ GPU offloading is not always available, in particular in non-GPU wheels. --- - + ## function `check_gpu_available` @@ -63,7 +63,7 @@ Check whether a CUDA device is available and online. --- - + ## function `round_trip` @@ -94,3 +94,81 @@ Useful to check the validity of an MLIR representation - `str`: textual representation of the MLIR code after parsing +--- + + + +## class `RangeRestrictionHandler` +Handler to serialize and deserialize range restrictions + + + + +--- + + + +### method `flatten` + +```python +flatten(obj, data) +``` + + + + + +--- + + + +### method `restore` + +```python +restore(obj) +``` + + + + + + +--- + + + +## class `KeysetRestrictionHandler` +Handler to serialize and deserialize keyset restrictions + + + + +--- + + + +### method `flatten` + +```python +flatten(obj, data) +``` + + + + + +--- + + + +### method `restore` + +```python +restore(obj) +``` + + + + + +