github/concrete
1
1
Fork 0
mirror of https://github.com/zama-ai/concrete.git synced 2026-01-09 12:57:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore(frontend/py): update docs

Browse Source
This commit is contained in:
youben11
2025-04-30 10:20:28 +01:00
parent 9d35957974
commit 8c5a672a44
38 changed files with 698 additions and 700 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/dev/api/concrete.fhe.compilation.artifacts.md
View File

@@ -292,7 +292,7 @@ An object containing debug artifacts for an fhe module.
```python
__init__(
function_names: Optional[List[str]] = None,
function_names: Optional[list[str]] = None,
output_directory: Union[str, Path] = PosixPath('.artifacts')
)
```

14
docs/dev/api/concrete.fhe.compilation.circuit.md
View File

@@ -337,8 +337,8 @@ Cleanup the temporary library output directory.
```python
decrypt(
*results: Union[Value, Tuple[Value, ]]
) → Union[int, ndarray, Tuple[Union[int, ndarray, NoneType], ], NoneType]
*results: Union[Value, tuple[Value, ]]
) → Union[int, ndarray, tuple[Union[int, ndarray, NoneType], ], NoneType]
```
Decrypt result(s) of evaluation.
@@ -419,8 +419,8 @@ Enable FHE simulation.
```python
encrypt(
*args: Optional[int, ndarray, List]
) → Union[Value, Tuple[Optional[Value], ], NoneType]
*args: Optional[int, ndarray, list]
) → Union[Value, tuple[Optional[Value], ], NoneType]
```
Encrypt argument(s) to for evaluation.
@@ -468,7 +468,7 @@ keygen(
force: bool = False,
seed: Optional[int] = None,
encryption_seed: Optional[int] = None,
initial_keys: Optional[Dict[int, LweSecretKey]] = None
initial_keys: Optional[dict[int, LweSecretKey]] = None
)
```
@@ -493,8 +493,8 @@ Generate keys required for homomorphic evaluation.
```python
run(
*args: Optional[Value, Tuple[Optional[Value], ]]
) → Union[Value, Tuple[Value, ]]
*args: Optional[Value, tuple[Optional[Value], ]]
) → Union[Value, tuple[Value, ]]
```
Evaluate the circuit.

18
docs/dev/api/concrete.fhe.compilation.client.md
View File

@@ -64,9 +64,9 @@ Get the client specs for the client.
```python
decrypt(
*results: Union[Value, Tuple[Value, ]],
*results: Union[Value, tuple[Value, ]],
function_name: Optional[str] = None
) → Union[int, ndarray, Tuple[Union[int, ndarray, NoneType], ], NoneType]
) → Union[int, ndarray, tuple[Union[int, ndarray, NoneType], ], NoneType]
```
Decrypt result(s) of evaluation.
@@ -89,9 +89,9 @@ Decrypt result(s) of evaluation.
```python
encrypt(
*args: Optional[int, ndarray, List],
*args: Optional[int, ndarray, list],
function_name: Optional[str] = None
) → Union[Value, Tuple[Optional[Value], ], NoneType]
) → Union[Value, tuple[Optional[Value], ], NoneType]
```
Encrypt argument(s) to for evaluation.
@@ -117,7 +117,7 @@ keygen(
force: bool = False,
secret_seed: Optional[int] = None,
encryption_seed: Optional[int] = None,
initial_keys: Optional[Dict[int, LweSecretKey]] = None
initial_keys: Optional[dict[int, LweSecretKey]] = None
)
```
@@ -189,9 +189,9 @@ Save the client into the given path in zip format.
```python
simulate_decrypt(
*results: Union[Value, Tuple[Value, ]],
*results: Union[Value, tuple[Value, ]],
function_name: Optional[str] = None
) → Union[int, ndarray, Tuple[Union[int, ndarray, NoneType], ], NoneType]
) → Union[int, ndarray, tuple[Union[int, ndarray, NoneType], ], NoneType]
```
Simulate decryption of result(s) of evaluation.
@@ -214,9 +214,9 @@ Simulate decryption of result(s) of evaluation.
```python
simulate_encrypt(
*args: Optional[int, ndarray, List],
*args: Optional[int, ndarray, list],
function_name: Optional[str] = None
) → Union[Value, Tuple[Optional[Value], ], NoneType]
) → Union[Value, tuple[Optional[Value], ], NoneType]
```
Simulate encryption of argument(s) for evaluation.

20
docs/dev/api/concrete.fhe.compilation.compiler.md
View File

@@ -9,19 +9,19 @@ Declaration of `Compiler` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L25"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Compiler`
Compiler class, to glue the compilation pipeline.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L85"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L86"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(
function: Callable,
parameter_encryption_statuses: Dict[str, Union[str, EncryptionStatus]],
parameter_encryption_statuses: dict[str, Union[str, EncryptionStatus]],
composition: Optional[NotComposable, AllComposable] = None
)
```
@@ -35,14 +35,14 @@ __init__(
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `assemble`
```python
assemble(
function: Callable,
parameter_values: Dict[str, ValueDescription],
parameter_values: dict[str, ValueDescription],
configuration: Optional[Configuration] = None,
artifacts: Optional[DebugArtifacts] = None,
**kwargs
@@ -71,13 +71,13 @@ Assemble a circuit from the raw parameter values, used in direct circuit definit
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L164"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L165"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `compile`
```python
compile(
inputset: Optional[Iterable[Any], Iterable[Tuple[Any, ]]] = None,
inputset: Optional[Iterable[Any], Iterable[tuple[Any, ]]] = None,
configuration: Optional[Configuration] = None,
artifacts: Optional[DebugArtifacts] = None,
**kwargs
@@ -104,7 +104,7 @@ Compile the function using an inputset.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L210"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L211"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `reset`
@@ -116,13 +116,13 @@ Reset the compiler so that another compilation with another inputset can be perf
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L118"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/compiler.py#L119"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `trace`
```python
trace(
inputset: Optional[Iterable[Any], Iterable[Tuple[Any, ]]] = None,
inputset: Optional[Iterable[Any], Iterable[tuple[Any, ]]] = None,
configuration: Optional[Configuration] = None,
artifacts: Optional[DebugArtifacts] = None,
**kwargs

18
docs/dev/api/concrete.fhe.compilation.composition.md
View File

@@ -9,7 +9,7 @@ Declaration of classes related to composition.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L12"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L13"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `CompositionClause`
A raw composition clause.
@@ -19,12 +19,12 @@ A raw composition clause.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L20"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L21"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `create`
```python
create(tup: Tuple[str, int]) → CompositionClause
create(tup: tuple[str, int]) → CompositionClause
```
Create a composition clause from a tuple of a function name and a position.
@@ -32,7 +32,7 @@ Create a composition clause from a tuple of a function name and a position.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L28"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L29"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `CompositionRule`
A raw composition rule.
@@ -42,12 +42,12 @@ A raw composition rule.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L36"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L37"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `create`
```python
create(tup: Tuple[CompositionClause, CompositionClause]) → CompositionRule
create(tup: tuple[CompositionClause, CompositionClause]) → CompositionRule
```
Create a composition rule from a tuple containing an output clause and an input clause.
@@ -55,7 +55,7 @@ Create a composition rule from a tuple containing an output clause and an input
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L44"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L45"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `CompositionPolicy`
A protocol for composition policies.
@@ -65,12 +65,12 @@ A protocol for composition policies.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L50"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/composition.py#L51"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_rules_iter`
```python
get_rules_iter(funcs: List[Graph]) → Iterable[CompositionRule]
get_rules_iter(funcs: list[Graph]) → Iterable[CompositionRule]
```
Return an iterator over composition rules.

48
docs/dev/api/concrete.fhe.compilation.configuration.md
View File

@@ -14,7 +14,7 @@ Declaration of `Configuration` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L25"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L30"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `SecurityLevel`
Security level used to optimize the circuit parameters.
@@ -25,7 +25,7 @@ Security level used to optimize the circuit parameters.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L39"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `ParameterSelectionStrategy`
ParameterSelectionStrategy, to set optimization strategy.
@@ -36,7 +36,7 @@ ParameterSelectionStrategy, to set optimization strategy.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L61"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L66"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `MultiParameterStrategy`
MultiParamStrategy, to set optimization strategy for multi-parameter.
@@ -47,7 +47,7 @@ MultiParamStrategy, to set optimization strategy for multi-parameter.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L87"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L92"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Exactness`
Exactness, to specify for specific operator the implementation preference (default and local).
@@ -58,7 +58,7 @@ Exactness, to specify for specific operator the implementation preference (defau
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L96"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L101"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `ApproximateRoundingConfig`
Controls the behavior of approximate rounding.
@@ -88,7 +88,7 @@ __init__(
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L135"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L140"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `ComparisonStrategy`
ComparisonStrategy, to specify implementation preference for comparisons.
@@ -99,7 +99,7 @@ ComparisonStrategy, to specify implementation preference for comparisons.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L507"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L512"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `BitwiseStrategy`
BitwiseStrategy, to specify implementation preference for bitwise operations.
@@ -110,7 +110,7 @@ BitwiseStrategy, to specify implementation preference for bitwise operations.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L705"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L710"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `MultivariateStrategy`
MultivariateStrategy, to specify implementation preference for multivariate operations.
@@ -121,7 +121,7 @@ MultivariateStrategy, to specify implementation preference for multivariate oper
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L814"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L819"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `MinMaxStrategy`
MinMaxStrategy, to specify implementation preference for minimum and maximum operations.
@@ -132,12 +132,12 @@ MinMaxStrategy, to specify implementation preference for minimum and maximum ope
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L949"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L954"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Configuration`
Configuration class, to allow the compilation process to be customized.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L1013"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L1018"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -174,18 +174,18 @@ __init__(
fhe_execution: bool = True,
compiler_debug_mode: bool = False,
compiler_verbose_mode: bool = False,
comparison_strategy_preference: Optional[ComparisonStrategy, str, List[Union[ComparisonStrategy, str]]] = None,
bitwise_strategy_preference: Optional[BitwiseStrategy, str, List[Union[BitwiseStrategy, str]]] = None,
comparison_strategy_preference: Optional[ComparisonStrategy, str, list[Union[ComparisonStrategy, str]]] = None,
bitwise_strategy_preference: Optional[BitwiseStrategy, str, list[Union[BitwiseStrategy, str]]] = None,
shifts_with_promotion: bool = True,
multivariate_strategy_preference: Optional[MultivariateStrategy, str, List[Union[MultivariateStrategy, str]]] = None,
min_max_strategy_preference: Optional[MinMaxStrategy, str, List[Union[MinMaxStrategy, str]]] = None,
multivariate_strategy_preference: Optional[MultivariateStrategy, str, list[Union[MultivariateStrategy, str]]] = None,
min_max_strategy_preference: Optional[MinMaxStrategy, str, list[Union[MinMaxStrategy, str]]] = None,
composable: bool = False,
use_gpu: bool = False,
relu_on_bits_threshold: int = 7,
relu_on_bits_chunk_size: int = 3,
if_then_else_chunk_size: int = 3,
additional_pre_processors: Optional[List[GraphProcessor]] = None,
additional_post_processors: Optional[List[GraphProcessor]] = None,
additional_pre_processors: Optional[list[GraphProcessor]] = None,
additional_post_processors: Optional[list[GraphProcessor]] = None,
rounding_exactness: Exactness = <Exactness.EXACT: 'exact'>,
approximate_rounding_config: Optional[ApproximateRoundingConfig] = None,
optimize_tlu_based_on_measured_bounds: bool = False,
@@ -213,7 +213,7 @@ __init__(
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L1208"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/configuration.py#L1213"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `fork`
@@ -250,18 +250,18 @@ fork(
fhe_execution: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
compiler_debug_mode: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
compiler_verbose_mode: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
comparison_strategy_preference: Optional[Keep, ComparisonStrategy, str, List[Union[ComparisonStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
bitwise_strategy_preference: Optional[Keep, BitwiseStrategy, str, List[Union[BitwiseStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
comparison_strategy_preference: Optional[Keep, ComparisonStrategy, str, list[Union[ComparisonStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
bitwise_strategy_preference: Optional[Keep, BitwiseStrategy, str, list[Union[BitwiseStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
shifts_with_promotion: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
multivariate_strategy_preference: Optional[Keep, MultivariateStrategy, str, List[Union[MultivariateStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
min_max_strategy_preference: Optional[Keep, MinMaxStrategy, str, List[Union[MinMaxStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
multivariate_strategy_preference: Optional[Keep, MultivariateStrategy, str, list[Union[MultivariateStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
min_max_strategy_preference: Optional[Keep, MinMaxStrategy, str, list[Union[MinMaxStrategy, str]]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
composable: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
use_gpu: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
relu_on_bits_threshold: Union[Keep, int] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
relu_on_bits_chunk_size: Union[Keep, int] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
if_then_else_chunk_size: Union[Keep, int] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
additional_pre_processors: Optional[Keep, List[GraphProcessor]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
additional_post_processors: Optional[Keep, List[GraphProcessor]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
additional_pre_processors: Optional[Keep, list[GraphProcessor]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
additional_post_processors: Optional[Keep, list[GraphProcessor]] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
rounding_exactness: Union[Keep, Exactness] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
approximate_rounding_config: Optional[Keep, ApproximateRoundingConfig] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,
optimize_tlu_based_on_measured_bounds: Union[Keep, bool] = <concrete.fhe.compilation.configuration.Configuration.Keep object at ADDRESS>,

24
docs/dev/api/concrete.fhe.compilation.decorators.md
View File

@@ -8,7 +8,7 @@ Declaration of `circuit` and `compiler` decorators.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L22"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L23"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `circuit`
@@ -37,7 +37,7 @@ Provide a direct interface for compilation of single circuit programs.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L168"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L169"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `compiler`
@@ -55,7 +55,7 @@ Provide an easy interface for the compilation of single-circuit programs.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L183"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L184"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `module`
@@ -68,12 +68,12 @@ Provide an easy interface for the compilation of multi functions modules.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L200"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L201"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `function`
```python
function(parameters: Dict[str, Union[str, EncryptionStatus]])
function(parameters: dict[str, Union[str, EncryptionStatus]])
```
Provide an easy interface to define a function within an fhe module.
@@ -86,12 +86,12 @@ Provide an easy interface to define a function within an fhe module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L82"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L83"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Compilable`
Compilable class, to wrap a function and provide methods to trace and compile it.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L90"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L91"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -108,13 +108,13 @@ __init__(function_: Callable, parameters)
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L128"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L129"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `compile`
```python
compile(
inputset: Optional[Iterable[Any], Iterable[Tuple[Any, ]]] = None,
inputset: Optional[Iterable[Any], Iterable[tuple[Any, ]]] = None,
configuration: Optional[Configuration] = None,
artifacts: Optional[DebugArtifacts] = None,
**kwargs
@@ -141,7 +141,7 @@ Compile the function into a circuit.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L160"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L161"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `reset`
@@ -153,13 +153,13 @@ Reset the compilable so that another compilation with another inputset can be pe
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L98"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/decorators.py#L99"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `trace`
```python
trace(
inputset: Optional[Iterable[Any], Iterable[Tuple[Any, ]]] = None,
inputset: Optional[Iterable[Any], Iterable[tuple[Any, ]]] = None,
configuration: Optional[Configuration] = None,
artifacts: Optional[DebugArtifacts] = None,
**kwargs

2
docs/dev/api/concrete.fhe.compilation.keys.md
View File

@@ -87,7 +87,7 @@ generate(
force: bool = False,
secret_seed: Optional[int] = None,
encryption_seed: Optional[int] = None,
initial_keys: Optional[Dict[int, LweSecretKey]] = None
initial_keys: Optional[dict[int, LweSecretKey]] = None
)
```

62
docs/dev/api/concrete.fhe.compilation.module.md
View File

@@ -9,12 +9,12 @@ Declaration of `FheModule` classes.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L32"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `ExecutionRt`
Runtime object class for execution.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L43"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L44"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -32,7 +32,7 @@ __init__(client, server, auto_schedule_run)
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L67"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L68"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `SimulationRt`
Runtime object class for simulation.
@@ -43,12 +43,12 @@ Runtime object class for simulation.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L76"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L77"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `FheFunction`
Fhe function class, allowing to run or simulate one function of an fhe module.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L87"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L88"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -257,14 +257,14 @@ Get all statistics of the function.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L334"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L336"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `decrypt`
```python
decrypt(
*results: Union[Value, Tuple[Value, ], Awaitable[Union[Value, Tuple[Value, ]]]]
) → Union[int, ndarray, Tuple[Union[int, ndarray, NoneType], ], NoneType]
*results: Union[Value, tuple[Value, ], Awaitable[Union[Value, tuple[Value, ]]]]
) → Union[int, ndarray, tuple[Union[int, ndarray, NoneType], ], NoneType]
```
Decrypt result(s) of evaluation.
@@ -281,7 +281,7 @@ Decrypt result(s) of evaluation.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L113"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L114"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `draw`
@@ -315,14 +315,14 @@ That this function requires the python `pygraphviz` package which itself require
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L191"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L192"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypt`
```python
encrypt(
*args: Optional[int, ndarray, List]
) → Union[Value, Tuple[Optional[Value], ], NoneType]
*args: Optional[int, ndarray, list]
) → Union[Value, tuple[Optional[Value], ], NoneType]
```
Encrypt argument(s) to for evaluation.
@@ -339,7 +339,7 @@ Encrypt argument(s) to for evaluation.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L356"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L358"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypt_run_decrypt`
@@ -361,14 +361,14 @@ Encrypt inputs, run the function, and decrypt the outputs in one go.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L254"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L255"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `run`
```python
run(
*args: Optional[Value, Tuple[Optional[Value], ]]
) → Union[Value, Tuple[Value, ], Awaitable[Union[Value, Tuple[Value, ]]]]
*args: Optional[Value, tuple[Optional[Value], ]]
) → Union[Value, tuple[Value, ], Awaitable[Union[Value, tuple[Value, ]]]]
```
Evaluate the function.
@@ -381,18 +381,18 @@ Evaluate the function.
**Returns:**
Union[Value, Tuple[Value, ...], Awaitable[Union[Value, Tuple[Value, ...]]]]: result(s) of evaluation or future of result(s) of evaluation if configured with async_run=True
Union[Value, Tuple[Value, ...], Awaitable[Union[Value, Tuple[Value, ...]]]]: result(s) of evaluation or future of result(s) of evaluation if configured with async_run=True
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L229"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L230"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `run_async`
```python
run_async(
*args: Optional[Value, Tuple[Optional[Value], ]]
) → Union[Value, Tuple[Value, ], Awaitable[Union[Value, Tuple[Value, ]]]]
*args: Optional[Value, tuple[Optional[Value], ]]
) → Union[Value, tuple[Value, ], Awaitable[Union[Value, tuple[Value, ]]]]
```
Evaluate the function asynchronuously.
@@ -409,12 +409,12 @@ Evaluate the function asynchronuously.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L211"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L212"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `run_sync`
```python
run_sync(*args: Optional[Value, Tuple[Optional[Value], ]]) → Any
run_sync(*args: Optional[Value, tuple[Optional[Value], ]]) → Any
```
Evaluate the function synchronuously.
@@ -431,7 +431,7 @@ Evaluate the function synchronuously.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L176"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L177"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `simulate`
@@ -454,18 +454,18 @@ Simulate execution of the function.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L698"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L700"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `FheModule`
Fhe module class, to combine computation graphs, mlir, runtime objects into a single object.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L710"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L712"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(
graphs: Dict[str, Graph],
graphs: dict[str, Graph],
mlir: Module,
compilation_context: CompilationContext,
configuration: Optional[Configuration] = None,
@@ -566,7 +566,7 @@ Get all statistics of the module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L814"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L816"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `cleanup`
@@ -578,19 +578,19 @@ Cleanup the temporary library output directory.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L885"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L887"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `functions`
```python
functions() → Dict[str, FheFunction]
functions() → dict[str, FheFunction]
```
Return a dictionnary containing all the functions of the module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L789"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module.py#L791"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `keygen`
@@ -599,7 +599,7 @@ keygen(
force: bool = False,
seed: Optional[int] = None,
encryption_seed: Optional[int] = None,
initial_keys: Optional[Dict[int, LweSecretKey]] = None
initial_keys: Optional[dict[int, LweSecretKey]] = None
)
```

28
docs/dev/api/concrete.fhe.compilation.module_compiler.md
View File

@@ -9,19 +9,19 @@ Declaration of `MultiCompiler` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `FunctionDef`
An object representing the definition of a function as used in an fhe module.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L48"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L49"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(
function: Callable,
parameter_encryption_statuses: Dict[str, Union[str, EncryptionStatus]]
parameter_encryption_statuses: dict[str, Union[str, EncryptionStatus]]
)
```
@@ -40,14 +40,14 @@ Return the name of the function.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L152"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L153"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `evaluate`
```python
evaluate(
action: str,
inputset: Optional[Iterable[Any], Iterable[Tuple[Any, ]]],
inputset: Optional[Iterable[Any], Iterable[tuple[Any, ]]],
configuration: Configuration,
artifacts: FunctionDebugArtifacts
)
@@ -68,13 +68,13 @@ Trace, fuse, measure bounds, and update values in the resulting graph in one go.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L114"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L115"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `trace`
```python
trace(
sample: Union[Any, Tuple[Any, ]],
sample: Union[Any, tuple[Any, ]],
artifacts: Optional[FunctionDebugArtifacts] = None
)
```
@@ -90,17 +90,17 @@ Trace the function and fuse the resulting graph with a sample input.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L330"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L331"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `ModuleCompiler`
Compiler class for multiple functions, to glue the compilation pipeline.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L340"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L341"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(functions: List[FunctionDef], composition: CompositionPolicy)
__init__(functions: list[FunctionDef], composition: CompositionPolicy)
```
@@ -112,13 +112,13 @@ __init__(functions: List[FunctionDef], composition: CompositionPolicy)
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L356"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L357"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `compile`
```python
compile(
inputsets: Optional[Dict[str, Optional[Iterable[Any], Iterable[Tuple[Any, ]]]]] = None,
inputsets: Optional[dict[str, Optional[Iterable[Any], Iterable[tuple[Any, ]]]]] = None,
configuration: Optional[Configuration] = None,
module_artifacts: Optional[ModuleDebugArtifacts] = None,
**kwargs
@@ -145,12 +145,12 @@ Compile the module using an ensemble of inputsets.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L349"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/module_compiler.py#L350"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `wire_pipeline`
```python
wire_pipeline(inputset: Union[Iterable[Any], Iterable[Tuple[Any, ]]])
wire_pipeline(inputset: Union[Iterable[Any], Iterable[tuple[Any, ]]])
```
Return a context manager that traces wires automatically.

126
docs/dev/api/concrete.fhe.compilation.server.md
View File

@@ -13,12 +13,12 @@ Declaration of `Server` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L54"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L55"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Server`
Server class, which can be used to perform homomorphic computation.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L66"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L67"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -26,7 +26,7 @@ Server class, which can be used to perform homomorphic computation.
__init__(
library: Library,
is_simulated: bool,
composition_rules: Optional[List[CompositionRule]],
composition_rules: Optional[list[CompositionRule]],
tfhers_specs: Optional[TFHERSClientSpecs] = None
)
```
@@ -88,7 +88,7 @@ Get size of the secret keys of the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L472"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L473"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `cleanup`
@@ -100,7 +100,7 @@ Cleanup the temporary library output directory.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L693"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L694"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_addition_count`
@@ -112,47 +112,47 @@ Get the number of clear additions in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L702"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L703"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_addition_count_per_parameter`
```python
clear_addition_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of clear additions per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L713"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L714"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_addition_count_per_tag`
```python
clear_addition_count_per_tag(function: str) → Dict[str, int]
clear_addition_count_per_tag(function: str) → dict[str, int]
```
Get the number of clear additions per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L722"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L723"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_addition_count_per_tag_per_parameter`
```python
clear_addition_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of clear additions per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L781"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L782"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_multiplication_count`
@@ -164,47 +164,47 @@ Get the number of clear multiplications in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L790"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L791"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_multiplication_count_per_parameter`
```python
clear_multiplication_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of clear multiplications per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L801"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L802"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_multiplication_count_per_tag`
```python
clear_multiplication_count_per_tag(function: str) → Dict[str, int]
clear_multiplication_count_per_tag(function: str) → dict[str, int]
```
Get the number of clear multiplications per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L810"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L811"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `clear_multiplication_count_per_tag_per_parameter`
```python
clear_multiplication_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of clear multiplications per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L86"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L87"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `create`
@@ -238,7 +238,7 @@ Create a server using MLIR and output sign information.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L737"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L738"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_addition_count`
@@ -250,47 +250,47 @@ Get the number of encrypted additions in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L746"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L747"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_addition_count_per_parameter`
```python
encrypted_addition_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of encrypted additions per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L757"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L758"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_addition_count_per_tag`
```python
encrypted_addition_count_per_tag(function: str) → Dict[str, int]
encrypted_addition_count_per_tag(function: str) → dict[str, int]
```
Get the number of encrypted additions per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L766"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L767"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_addition_count_per_tag_per_parameter`
```python
encrypted_addition_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of encrypted additions per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L825"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L826"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_negation_count`
@@ -302,47 +302,47 @@ Get the number of encrypted negations in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L834"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L835"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_negation_count_per_parameter`
```python
encrypted_negation_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of encrypted negations per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L845"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L846"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_negation_count_per_tag`
```python
encrypted_negation_count_per_tag(function: str) → Dict[str, int]
encrypted_negation_count_per_tag(function: str) → dict[str, int]
```
Get the number of encrypted negations per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L854"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L855"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypted_negation_count_per_tag_per_parameter`
```python
encrypted_negation_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of encrypted negations per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L605"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L606"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `key_switch_count`
@@ -354,47 +354,47 @@ Get the number of key switches in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L614"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L615"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `key_switch_count_per_parameter`
```python
key_switch_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of key switches per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L625"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L626"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `key_switch_count_per_tag`
```python
key_switch_count_per_tag(function: str) → Dict[str, int]
key_switch_count_per_tag(function: str) → dict[str, int]
```
Get the number of key switches per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L634"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L635"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `key_switch_count_per_tag_per_parameter`
```python
key_switch_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of key switches per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L305"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L306"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `load`
@@ -418,19 +418,19 @@ Load the server from the given path in zip format.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L529"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L530"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `memory_usage_per_location`
```python
memory_usage_per_location(function: str) → Dict[str, Optional[int]]
memory_usage_per_location(function: str) → dict[str, Optional[int]]
```
Get the memory usage of operations per location.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L649"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L650"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `packing_key_switch_count`
@@ -442,47 +442,47 @@ Get the number of packing key switches in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L658"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L659"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `packing_key_switch_count_per_parameter`
```python
packing_key_switch_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of packing key switches per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L669"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L670"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `packing_key_switch_count_per_tag`
```python
packing_key_switch_count_per_tag(function: str) → Dict[str, int]
packing_key_switch_count_per_tag(function: str) → dict[str, int]
```
Get the number of packing key switches per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L678"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L679"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `packing_key_switch_count_per_tag_per_parameter`
```python
packing_key_switch_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of packing key switches per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L561"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L562"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `programmable_bootstrap_count`
@@ -494,56 +494,56 @@ Get the number of programmable bootstraps in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L570"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L571"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `programmable_bootstrap_count_per_parameter`
```python
programmable_bootstrap_count_per_parameter(
function: str
) → Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
) → dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]
```
Get the number of programmable bootstraps per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L581"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L582"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `programmable_bootstrap_count_per_tag`
```python
programmable_bootstrap_count_per_tag(function: str) → Dict[str, int]
programmable_bootstrap_count_per_tag(function: str) → dict[str, int]
```
Get the number of programmable bootstraps per tag in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L590"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L591"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `programmable_bootstrap_count_per_tag_per_parameter`
```python
programmable_bootstrap_count_per_tag_per_parameter(
function: str
) → Dict[str, Dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
) → dict[str, dict[Union[LweSecretKeyParam, BootstrapKeyParam, KeyswitchKeyParam, PackingKeyswitchKeyParam], int]]
```
Get the number of programmable bootstraps per tag per parameter in the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L378"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L379"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `run`
```python
run(
*args: Optional[Value, Tuple[Optional[Value], ]],
*args: Optional[Value, tuple[Optional[Value], ]],
evaluation_keys: Optional[EvaluationKeys] = None,
function_name: Optional[str] = None
) → Union[Value, Tuple[Value, ]]
) → Union[Value, tuple[Value, ]]
```
Evaluate.
@@ -564,7 +564,7 @@ Evaluate.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L244"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L245"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `save`
@@ -583,7 +583,7 @@ Save the server into the given path in zip format.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L539"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L540"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `size_of_inputs`
@@ -595,7 +595,7 @@ Get size of the inputs of the compiled program.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L549"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L550"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `size_of_outputs`

70
docs/dev/api/concrete.fhe.compilation.utils.md
View File

@@ -11,7 +11,7 @@ Declaration of various functions and constants related to compilation.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L77"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L65"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `inputset`
@@ -19,7 +19,7 @@ Declaration of various functions and constants related to compilation.
inputset(
*inputs: Union[ScalarAnnotation, ValueDescription, Callable[[int], Any]],
size: int = 100
) → List[Tuple[Any, ]]
) → list[tuple[Any, ]]
```
Generate a random inputset.
@@ -39,16 +39,16 @@ Generate a random inputset.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L121"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L109"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `validate_input_args`
```python
validate_input_args(
client_specs: ClientSpecs,
*args: Optional[int, ndarray, List],
*args: Optional[int, ndarray, list],
function_name: str
) → List[Union[int, ndarray, NoneType]]
) → list[Union[int, ndarray, NoneType]]
```
Validate input arguments.
@@ -68,7 +68,7 @@ Validate input arguments.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L220"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L208"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `fuse`
@@ -96,15 +96,15 @@ Fuse appropriate subgraphs in a graph to a single Operation.Generic node.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L300"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L288"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `find_float_subgraph_with_unique_terminal_node`
```python
find_float_subgraph_with_unique_terminal_node(
graph: Graph,
processed_terminal_nodes: Set[Node]
) → Optional[Tuple[Dict[Node, NoneType], Dict[Node, NoneType], Node]]
processed_terminal_nodes: set[Node]
) → Optional[tuple[dict[Node, None], dict[Node, None], Node]]
```
Find a subgraph with float computations that end with an integer output.
@@ -124,15 +124,15 @@ Find a subgraph with float computations that end with an integer output.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L376"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L364"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `find_tlu_subgraph_with_multiple_variable_inputs_that_has_a_single_common_ancestor`
```python
find_tlu_subgraph_with_multiple_variable_inputs_that_has_a_single_common_ancestor(
graph: Graph,
processed_terminal_nodes: Set[Node]
) → Optional[Tuple[Dict[Node, NoneType], Dict[Node, NoneType], Node]]
processed_terminal_nodes: set[Node]
) → Optional[tuple[dict[Node, None], dict[Node, None], Node]]
```
Find a subgraph with a tlu computation that has multiple variable inputs where all variable inputs share a common ancestor.
@@ -152,12 +152,12 @@ Find a subgraph with a tlu computation that has multiple variable inputs whe
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L455"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L443"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `find_single_lca`
```python
find_single_lca(graph: Graph, nodes: List[Node]) → Optional[Node]
find_single_lca(graph: Graph, nodes: list[Node]) → Optional[Node]
```
Find the single lowest common ancestor of a list of nodes.
@@ -174,7 +174,7 @@ Returns Optional[Node]: single lca if it exists, None otherwise
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L505"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L493"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `is_single_common_ancestor`
@@ -182,7 +182,7 @@ Returns Optional[Node]: single lca if it exists, None otherwise
is_single_common_ancestor(
graph: Graph,
candidate: Node,
nodes: List[Node]
nodes: list[Node]
) → bool
```
@@ -204,16 +204,16 @@ Returns bool: True if `candidate` is a single common ancestor of `nodes`, Fals
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L636"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L624"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `find_closest_integer_output_nodes`
```python
find_closest_integer_output_nodes(
graph: Graph,
start_nodes: List[Node],
all_nodes: Dict[Node, NoneType]
) → Tuple[Dict[Node, NoneType], Dict[Node, NoneType]]
start_nodes: list[Node],
all_nodes: dict[Node, None]
) → tuple[dict[Node, None], dict[Node, None]]
```
Find the closest upstream integer output nodes to a set of start nodes in a graph.
@@ -235,7 +235,7 @@ Find the closest upstream integer output nodes to a set of start nodes in a grap
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L683"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L671"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `add_nodes_from_to`
@@ -243,9 +243,9 @@ Find the closest upstream integer output nodes to a set of start nodes in a grap
add_nodes_from_to(
graph: Graph,
from_nodes: Iterable[Node],
to_nodes: Dict[Node, NoneType],
all_nodes: Dict[Node, NoneType]
) → Dict[Node, NoneType]
to_nodes: dict[Node, None],
all_nodes: dict[Node, None]
) → dict[Node, None]
```
Add nodes from `from_nodes` to `to_nodes`, to `all_nodes`.
@@ -269,17 +269,17 @@ Add nodes from `from_nodes` to `to_nodes`, to `all_nodes`.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L731"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L719"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `convert_subgraph_to_subgraph_node`
```python
convert_subgraph_to_subgraph_node(
graph: Graph,
all_nodes: Dict[Node, NoneType],
start_nodes: Dict[Node, NoneType],
all_nodes: dict[Node, None],
start_nodes: dict[Node, None],
terminal_node: Node
) → Optional[Tuple[Node, Node]]
) → Optional[tuple[Node, Node]]
```
Convert a subgraph to Operation.Generic node.
@@ -308,14 +308,14 @@ Convert a subgraph to Operation.Generic node.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L842"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L830"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `check_subgraph_fusibility`
```python
check_subgraph_fusibility(
graph: Graph,
all_nodes: Dict[Node, NoneType],
all_nodes: dict[Node, None],
variable_input_node: Node
)
```
@@ -343,7 +343,7 @@ shuffling or reshaping a tensor make fusing impossible as there should be a one-
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L903"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L891"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `friendly_type_format`
@@ -356,7 +356,7 @@ Convert a type to a string. Remove package name and class/type keywords.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L921"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L909"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `get_terminal_size`
@@ -369,14 +369,14 @@ Get the terminal size.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L29"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Lazy`
A lazyly initialized value.
Allows to prevent executing a costly initialization if the value is not used afterward.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L48"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L36"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -405,7 +405,7 @@ Initializes the value if needed, and returns it.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L53"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/utils.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `init`

58
docs/dev/api/concrete.fhe.compilation.wiring.md
View File

@@ -12,7 +12,7 @@ Declaration of wiring related class.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L27"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L18"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `NotComposable`
Composition policy that does not allow the forwarding of any output to any input.
@@ -22,14 +22,12 @@ Composition policy that does not allow the forwarding of any output to any input
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L32"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L23"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_rules_iter`
```python
get_rules_iter(
_funcs: List[ForwardRef('FunctionDef')]
) → Iterable[CompositionRule]
get_rules_iter(_funcs: list['FunctionDef']) → Iterable[CompositionRule]
```
Return an iterator over composition rules.
@@ -37,7 +35,7 @@ Return an iterator over composition rules.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L39"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L30"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AllComposable`
Composition policy that allows to forward any output of the module to any of its input.
@@ -47,12 +45,12 @@ Composition policy that allows to forward any output of the module to any of its
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L44"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L35"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_rules_iter`
```python
get_rules_iter(funcs: List[Graph]) → Iterable[CompositionRule]
get_rules_iter(funcs: list[Graph]) → Iterable[CompositionRule]
```
Return an iterator over composition rules.
@@ -60,7 +58,7 @@ Return an iterator over composition rules.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L62"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L53"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `WireOutput`
A protocol for wire outputs.
@@ -70,7 +68,7 @@ A protocol for wire outputs.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L68"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L59"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_outputs_iter`
@@ -83,7 +81,7 @@ Return an iterator over the possible outputs of the wire output.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L74"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L65"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `WireInput`
A protocol for wire inputs.
@@ -93,7 +91,7 @@ A protocol for wire inputs.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L80"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L71"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_inputs_iter`
@@ -106,7 +104,7 @@ Return an iterator over the possible inputs of the wire input.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L86"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L77"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Output`
The output of a given function of a module.
@@ -116,7 +114,7 @@ The output of a given function of a module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L94"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L85"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_outputs_iter`
@@ -129,7 +127,7 @@ Return an iterator over the possible outputs of the wire output.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L101"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L92"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AllOutputs`
All the encrypted outputs of a given function of a module.
@@ -139,7 +137,7 @@ All the encrypted outputs of a given function of a module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L108"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L99"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_outputs_iter`
@@ -152,7 +150,7 @@ Return an iterator over the possible outputs of the wire output.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L120"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L111"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Input`
The input of a given function of a module.
@@ -162,7 +160,7 @@ The input of a given function of a module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L128"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L119"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_inputs_iter`
@@ -175,7 +173,7 @@ Return an iterator over the possible inputs of the wire input.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L135"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L126"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AllInputs`
All the encrypted inputs of a given function of a module.
@@ -185,7 +183,7 @@ All the encrypted inputs of a given function of a module.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L142"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L133"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_inputs_iter`
@@ -198,7 +196,7 @@ Return an iterator over the possible inputs of the wire input.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L154"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L145"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Wire`
A forwarding rule between an output and an input.
@@ -208,7 +206,7 @@ A forwarding rule between an output and an input.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L162"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L153"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_rules_iter`
@@ -221,17 +219,17 @@ Return an iterator over composition rules.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L163"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Wired`
Composition policy which allows the forwarding of certain outputs to certain inputs.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L179"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L170"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(wires: Optional[Set[Wire]] = None)
__init__(wires: Optional[set[Wire]] = None)
```
@@ -243,12 +241,12 @@ __init__(wires: Optional[Set[Wire]] = None)
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L173"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_rules_iter`
```python
get_rules_iter(funcs: List[Graph]) → Iterable[CompositionRule]
get_rules_iter(funcs: list[Graph]) → Iterable[CompositionRule]
```
Return an iterator over composition rules.
@@ -256,7 +254,7 @@ Return an iterator over composition rules.
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L205"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L196"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `TracedOutput`
A wrapper type used to trace wiring.
@@ -269,14 +267,14 @@ Allows to tag an output value coming from an other module function, and binds it
---
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L217"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L208"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `WireTracingContextManager`
A context manager returned by the `wire_pipeline` method.
Activates wire tracing and yields an inputset that can be iterated on for tracing.
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L224"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/compilation/wiring.py#L215"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`

4
docs/dev/api/concrete.fhe.dtypes.utils.md
View File

@@ -8,12 +8,12 @@ Declaration of various functions and constants related to data types.
---
<a href="../../frontends/concrete-python/concrete/fhe/dtypes/utils.py#L13"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/dtypes/utils.py#L11"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `combine_dtypes`
```python
combine_dtypes(dtypes: List[BaseDataType]) → BaseDataType
combine_dtypes(dtypes: list[BaseDataType]) → BaseDataType
```
Get the 'BaseDataType' that can represent a set of 'BaseDataType's.

12
docs/dev/api/concrete.fhe.extensions.convolution.md
View File

@@ -18,12 +18,12 @@ Tracing and evaluation of convolution.
```python
conv(
x: Union[ndarray, Tracer],
weight: Union[ndarray, List, Tracer],
bias: Optional[ndarray, List, Tracer] = None,
pads: Optional[Tuple[int, ], List[int]] = None,
strides: Optional[Tuple[int, ], List[int]] = None,
dilations: Optional[Tuple[int, ], List[int]] = None,
kernel_shape: Optional[Tuple[int, ], List[int]] = None,
weight: Union[ndarray, list, Tracer],
bias: Optional[ndarray, list, Tracer] = None,
pads: Optional[tuple[int, ], list[int]] = None,
strides: Optional[tuple[int, ], list[int]] = None,
dilations: Optional[tuple[int, ], list[int]] = None,
kernel_shape: Optional[tuple[int, ], list[int]] = None,
group: int = 1,
auto_pad: str = 'NOTSET'
) → Union[ndarray, Tracer]

8
docs/dev/api/concrete.fhe.extensions.maxpool.md
View File

@@ -23,11 +23,11 @@ Tracing and evaluation of maxpool.
```python
maxpool(
x: Union[ndarray, Tracer],
kernel_shape: Union[Tuple[int, ], List[int]],
strides: Optional[Tuple[int, ], List[int]] = None,
kernel_shape: Union[tuple[int, ], list[int]],
strides: Optional[tuple[int, ], list[int]] = None,
auto_pad: str = 'NOTSET',
pads: Optional[Tuple[int, ], List[int]] = None,
dilations: Optional[Tuple[int, ], List[int]] = None,
pads: Optional[tuple[int, ], list[int]] = None,
dilations: Optional[tuple[int, ], list[int]] = None,
ceil_mode: int = 0,
storage_order: int = 0
) → Union[ndarray, Tracer]

2
docs/dev/api/concrete.fhe.extensions.multivariate.md
View File

@@ -15,7 +15,7 @@ Declaration of `multivariate` extension.
```python
multivariate(
function: Callable,
outputs: Optional[BaseDataType, Type[ScalarAnnotation]] = None
outputs: Optional[BaseDataType, type[ScalarAnnotation]] = None
) → Callable
```

2
docs/dev/api/concrete.fhe.extensions.ones.md
View File

@@ -13,7 +13,7 @@ Declaration of `ones` and `one` functions, to simplify creation of encrypted one
## <kbd>function</kbd> `ones`
```python
ones(shape: Union[int, Tuple[int, ]]) → Union[ndarray, Tracer]
ones(shape: Union[int, tuple[int, ]]) → Union[ndarray, Tracer]
```
Create an encrypted array of ones.

26
docs/dev/api/concrete.fhe.extensions.round_bit_pattern.md
View File

@@ -11,17 +11,17 @@ Declaration of `round_bit_pattern` function, to provide an interface for rounded
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L158"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L159"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `round_bit_pattern`
```python
round_bit_pattern(
x: Union[int, integer, List, ndarray, Tracer],
x: Union[int, integer, list, ndarray, Tracer],
lsbs_to_remove: Union[int, AutoRounder],
overflow_protection: bool = True,
exactness: Optional[Exactness] = None
) → Union[int, integer, List, ndarray, Tracer]
) → Union[int, integer, list, ndarray, Tracer]
```
Round the bit pattern of an integer.
@@ -55,12 +55,12 @@ x = 0b_1011_1000 , lsbs_to_remove = 3 => 0b_1011_1000 x = 0b_1011_1001 , lsbs_to
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L25"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Adjusting`
Adjusting class, to be used as early stop signal during adjustment.
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L35"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -78,12 +78,12 @@ __init__(rounder: 'AutoRounder', input_min: int, input_max: int)
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L42"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AutoRounder`
AutoRounder class, to optimize for number of msbs to keep during round bit pattern operation.
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L54"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L55"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -100,14 +100,14 @@ __init__(target_msbs: int = 16)
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L72"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L73"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `adjust`
```python
adjust(
function: Callable,
inputset: Union[Iterable[Any], Iterable[Tuple[Any, ]]]
inputset: Union[Iterable[Any], Iterable[tuple[Any, ]]]
)
```
@@ -115,24 +115,24 @@ Adjust AutoRounders in a function using an inputset.
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L127"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L128"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `dump_dict`
```python
dump_dict() → Dict
dump_dict() → dict
```
Dump properties of the rounder to a dict.
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L141"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/round_bit_pattern.py#L142"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>classmethod</kbd> `load_dict`
```python
load_dict(properties: Dict) → AutoRounder
load_dict(properties: dict) → AutoRounder
```
Load previously dumped rounder.

26
docs/dev/api/concrete.fhe.extensions.truncate_bit_pattern.md
View File

@@ -11,15 +11,15 @@ Declaration of `truncate_bit_pattern` extension.
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L173"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `truncate_bit_pattern`
```python
truncate_bit_pattern(
x: Union[int, integer, List, ndarray, Tracer],
x: Union[int, integer, list, ndarray, Tracer],
lsbs_to_remove: Union[int, AutoTruncator]
) → Union[int, integer, List, ndarray, Tracer]
) → Union[int, integer, list, ndarray, Tracer]
```
Round the bit pattern of an integer.
@@ -43,12 +43,12 @@ x = 0b_0000 , lsbs_to_remove = 2 => 0b_0000 x = 0b_0001 , lsbs_to_remove = 2 =>
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L24"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L25"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Adjusting`
Adjusting class, to be used as early stop signal during adjustment.
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -66,12 +66,12 @@ __init__(truncator: 'AutoTruncator', input_min: int, input_max: int)
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L40"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AutoTruncator`
AutoTruncator class, to optimize for the number of msbs to keep during truncate operation.
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L53"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L54"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -88,14 +88,14 @@ __init__(target_msbs: int = 16)
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L71"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L72"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `adjust`
```python
adjust(
function: Callable,
inputset: Union[Iterable[Any], Iterable[Tuple[Any, ]]]
inputset: Union[Iterable[Any], Iterable[tuple[Any, ]]]
)
```
@@ -103,24 +103,24 @@ Adjust AutoTruncators in a function using an inputset.
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L141"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L142"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `dump_dict`
```python
dump_dict() → Dict
dump_dict() → dict
```
Dump properties of the truncator to a dict.
---
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L155"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/extensions/truncate_bit_pattern.py#L156"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>classmethod</kbd> `load_dict`
```python
load_dict(properties: Dict) → AutoTruncator
load_dict(properties: dict) → AutoTruncator
```
Load previously dumped truncator.

2
docs/dev/api/concrete.fhe.extensions.univariate.md
View File

@@ -15,7 +15,7 @@ Declaration of `univariate` function.
```python
univariate(
function: Callable[[Any], Any],
outputs: Optional[BaseDataType, Type[ScalarAnnotation]] = None
outputs: Optional[BaseDataType, type[ScalarAnnotation]] = None
) → Callable[[Union[Tracer, Any]], Union[Tracer, Any]]
```

2
docs/dev/api/concrete.fhe.extensions.zeros.md
View File

@@ -13,7 +13,7 @@ Declaration of `zeros` and `zero` functions, to simplify creation of encrypted z
## <kbd>function</kbd> `zeros`
```python
zeros(shape: Union[int, Tuple[int, ]]) → Union[ndarray, Tracer]
zeros(shape: Union[int, tuple[int, ]]) → Union[ndarray, Tracer]
```
Create an encrypted array of zeros.

226
docs/dev/api/concrete.fhe.mlir.context.md
View File

@@ -15,12 +15,12 @@ Declaration of `Context` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L68"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L69"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Context`
Context class, to perform operations on conversions.
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L87"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L88"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -37,7 +37,7 @@ __init__(context: <locals>Context, graph: Graph, configuration: Configuration)
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1856"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1857"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `add`
@@ -51,12 +51,12 @@ add(resulting_type: ConversionType, x: Conversion, y: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1888"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1889"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `array`
```python
array(resulting_type: ConversionType, elements: List[Conversion]) → Conversion
array(resulting_type: ConversionType, elements: list[Conversion]) → Conversion
```
@@ -65,7 +65,7 @@ array(resulting_type: ConversionType, elements: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1926"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1927"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `assign`
@@ -84,7 +84,7 @@ assign(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L238"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L239"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `attribute`
@@ -108,7 +108,7 @@ Create an MLIR attribute.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1120"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1121"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `best_chunk_ranges`
@@ -118,7 +118,7 @@ best_chunk_ranges(
x_offset: int,
y: Conversion,
y_offset: int
) → List[Tuple[int, int]]
) → list[tuple[int, int]]
```
Calculate best chunk ranges for given operands.
@@ -141,7 +141,7 @@ Calculate best chunk ranges for given operands.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1942"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1943"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise`
@@ -160,7 +160,7 @@ bitwise(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2089"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2090"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise_and`
@@ -178,7 +178,7 @@ bitwise_and(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2097"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2098"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise_or`
@@ -196,7 +196,7 @@ bitwise_or(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2105"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2106"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise_xor`
@@ -214,12 +214,12 @@ bitwise_xor(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2113"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2114"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `broadcast_to`
```python
broadcast_to(x: Conversion, shape: Tuple[int, ])
broadcast_to(x: Conversion, shape: tuple[int, ])
```
@@ -228,7 +228,7 @@ broadcast_to(x: Conversion, shape: Tuple[int, ])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2126"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2127"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `cast`
@@ -242,7 +242,7 @@ cast(resulting_type: ConversionType, x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1825"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1826"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `cast_to_original_bit_width`
@@ -254,7 +254,7 @@ Cast a value to its original bit width using multiplication and reinterpretation
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L4024"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L4025"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `change_partition`
@@ -272,7 +272,7 @@ change_partition(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L663"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L664"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `compare_with_subtraction`
@@ -280,7 +280,7 @@ change_partition(
compare_with_subtraction(
resulting_type: ConversionType,
subtraction: Conversion,
accept: Set[Comparison]
accept: set[Comparison]
) → Conversion
```
@@ -288,7 +288,7 @@ Apply the final comparison table and return comparison result.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L558"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L559"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `comparison`
@@ -297,7 +297,7 @@ comparison(
resulting_type: ConversionType,
x: Conversion,
y: Conversion,
accept: Set[Comparison]
accept: set[Comparison]
) → Conversion
```
@@ -321,7 +321,7 @@ Compare two encrypted values.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L879"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L880"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `comparison_with_chunks`
@@ -330,7 +330,7 @@ comparison_with_chunks(
resulting_type: ConversionType,
x: Conversion,
y: Conversion,
accept: Set[Comparison]
accept: set[Comparison]
) → Conversion
```
@@ -340,7 +340,7 @@ Idea: split x and y into small chunks compare the chunks using table lookups
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1056"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1057"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `comparison_with_chunks_equals`
@@ -349,12 +349,12 @@ comparison_with_chunks_equals(
resulting_type: ConversionType,
x: Conversion,
y: Conversion,
accept: Set[Comparison],
accept: set[Comparison],
x_offset: int,
y_offset: int,
x_was_signed: bool,
y_was_signed: bool,
chunk_ranges: List[Tuple[int, int]]
chunk_ranges: list[tuple[int, int]]
) → Conversion
```
@@ -362,7 +362,7 @@ Check equality of encrypted values using chunks.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L699"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L700"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `comparison_with_subtraction_trick`
@@ -371,7 +371,7 @@ comparison_with_subtraction_trick(
resulting_type: ConversionType,
x: Conversion,
y: Conversion,
accept: Set[Comparison],
accept: set[Comparison],
x_minus_y_dtype: Integer
) → Conversion
```
@@ -384,14 +384,14 @@ Additional Args: x_minus_y_dtype (Integer): minimal dtype that can be used to
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2142"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2143"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `concatenate`
```python
concatenate(
resulting_type: ConversionType,
xs: List[Conversion],
xs: list[Conversion],
axis: Optional[int]
) → Conversion
```
@@ -402,7 +402,7 @@ concatenate(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L383"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L384"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `conditional`
@@ -441,7 +441,7 @@ Create an if conditional.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2184"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2185"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `constant`
@@ -459,7 +459,7 @@ constant(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2217"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2218"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `conv2d`
@@ -482,21 +482,21 @@ conv2d(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1184"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1185"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `convert_to_chunks_and_map`
```python
convert_to_chunks_and_map(
resulting_scalar_type: ConversionType,
resulting_shape: Tuple[int, ],
chunk_ranges: List[Tuple[int, int]],
resulting_shape: tuple[int, ],
chunk_ranges: list[tuple[int, int]],
x: Conversion,
x_offset: int,
y: Conversion,
y_offset: int,
mapper: Callable
) → List[Conversion]
) → list[Conversion]
```
Extract the chunks of two values, pack them in a single integer and map the integer.
@@ -527,7 +527,7 @@ Extract the chunks of two values, pack them in a single integer and map the inte
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2282"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2283"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `dot`
@@ -541,7 +541,7 @@ dot(resulting_type: ConversionType, x: Conversion, y: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2359"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2360"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `dynamic_tlu`
@@ -559,7 +559,7 @@ dynamic_tlu(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L109"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L110"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `eint`
@@ -571,7 +571,7 @@ Get encrypted unsigned integer type (e.g., !FHE.eint<3>, !FHE.eint<5>).
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L181"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `element_typeof`
@@ -583,7 +583,7 @@ Get type corresponding to the elements of a tensor type.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2394"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2395"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `encrypt`
@@ -597,7 +597,7 @@ encrypt(resulting_type: ConversionType, x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2401"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2402"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `equal`
@@ -611,12 +611,12 @@ equal(resulting_type: ConversionType, x: Conversion, y: Conversion) → Conversi
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L263"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L264"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `error`
```python
error(highlights: Mapping[Node, Union[str, List[str]]])
error(highlights: Mapping[Node, Union[str, list[str]]])
```
Fail compilation with an error.
@@ -628,7 +628,7 @@ Fail compilation with an error.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L115"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L116"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `esint`
@@ -640,7 +640,7 @@ Get encrypted signed integer type (e.g., !FHE.esint<3>, !FHE.esint<5>).
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2422"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2423"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `extract_bits`
@@ -658,7 +658,7 @@ extract_bits(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2546"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2547"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `flatten`
@@ -672,7 +672,7 @@ flatten(x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L467"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L468"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `for_loop`
@@ -714,7 +714,7 @@ Create a for loop.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L200"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L201"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `fork_type`
@@ -723,7 +723,7 @@ fork_type(
type_: ConversionType,
bit_width: Optional[int] = None,
is_signed: Optional[bool] = None,
shape: Optional[Tuple[int, ]] = None
shape: Optional[tuple[int, ]] = None
) → ConversionType
```
@@ -731,7 +731,7 @@ Fork a type with some properties update.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L4019"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L4020"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `get_partition_name`
@@ -745,7 +745,7 @@ get_partition_name(partition: CryptoParams) → str
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2549"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2550"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `greater`
@@ -763,7 +763,7 @@ greater(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2552"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2553"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `greater_equal`
@@ -781,7 +781,7 @@ greater_equal(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L103"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L104"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `i`
@@ -793,7 +793,7 @@ Get clear signless integer type (e.g., i3, i5).
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2560"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2561"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `identity`
@@ -811,7 +811,7 @@ identity(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2594"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2595"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `index`
@@ -829,7 +829,7 @@ index(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L121"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L122"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `index_type`
@@ -841,7 +841,7 @@ Get index type.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L274"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L275"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `is_bit_width_compatible`
@@ -853,7 +853,7 @@ Check if conversion types are compatible in terms of bit-width.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2609"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2610"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `less`
@@ -867,7 +867,7 @@ less(resulting_type: ConversionType, x: Conversion, y: Conversion) → Conversio
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2612"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2613"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `less_equal`
@@ -885,7 +885,7 @@ less_equal(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L223"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L224"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `location`
@@ -897,7 +897,7 @@ Create an MLIR location from the node that is being converted.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2620"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2621"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `lsb`
@@ -911,7 +911,7 @@ lsb(resulting_type: ConversionType, x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2627"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2628"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `matmul`
@@ -929,7 +929,7 @@ matmul(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2705"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2706"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maximum`
@@ -947,7 +947,7 @@ maximum(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2778"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2779"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maxpool2d`
@@ -955,7 +955,7 @@ maximum(
maxpool2d(
resulting_type: ConversionType,
x: Conversion,
kernel_shape: Tuple[int, ],
kernel_shape: tuple[int, ],
strides: Sequence[int],
dilations: Sequence[int]
)
@@ -967,7 +967,7 @@ maxpool2d(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2827"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2828"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `min_max`
@@ -987,7 +987,7 @@ min_max(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2846"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2847"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `minimum`
@@ -1005,7 +1005,7 @@ minimum(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1466"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1467"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `minimum_maximum_with_chunks`
@@ -1022,7 +1022,7 @@ Calculate minimum or maximum between two encrypted values using chunks.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1406"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1407"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `minimum_maximum_with_trick`
@@ -1032,7 +1032,7 @@ minimum_maximum_with_trick(
x: Conversion,
y: Conversion,
x_minus_y_dtype: Integer,
intermediate_table: List[int]
intermediate_table: list[int]
) → Conversion
```
@@ -1044,7 +1044,7 @@ Additional Args: x_minus_y_dtype (Integer): minimal dtype that can be used to
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2920"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2921"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `mul`
@@ -1058,7 +1058,7 @@ mul(resulting_type: ConversionType, x: Conversion, y: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3005"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3006"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `multi_tlu`
@@ -1077,7 +1077,7 @@ multi_tlu(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1707"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1708"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `multiplication_with_boolean`
@@ -1095,14 +1095,14 @@ Calculate boolean * value using bits.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3096"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3097"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `multivariate_multi_tlu`
```python
multivariate_multi_tlu(
resulting_type: ConversionType,
xs: List[Conversion],
xs: list[Conversion],
tables: Any,
mapping: Any
)
@@ -1114,14 +1114,14 @@ multivariate_multi_tlu(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3085"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3086"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `multivariate_tlu`
```python
multivariate_tlu(
resulting_type: ConversionType,
xs: List[Conversion],
xs: list[Conversion],
table: Sequence[int]
) → Conversion
```
@@ -1132,7 +1132,7 @@ multivariate_tlu(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3108"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3109"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `neg`
@@ -1146,7 +1146,7 @@ neg(resulting_type: ConversionType, x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L127"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L128"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `none_type`
@@ -1158,7 +1158,7 @@ Get none type.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3126"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3127"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `not_equal`
@@ -1176,7 +1176,7 @@ not_equal(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3134"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3135"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `ones`
@@ -1190,7 +1190,7 @@ ones(resulting_type: ConversionType) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L299"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L300"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `operation`
@@ -1227,12 +1227,12 @@ Create a conversion from an MLIR operation.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1324"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L1325"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `pack_multivariate_inputs`
```python
pack_multivariate_inputs(xs: List[Conversion]) → Conversion
pack_multivariate_inputs(xs: list[Conversion]) → Conversion
```
Packs inputs of multivariate table lookups.
@@ -1249,7 +1249,7 @@ Packs inputs of multivariate table lookups.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3931"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3932"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `reinterpret`
@@ -1267,7 +1267,7 @@ reinterpret(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3148"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3149"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `relu`
@@ -1281,12 +1281,12 @@ relu(resulting_type: ConversionType, x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3204"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3205"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `reshape`
```python
reshape(x: Conversion, shape: Tuple[int, ]) → Conversion
reshape(x: Conversion, shape: tuple[int, ]) → Conversion
```
@@ -1295,7 +1295,7 @@ reshape(x: Conversion, shape: Tuple[int, ]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3335"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3336"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `round_bit_pattern`
@@ -1315,7 +1315,7 @@ round_bit_pattern(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2411"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2412"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `safe_reduce_precision`
@@ -1329,7 +1329,7 @@ safe_reduce_precision(x: Conversion, bit_width: int) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3471"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3472"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `shift`
@@ -1349,7 +1349,7 @@ shift(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2404"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L2405"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `shift_left_at_constant_precision`
@@ -1363,7 +1363,7 @@ shift_left_at_constant_precision(x: Conversion, rank: int) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3672"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3673"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `sub`
@@ -1377,7 +1377,7 @@ sub(resulting_type: ConversionType, x: Conversion, y: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3705"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3706"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `sum`
@@ -1396,19 +1396,19 @@ sum(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L133"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L134"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tensor`
```python
tensor(element_type: ConversionType, shape: Tuple[int, ]) → ConversionType
tensor(element_type: ConversionType, shape: tuple[int, ]) → ConversionType
```
Get tensor type (e.g., tensor<5xi3>, tensor<3x2x!FHE.eint<5>>).
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3754"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3755"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tensorize`
@@ -1422,7 +1422,7 @@ tensorize(x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3765"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3766"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tlu`
@@ -1436,7 +1436,7 @@ tlu(resulting_type: ConversionType, on: Conversion, table: Sequence[int])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3835"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3836"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `to_signed`
@@ -1450,7 +1450,7 @@ to_signed(x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3857"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3858"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `to_signedness`
@@ -1464,7 +1464,7 @@ to_signedness(x: Conversion, of: ConversionType) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3860"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3861"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `to_unsigned`
@@ -1478,7 +1478,7 @@ to_unsigned(x: Conversion) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3882"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3883"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `transpose`
@@ -1496,12 +1496,12 @@ transpose(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3893"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3894"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tree_add`
```python
tree_add(resulting_type: ConversionType, xs: List[Conversion]) → Conversion
tree_add(resulting_type: ConversionType, xs: list[Conversion]) → Conversion
```
@@ -1510,7 +1510,7 @@ tree_add(resulting_type: ConversionType, xs: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3911"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3912"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `truncate_bit_pattern`
@@ -1524,7 +1524,7 @@ truncate_bit_pattern(x: Conversion, lsbs_to_remove: int) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L741"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L742"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `try_comparison_with_clipping_trick`
@@ -1533,7 +1533,7 @@ try_comparison_with_clipping_trick(
resulting_type: ConversionType,
x: Conversion,
y: Conversion,
accept: Set[Comparison]
accept: set[Comparison]
) → Optional[Conversion]
```
@@ -1553,7 +1553,7 @@ Additional Args: smaller_minus_clipped_bigger_dtype (Integer): minimal dtype t
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L143"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L144"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `typeof`
@@ -1565,7 +1565,7 @@ Get type corresponding to a value or a node.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3949"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L3950"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `where`
@@ -1584,7 +1584,7 @@ where(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L4007"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/context.py#L4008"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `zeros`

296
docs/dev/api/concrete.fhe.mlir.converter.md
View File

@@ -12,12 +12,12 @@ Declaration of `Converter` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L34"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Converter`
Converter class, to convert a computation graph to MLIR.
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L42"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -37,12 +37,12 @@ __init__(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L321"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L322"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `add`
```python
add(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
add(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -51,26 +51,12 @@ add(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L325"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L326"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `amax`
```python
amax(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
```
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L328"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `amin`
```python
amin(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
amax(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -81,10 +67,10 @@ amin(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L331"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `array`
### <kbd>method</kbd> `amin`
```python
array(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
amin(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -93,12 +79,26 @@ array(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L335"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L336"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `array`
```python
array(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L340"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `assign_dynamic`
```python
assign_dynamic(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
assign_dynamic(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -107,12 +107,12 @@ assign_dynamic(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L356"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L361"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `assign_static`
```python
assign_static(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
assign_static(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -121,12 +121,12 @@ assign_static(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L365"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L370"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise_and`
```python
bitwise_and(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
bitwise_and(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -135,12 +135,12 @@ bitwise_and(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L373"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L378"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise_or`
```python
bitwise_or(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
bitwise_or(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -149,12 +149,12 @@ bitwise_or(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L381"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L386"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise_xor`
```python
bitwise_xor(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
bitwise_xor(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -163,12 +163,12 @@ bitwise_xor(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L389"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L394"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `broadcast_to`
```python
broadcast_to(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
broadcast_to(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -177,12 +177,12 @@ broadcast_to(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L393"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L398"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `concatenate`
```python
concatenate(ctx: Context, node: Node, preds: List[Conversion])
concatenate(ctx: Context, node: Node, preds: list[Conversion])
```
@@ -191,12 +191,12 @@ concatenate(ctx: Context, node: Node, preds: List[Conversion])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L400"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L405"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `constant`
```python
constant(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
constant(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -205,12 +205,12 @@ constant(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L404"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L409"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `conv1d`
```python
conv1d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
conv1d(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -219,12 +219,12 @@ conv1d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L408"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L413"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `conv2d`
```python
conv2d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
conv2d(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -233,12 +233,12 @@ conv2d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L421"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L426"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `conv3d`
```python
conv3d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
conv3d(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -247,7 +247,7 @@ conv3d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L143"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L144"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `convert`
@@ -270,12 +270,12 @@ Return: MlirModule: In-memory MLIR module corresponding to the graph
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L49"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L50"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `convert_many`
```python
convert_many(graphs: Dict[str, Graph], mlir_context: <locals>Context) → Module
convert_many(graphs: dict[str, Graph], mlir_context: <locals>Context) → Module
```
Convert multiple computation graphs to an MLIR module.
@@ -291,12 +291,12 @@ Return: MlirModule: In-memory MLIR module corresponding to the graph
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L425"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L430"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `copy`
```python
copy(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
copy(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -305,12 +305,12 @@ copy(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L429"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L434"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `dot`
```python
dot(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
dot(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -319,12 +319,12 @@ dot(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L433"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L438"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `dynamic_tlu`
```python
dynamic_tlu(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
dynamic_tlu(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -333,12 +333,12 @@ dynamic_tlu(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L437"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L442"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `equal`
```python
equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
equal(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -347,12 +347,12 @@ equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L445"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L450"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `expand_dims`
```python
expand_dims(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
expand_dims(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -361,7 +361,7 @@ expand_dims(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L449"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L454"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `extract_bit_pattern`
@@ -369,7 +369,7 @@ expand_dims(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
extract_bit_pattern(
ctx: Context,
node: Node,
preds: List[Conversion]
preds: list[Conversion]
) → Conversion
```
@@ -379,12 +379,12 @@ extract_bit_pattern(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L453"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L458"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `greater`
```python
greater(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
greater(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -393,26 +393,12 @@ greater(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L461"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L466"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `greater_equal`
```python
greater_equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
```
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L469"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `identity`
```python
identity(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
greater_equal(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -423,10 +409,10 @@ identity(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L474"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `index_dynamic`
### <kbd>method</kbd> `identity`
```python
index_dynamic(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
identity(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -435,12 +421,26 @@ index_dynamic(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L493"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L479"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `index_dynamic`
```python
index_dynamic(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L498"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `index_static`
```python
index_static(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
index_static(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -449,12 +449,12 @@ index_static(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L501"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L506"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `left_shift`
```python
left_shift(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
left_shift(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -463,12 +463,12 @@ left_shift(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L515"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L520"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `less`
```python
less(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
less(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -477,12 +477,12 @@ less(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L523"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L528"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `less_equal`
```python
less_equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
less_equal(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -491,12 +491,12 @@ less_equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L531"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L536"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `matmul`
```python
matmul(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
matmul(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -505,12 +505,12 @@ matmul(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L535"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L540"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `max`
```python
max(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
max(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -519,12 +519,12 @@ max(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L545"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L550"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maximum`
```python
maximum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
maximum(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -533,12 +533,12 @@ maximum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L553"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L558"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maxpool1d`
```python
maxpool1d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
maxpool1d(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -547,12 +547,12 @@ maxpool1d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L557"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L562"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maxpool2d`
```python
maxpool2d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
maxpool2d(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -561,12 +561,12 @@ maxpool2d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L567"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L572"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maxpool3d`
```python
maxpool3d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
maxpool3d(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -575,12 +575,12 @@ maxpool3d(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L571"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L576"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `min`
```python
min(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
min(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -589,12 +589,12 @@ min(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L581"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L586"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `minimum`
```python
minimum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
minimum(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -603,12 +603,12 @@ minimum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L589"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L594"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `multiply`
```python
multiply(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
multiply(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -617,12 +617,12 @@ multiply(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L593"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L598"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `negative`
```python
negative(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
negative(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -631,12 +631,12 @@ negative(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L284"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L285"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `node`
```python
node(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
node(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
Convert a computation graph node into MLIR.
@@ -654,12 +654,12 @@ Return: Conversion: conversion object corresponding to node
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L597"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L602"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `not_equal`
```python
not_equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
not_equal(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -668,12 +668,12 @@ not_equal(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L605"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L610"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `ones`
```python
ones(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
ones(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -682,12 +682,12 @@ ones(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L241"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L242"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `process`
```python
process(graphs: Dict[str, Graph])
process(graphs: dict[str, Graph])
```
Process a computation graph for MLIR conversion.
@@ -699,12 +699,12 @@ Process a computation graph for MLIR conversion.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L609"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L614"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `relu`
```python
relu(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
relu(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -713,12 +713,12 @@ relu(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L613"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L618"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `reshape`
```python
reshape(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
reshape(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -727,12 +727,12 @@ reshape(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L617"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L622"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `right_shift`
```python
right_shift(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
right_shift(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -741,7 +741,7 @@ right_shift(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L631"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L636"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `round_bit_pattern`
@@ -749,7 +749,7 @@ right_shift(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
round_bit_pattern(
ctx: Context,
node: Node,
preds: List[Conversion]
preds: list[Conversion]
) → Conversion
```
@@ -759,7 +759,7 @@ round_bit_pattern(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L171"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `simplify_tag`
@@ -771,12 +771,12 @@ Keep only `n` higher tag parts.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L678"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L683"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `squeeze`
```python
squeeze(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
squeeze(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -785,7 +785,7 @@ squeeze(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L166"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L167"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `stdout_with_ansi_support`
@@ -797,12 +797,12 @@ Detect if ansi characters can be used (e.g. not the case in notebooks).
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L665"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L670"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `subtract`
```python
subtract(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
subtract(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -811,12 +811,12 @@ subtract(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L669"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L674"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `sum`
```python
sum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
sum(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -825,7 +825,7 @@ sum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L997"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L1002"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tfhers_from_native`
@@ -833,7 +833,7 @@ sum(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
tfhers_from_native(
ctx: Context,
node: Node,
preds: List[Conversion]
preds: list[Conversion]
) → Conversion
```
@@ -843,12 +843,12 @@ tfhers_from_native(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L932"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L937"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tfhers_to_native`
```python
tfhers_to_native(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
tfhers_to_native(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -857,12 +857,12 @@ tfhers_to_native(ctx: Context, node: Node, preds: List[Conversion]) → Conversi
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L749"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L754"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `tlu`
```python
tlu(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
tlu(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -871,7 +871,7 @@ tlu(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L694"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L699"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>classmethod</kbd> `tlu_adjust`
@@ -885,7 +885,7 @@ tlu_adjust(table, variable_input, target_bit_width, clipping, reduce_precision)
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L183"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L184"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>classmethod</kbd> `trace_progress`
@@ -893,7 +893,7 @@ tlu_adjust(table, variable_input, target_bit_width, clipping, reduce_precision)
trace_progress(
configuration: Configuration,
progress_index: int,
nodes: List[Node]
nodes: list[Node]
)
```
@@ -910,12 +910,12 @@ Add a trace_message for progress.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L912"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L917"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `transpose`
```python
transpose(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
transpose(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -924,7 +924,7 @@ transpose(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L920"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L925"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `truncate_bit_pattern`
@@ -932,7 +932,7 @@ transpose(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
truncate_bit_pattern(
ctx: Context,
node: Node,
preds: List[Conversion]
preds: list[Conversion]
) → Conversion
```
@@ -942,12 +942,12 @@ truncate_bit_pattern(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L924"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L929"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `where`
```python
where(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
where(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```
@@ -956,12 +956,12 @@ where(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L928"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/converter.py#L933"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `zeros`
```python
zeros(ctx: Context, node: Node, preds: List[Conversion]) → Conversion
zeros(ctx: Context, node: Node, preds: list[Conversion]) → Conversion
```

80
docs/dev/api/concrete.fhe.mlir.processors.assign_bit_widths.md
View File

@@ -9,7 +9,7 @@ Declaration of `AssignBitWidths` graph processor.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L20"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L18"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AssignBitWidths`
AssignBitWidths graph processor, to assign proper bit-widths to be compatible with FHE.
@@ -21,19 +21,19 @@ There are two modes:
There is preference list for comparison strategies.
- Strategies will be traversed in order and bit-widths will be assigned according to the first available strategy.
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L39"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(
single_precision: bool,
composition_rules: List[CompositionRule],
comparison_strategy_preference: List[ComparisonStrategy],
bitwise_strategy_preference: List[BitwiseStrategy],
composition_rules: list[CompositionRule],
comparison_strategy_preference: list[ComparisonStrategy],
bitwise_strategy_preference: list[BitwiseStrategy],
shifts_with_promotion: bool,
multivariate_strategy_preference: List[MultivariateStrategy],
min_max_strategy_preference: List[MinMaxStrategy]
multivariate_strategy_preference: list[MultivariateStrategy],
min_max_strategy_preference: list[MinMaxStrategy]
)
```
@@ -46,12 +46,12 @@ __init__(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L59"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L57"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply_many`
```python
apply_many(graphs: Dict[str, Graph])
apply_many(graphs: dict[str, Graph])
```
@@ -61,12 +61,12 @@ apply_many(graphs: Dict[str, Graph])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L131"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L129"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AdditionalConstraints`
AdditionalConstraints class to customize bit-width assignment step easily.
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L151"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L149"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
@@ -74,12 +74,12 @@ AdditionalConstraints class to customize bit-width assignment step easily.
__init__(
optimizer: Optimize,
graph: Graph,
bit_widths: Dict[Node, Int],
comparison_strategy_preference: List[ComparisonStrategy],
bitwise_strategy_preference: List[BitwiseStrategy],
bit_widths: dict[Node, Int],
comparison_strategy_preference: list[ComparisonStrategy],
bitwise_strategy_preference: list[BitwiseStrategy],
shifts_with_promotion: bool,
multivariate_strategy_preference: List[MultivariateStrategy],
min_max_strategy_preference: List[MinMaxStrategy]
multivariate_strategy_preference: list[MultivariateStrategy],
min_max_strategy_preference: list[MinMaxStrategy]
)
```
@@ -92,12 +92,12 @@ __init__(
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L236"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L234"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `all_inputs_are_encrypted`
```python
all_inputs_are_encrypted(node: Node, preds: List[Node]) → bool
all_inputs_are_encrypted(node: Node, preds: list[Node]) → bool
```
@@ -106,12 +106,12 @@ all_inputs_are_encrypted(node: Node, preds: List[Node]) → bool
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L294"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L292"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `bitwise`
```python
bitwise(node: Node, preds: List[Node])
bitwise(node: Node, preds: list[Node])
```
@@ -120,12 +120,12 @@ bitwise(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L267"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L265"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `comparison`
```python
comparison(node: Node, preds: List[Node])
comparison(node: Node, preds: list[Node])
```
@@ -134,7 +134,7 @@ comparison(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L228"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L226"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `constraint`
@@ -148,7 +148,7 @@ constraint(node: Node, constraint: BoolRef)
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L172"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L170"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `generate_for`
@@ -167,12 +167,12 @@ Generate additional constraints for a node.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L242"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L240"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `has_overflow_protection`
```python
has_overflow_protection(node: Node, preds: List[Node]) → bool
has_overflow_protection(node: Node, preds: list[Node]) → bool
```
@@ -181,12 +181,12 @@ has_overflow_protection(node: Node, preds: List[Node]) → bool
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L253"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L251"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `inputs_and_output_share_precision`
```python
inputs_and_output_share_precision(node: Node, preds: List[Node])
inputs_and_output_share_precision(node: Node, preds: list[Node])
```
@@ -195,12 +195,12 @@ inputs_and_output_share_precision(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L258"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L256"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `inputs_require_one_more_bit`
```python
inputs_require_one_more_bit(node: Node, preds: List[Node])
inputs_require_one_more_bit(node: Node, preds: list[Node])
```
@@ -209,12 +209,12 @@ inputs_require_one_more_bit(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L249"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L247"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `inputs_share_precision`
```python
inputs_share_precision(node: Node, preds: List[Node])
inputs_share_precision(node: Node, preds: list[Node])
```
@@ -223,12 +223,12 @@ inputs_share_precision(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L392"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L390"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `min_max`
```python
min_max(node: Node, preds: List[Node])
min_max(node: Node, preds: list[Node])
```
@@ -237,12 +237,12 @@ min_max(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L354"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L352"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `minimum_maximum`
```python
minimum_maximum(node: Node, preds: List[Node])
minimum_maximum(node: Node, preds: list[Node])
```
@@ -251,12 +251,12 @@ minimum_maximum(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L327"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L325"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `multivariate`
```python
multivariate(node: Node, preds: List[Node])
multivariate(node: Node, preds: list[Node])
```
@@ -265,12 +265,12 @@ multivariate(node: Node, preds: List[Node])
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L239"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_bit_widths.py#L237"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `some_inputs_are_clear`
```python
some_inputs_are_clear(node: Node, preds: List[Node]) → bool
some_inputs_are_clear(node: Node, preds: list[Node]) → bool
```

6
docs/dev/api/concrete.fhe.mlir.processors.assign_node_ids.md
View File

@@ -9,7 +9,7 @@ Declaration of `AssignNodeIds` graph processor.
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_node_ids.py#L10"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_node_ids.py#L8"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `AssignNodeIds`
AssignNodeIds graph processor, to assign node id (%0, %1, etc.) to node properties.
@@ -19,12 +19,12 @@ AssignNodeIds graph processor, to assign node id (%0, %1, etc.) to node properti
---
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_node_ids.py#L15"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/mlir/processors/assign_node_ids.py#L13"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply_many`
```python
apply_many(graphs: Dict[str, Graph])
apply_many(graphs: dict[str, Graph])
```

10
docs/dev/api/concrete.fhe.mlir.utils.md
View File

@@ -34,7 +34,7 @@ Use flooding algorithm to replace `None` values.
## <kbd>function</kbd> `construct_table_multivariate`
```python
construct_table_multivariate(node: Node, preds: List[Node]) → List[Any]
construct_table_multivariate(node: Node, preds: list[Node]) → list[Any]
```
Construct the lookup table for a multivariate node.
@@ -61,9 +61,9 @@ Construct the lookup table for a multivariate node.
```python
construct_table(
node: Node,
preds: List[Node],
preds: list[Node],
configuration: Configuration
) → List[Any]
) → list[Any]
```
Construct the lookup table for an Operation.Generic node.
@@ -92,9 +92,9 @@ Construct the lookup table for an Operation.Generic node.
```python
construct_deduplicated_tables(
node: Node,
preds: List[Node],
preds: list[Node],
configuration: Configuration
) → Tuple[Tuple[ndarray, Optional[List[Tuple[int, ]]]], ]
) → tuple[tuple[ndarray, Optional[list[tuple[int, ]]]], ]
```
Construct lookup tables for each cell of the input for an Operation.Generic node.

90
docs/dev/api/concrete.fhe.representation.graph.md
View File

@@ -12,20 +12,20 @@ Declaration of `Graph` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L26"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L27"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `Graph`
Graph class, to represent computation graphs.
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L47"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L48"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(
graph: MultiDiGraph,
input_nodes: Dict[int, Node],
output_nodes: Dict[int, Node],
input_nodes: dict[int, Node],
output_nodes: dict[int, Node],
name: str,
is_direct: bool = False,
location: str = ''
@@ -53,7 +53,7 @@ Returns the number of outputs of the graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L210"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L211"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `draw`
@@ -87,7 +87,7 @@ That this function requires the python `pygraphviz` package which itself require
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L88"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L89"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `evaluate`
@@ -95,7 +95,7 @@ That this function requires the python `pygraphviz` package which itself require
evaluate(
*args: Any,
p_error: Optional[float] = None
) → Dict[Node, Union[bool_, integer, floating, ndarray]]
) → dict[Node, Union[bool_, integer, floating, ndarray]]
```
Perform the computation `Graph` represents and get resulting values for all nodes.
@@ -114,15 +114,15 @@ Perform the computation `Graph` represents and get resulting values for all node
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L349"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L350"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `format`
```python
format(
maximum_constant_length: int = 25,
highlighted_nodes: Optional[Dict[Node, List[str]]] = None,
highlighted_result: Optional[List[str]] = None,
highlighted_nodes: Optional[dict[Node, list[str]]] = None,
highlighted_result: Optional[list[str]] = None,
show_types: bool = True,
show_bounds: bool = True,
show_tags: bool = True,
@@ -159,7 +159,7 @@ Get the textual representation of the `Graph`.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L588"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L589"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `format_bit_width_assignments`
@@ -176,7 +176,7 @@ Get the textual representation of bit width assignments of the graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L571"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L572"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `format_bit_width_constraints`
@@ -193,17 +193,17 @@ Get the textual representation of bit width constraints of the graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L934"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L935"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `integer_range`
```python
integer_range(
tag_filter: Optional[str, List[str], Pattern] = None,
operation_filter: Optional[str, List[str], Pattern] = None,
tag_filter: Optional[str, list[str], Pattern] = None,
operation_filter: Optional[str, list[str], Pattern] = None,
is_encrypted_filter: Optional[bool] = None,
custom_filter: Optional[Callable[[Node], bool]] = None
) → Optional[Tuple[int, int]]
) → Optional[tuple[int, int]]
```
Get integer range of the graph.
@@ -228,14 +228,14 @@ Only nodes after filtering will be used to calculate the result.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L884"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L885"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `maximum_integer_bit_width`
```python
maximum_integer_bit_width(
tag_filter: Optional[str, List[str], Pattern] = None,
operation_filter: Optional[str, List[str], Pattern] = None,
tag_filter: Optional[str, list[str], Pattern] = None,
operation_filter: Optional[str, list[str], Pattern] = None,
is_encrypted_filter: Optional[bool] = None,
custom_filter: Optional[Callable[[Node], bool]] = None,
assigned_bit_width: bool = False
@@ -266,14 +266,14 @@ Only nodes after filtering will be used to calculate the result.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L628"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L629"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `measure_bounds`
```python
measure_bounds(
inputset: Union[Iterable[Any], Iterable[Tuple[Any, ]]]
) → Dict[Node, Dict[str, Union[integer, floating]]]
inputset: Union[Iterable[Any], Iterable[tuple[Any, ]]]
) → dict[Node, dict[str, Union[integer, floating]]]
```
Evaluate the `Graph` using an inputset and measure bounds.
@@ -304,12 +304,12 @@ e.g.,
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L748"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L749"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `ordered_inputs`
```python
ordered_inputs() → List[Node]
ordered_inputs() → list[Node]
```
Get the input nodes of the `Graph`, ordered by their indices.
@@ -321,12 +321,12 @@ Get the input nodes of the `Graph`, ordered by their indices.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L759"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L760"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `ordered_outputs`
```python
ordered_outputs() → List[Node]
ordered_outputs() → list[Node]
```
Get the output nodes of the `Graph`, ordered by their indices.
@@ -338,12 +338,12 @@ Get the output nodes of the `Graph`, ordered by their indices.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L770"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L771"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `ordered_preds_of`
```python
ordered_preds_of(node: Node) → List[Node]
ordered_preds_of(node: Node) → list[Node]
```
Get predecessors of `node`, ordered by their indices.
@@ -360,7 +360,7 @@ Get predecessors of `node`, ordered by their indices.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L789"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L790"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `prune_useless_nodes`
@@ -372,18 +372,18 @@ Remove unreachable nodes from the graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L805"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L806"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `query_nodes`
```python
query_nodes(
tag_filter: Optional[str, List[str], Pattern] = None,
operation_filter: Optional[str, List[str], Pattern] = None,
tag_filter: Optional[str, list[str], Pattern] = None,
operation_filter: Optional[str, list[str], Pattern] = None,
is_encrypted_filter: Optional[bool] = None,
custom_filter: Optional[Callable[[Node], bool]] = None,
ordered: bool = False
) → List[Node]
) → list[Node]
```
Query nodes within the graph.
@@ -410,12 +410,12 @@ Filters work like so: str -> nodes without exact match is skipped List[str] ->
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L699"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L700"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `update_with_bounds`
```python
update_with_bounds(bounds: Dict[Node, Dict[str, Union[integer, floating]]])
update_with_bounds(bounds: dict[Node, dict[str, Union[integer, floating]]])
```
Update `ValueDescription`s within the `Graph` according to measured bounds.
@@ -428,7 +428,7 @@ Update `ValueDescription`s within the `Graph` according to measured bounds.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1005"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1006"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `GraphProcessor`
GraphProcessor base class, to define the API for a graph processing pipeline.
@@ -440,7 +440,7 @@ Process a single graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1012"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1013"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply`
@@ -452,12 +452,12 @@ Process the graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1018"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1019"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `error`
```python
error(graph: Graph, highlights: Mapping[Node, Union[str, List[str]]])
error(graph: Graph, highlights: Mapping[Node, Union[str, list[str]]])
```
Fail processing with an error.
@@ -472,7 +472,7 @@ Fail processing with an error.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1043"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1044"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `MultiGraphProcessor`
MultiGraphProcessor base class, to define the API for a multiple graph processing pipeline.
@@ -484,7 +484,7 @@ Processes multiple graphs at once.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1056"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1057"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply`
@@ -496,24 +496,24 @@ Process a single graph.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1050"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1051"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply_many`
```python
apply_many(graphs: Dict[str, Graph])
apply_many(graphs: dict[str, Graph])
```
Process a dictionary of graphs.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1018"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/graph.py#L1019"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `error`
```python
error(graph: Graph, highlights: Mapping[Node, Union[str, List[str]]])
error(graph: Graph, highlights: Mapping[Node, Union[str, list[str]]])
```
Fail processing with an error.

14
docs/dev/api/concrete.fhe.representation.node.md
View File

@@ -24,11 +24,11 @@ Node class, to represent computation in a computation graph.
```python
__init__(
inputs: List[ValueDescription],
inputs: list[ValueDescription],
output: ValueDescription,
operation: Operation,
evaluator: Callable,
properties: Optional[Dict[str, Any]] = None
properties: Optional[dict[str, Any]] = None
)
```
@@ -106,7 +106,7 @@ Create an Operation.Constant node.
### <kbd>method</kbd> `format`
```python
format(predecessors: List[str], maximum_constant_length: int = 45) → str
format(predecessors: list[str], maximum_constant_length: int = 45) → str
```
Get the textual representation of the `Node` (dependent to preds).
@@ -132,12 +132,12 @@ Get the textual representation of the `Node` (dependent to preds).
```python
generic(
name: str,
inputs: List[ValueDescription],
inputs: list[ValueDescription],
output: ValueDescription,
operation: Callable,
args: Optional[Tuple[Any, ]] = None,
kwargs: Optional[Dict[str, Any]] = None,
attributes: Optional[Dict[str, Any]] = None
args: Optional[tuple[Any, ]] = None,
kwargs: Optional[dict[str, Any]] = None,
attributes: Optional[dict[str, Any]] = None
)
```

4
docs/dev/api/concrete.fhe.representation.utils.md
View File

@@ -13,7 +13,7 @@ Declaration of various functions and constants related to representation of comp
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/utils.py#L64"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/utils.py#L65"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `format_constant`
@@ -44,7 +44,7 @@ Get the textual representation of a constant.
---
<a href="../../frontends/concrete-python/concrete/fhe/representation/utils.py#L107"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/representation/utils.py#L108"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `format_indexing_element`

12
docs/dev/api/concrete.fhe.tfhers.bridge.md
View File

@@ -8,7 +8,7 @@ Declaration of `tfhers.Bridge` class.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L301"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L303"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `new_bridge`
@@ -82,7 +82,7 @@ Return the output types per function map.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L189"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L190"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `export_value`
@@ -112,7 +112,7 @@ Export a value as a serialized TFHErs integer.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L163"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L164"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `import_value`
@@ -142,13 +142,13 @@ Import a serialized TFHErs integer as a Value.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L236"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L237"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `keygen_with_initial_keys`
```python
keygen_with_initial_keys(
input_idx_to_key_buffer: Dict[Union[Tuple[str, int], int], bytes],
input_idx_to_key_buffer: dict[Union[tuple[str, int], int], bytes],
force: bool = False,
seed: Optional[int] = None,
encryption_seed: Optional[int] = None
@@ -177,7 +177,7 @@ Generate keys using an initial set of secret keys.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L214"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/bridge.py#L215"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `serialize_input_secret_key`

6
docs/dev/api/concrete.fhe.tfhers.dtypes.md
View File

@@ -76,7 +76,7 @@ This will return different values depending on the encryption key choice.
### <kbd>method</kbd> `from_dict`
```python
from_dict(dict_obj: Dict[str, Any]) → CryptoParams
from_dict(dict_obj: dict[str, Any]) → CryptoParams
```
Create a CryptoParams instance from a dictionary.
@@ -99,7 +99,7 @@ Create a CryptoParams instance from a dictionary.
### <kbd>method</kbd> `to_dict`
```python
to_dict() → Dict[str, Any]
to_dict() → dict[str, Any]
```
Convert the CryptoParams object to a dictionary representation.
@@ -230,7 +230,7 @@ Create a TFHERSIntegerType instance from a dictionary.
### <kbd>method</kbd> `to_dict`
```python
to_dict() → Dict[str, Any]
to_dict() → dict[str, Any]
```
Convert the object to a dictionary representation.

6
docs/dev/api/concrete.fhe.tfhers.md
View File

@@ -15,7 +15,7 @@ tfhers module to represent, and compute on tfhers integer values.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/__init__.py#L28"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/__init__.py#L27"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `get_type_from_params`
@@ -46,13 +46,13 @@ Get a TFHE-rs integer type from TFHE-rs parameters in JSON format.
---
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/__init__.py#L49"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/tfhers/__init__.py#L48"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `get_type_from_params_dict`
```python
get_type_from_params_dict(
crypto_param_dict: Dict,
crypto_param_dict: dict,
is_signed: bool,
precision: int
) → TFHERSIntegerType

14
docs/dev/api/concrete.fhe.tfhers.specs.md
View File

@@ -24,10 +24,10 @@ input_types_per_func (Dict[str, List[Optional[TFHERSIntegerType]]]): maps every
```python
__init__(
input_types_per_func: Dict[str, List[Optional[TFHERSIntegerType]]],
output_types_per_func: Dict[str, List[Optional[TFHERSIntegerType]]],
input_shapes_per_func: Dict[str, List[Optional[Tuple[int, ]]]],
output_shapes_per_func: Dict[str, List[Optional[Tuple[int, ]]]]
input_types_per_func: dict[str, list[Optional[TFHERSIntegerType]]],
output_types_per_func: dict[str, list[Optional[TFHERSIntegerType]]],
input_shapes_per_func: dict[str, list[Optional[tuple[int, ]]]],
output_shapes_per_func: dict[str, list[Optional[tuple[int, ]]]]
)
```
@@ -45,7 +45,7 @@ __init__(
### <kbd>method</kbd> `from_dict`
```python
from_dict(dict_obj: Dict[str, Any]) → TFHERSClientSpecs
from_dict(dict_obj: dict[str, Any]) → TFHERSClientSpecs
```
Create a TFHERSClientSpecs instance from a dictionary.
@@ -69,7 +69,7 @@ Create a TFHERSClientSpecs instance from a dictionary.
### <kbd>method</kbd> `from_graphs`
```python
from_graphs(graphs: Dict[str, Graph]) → TFHERSClientSpecs
from_graphs(graphs: dict[str, Graph]) → TFHERSClientSpecs
```
Create a TFHERSClientSpecs instance from a dictionary of graphs.
@@ -91,7 +91,7 @@ Create a TFHERSClientSpecs instance from a dictionary of graphs.
### <kbd>method</kbd> `to_dict`
```python
to_dict() → Dict[str, Any]
to_dict() → dict[str, Any]
```
Convert the TFHERSClientSpecs object to a dictionary representation.

2
docs/dev/api/concrete.fhe.tfhers.values.md
View File

@@ -19,7 +19,7 @@ Wrap integer values (scalar or arrays) into typed values, using tfhers types.
### <kbd>method</kbd> `__init__`
```python
__init__(dtype: TFHERSIntegerType, value: Union[List, int, ndarray])
__init__(dtype: TFHERSIntegerType, value: Union[list, int, ndarray])
```

40
docs/dev/api/concrete.fhe.tracing.tracer.md
View File

@@ -19,7 +19,7 @@ Tracer class, to create computation graphs from python functions.
### <kbd>method</kbd> `__init__`
```python
__init__(computation: Node, input_tracers: List[ForwardRef('Tracer')])
__init__(computation: Node, input_tracers: list['Tracer'])
```
@@ -61,7 +61,7 @@ Trace numpy.ndarray.size.
```python
astype(
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], Type[ForwardRef('ScalarAnnotation')]]
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], type['ScalarAnnotation']]
) → Tracer
```
@@ -110,7 +110,7 @@ Trace numpy.ndarray.flatten().
### <kbd>method</kbd> `reshape`
```python
reshape(*newshape: Union[Any, Tuple[Any, ]]) → Tracer
reshape(*newshape: Union[Any, tuple[Any, ]]) → Tracer
```
Trace numpy.ndarray.reshape(newshape).
@@ -158,7 +158,7 @@ Try to create a tracer from a value.
```python
trace(
function: Callable,
parameters: Dict[str, ValueDescription],
parameters: dict[str, ValueDescription],
is_direct: bool = False,
location: str = ''
) → Graph
@@ -187,7 +187,7 @@ Trace `function` and create the `Graph` that represents it.
### <kbd>method</kbd> `transpose`
```python
transpose(axes: Optional[Tuple[int, ]] = None) → Tracer
transpose(axes: Optional[tuple[int, ]] = None) → Tracer
```
Trace numpy.ndarray.transpose().
@@ -205,7 +205,7 @@ Base annotation for direct definition.
### <kbd>method</kbd> `__init__`
```python
__init__(computation: Node, input_tracers: List[ForwardRef('Tracer')])
__init__(computation: Node, input_tracers: list['Tracer'])
```
@@ -247,7 +247,7 @@ Trace numpy.ndarray.size.
```python
astype(
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], Type[ForwardRef('ScalarAnnotation')]]
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], type['ScalarAnnotation']]
) → Tracer
```
@@ -296,7 +296,7 @@ Trace numpy.ndarray.flatten().
### <kbd>method</kbd> `reshape`
```python
reshape(*newshape: Union[Any, Tuple[Any, ]]) → Tracer
reshape(*newshape: Union[Any, tuple[Any, ]]) → Tracer
```
Trace numpy.ndarray.reshape(newshape).
@@ -344,7 +344,7 @@ Try to create a tracer from a value.
```python
trace(
function: Callable,
parameters: Dict[str, ValueDescription],
parameters: dict[str, ValueDescription],
is_direct: bool = False,
location: str = ''
) → Graph
@@ -373,7 +373,7 @@ Trace `function` and create the `Graph` that represents it.
### <kbd>method</kbd> `transpose`
```python
transpose(axes: Optional[Tuple[int, ]] = None) → Tracer
transpose(axes: Optional[tuple[int, ]] = None) → Tracer
```
Trace numpy.ndarray.transpose().
@@ -391,7 +391,7 @@ Base scalar annotation for direct definition.
### <kbd>method</kbd> `__init__`
```python
__init__(computation: Node, input_tracers: List[ForwardRef('Tracer')])
__init__(computation: Node, input_tracers: list['Tracer'])
```
@@ -433,7 +433,7 @@ Trace numpy.ndarray.size.
```python
astype(
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], Type[ForwardRef('ScalarAnnotation')]]
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], type['ScalarAnnotation']]
) → Tracer
```
@@ -482,7 +482,7 @@ Trace numpy.ndarray.flatten().
### <kbd>method</kbd> `reshape`
```python
reshape(*newshape: Union[Any, Tuple[Any, ]]) → Tracer
reshape(*newshape: Union[Any, tuple[Any, ]]) → Tracer
```
Trace numpy.ndarray.reshape(newshape).
@@ -530,7 +530,7 @@ Try to create a tracer from a value.
```python
trace(
function: Callable,
parameters: Dict[str, ValueDescription],
parameters: dict[str, ValueDescription],
is_direct: bool = False,
location: str = ''
) → Graph
@@ -559,7 +559,7 @@ Trace `function` and create the `Graph` that represents it.
### <kbd>method</kbd> `transpose`
```python
transpose(axes: Optional[Tuple[int, ]] = None) → Tracer
transpose(axes: Optional[tuple[int, ]] = None) → Tracer
```
Trace numpy.ndarray.transpose().
@@ -577,7 +577,7 @@ Base tensor annotation for direct definition.
### <kbd>method</kbd> `__init__`
```python
__init__(computation: Node, input_tracers: List[ForwardRef('Tracer')])
__init__(computation: Node, input_tracers: list['Tracer'])
```
@@ -619,7 +619,7 @@ Trace numpy.ndarray.size.
```python
astype(
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], Type[ForwardRef('ScalarAnnotation')]]
dtype: Union[dtype[Any], NoneType, type[Any], _SupportsDType[dtype[Any]], str, tuple[Any, int], tuple[Any, Union[SupportsIndex, Sequence[SupportsIndex]]], list[Any], _DTypeDict, tuple[Any, Any], type['ScalarAnnotation']]
) → Tracer
```
@@ -668,7 +668,7 @@ Trace numpy.ndarray.flatten().
### <kbd>method</kbd> `reshape`
```python
reshape(*newshape: Union[Any, Tuple[Any, ]]) → Tracer
reshape(*newshape: Union[Any, tuple[Any, ]]) → Tracer
```
Trace numpy.ndarray.reshape(newshape).
@@ -716,7 +716,7 @@ Try to create a tracer from a value.
```python
trace(
function: Callable,
parameters: Dict[str, ValueDescription],
parameters: dict[str, ValueDescription],
is_direct: bool = False,
location: str = ''
) → Graph
@@ -745,7 +745,7 @@ Trace `function` and create the `Graph` that represents it.
### <kbd>method</kbd> `transpose`
```python
transpose(axes: Optional[Tuple[int, ]] = None) → Tracer
transpose(axes: Optional[tuple[int, ]] = None) → Tracer
```
Trace numpy.ndarray.transpose().

16
docs/dev/api/concrete.fhe.values.tensor.md
View File

@@ -8,14 +8,14 @@ Declaration of `ClearTensor` and `EncryptedTensor` wrappers.
---
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L11"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L9"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `clear_tensor_builder`
```python
clear_tensor_builder(
dtype: BaseDataType,
shape: Tuple[int, ]
shape: tuple[int, ]
) → ValueDescription
```
@@ -36,14 +36,14 @@ Build a clear tensor value.
---
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L11"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L9"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `clear_tensor_builder`
```python
clear_tensor_builder(
dtype: BaseDataType,
shape: Tuple[int, ]
shape: tuple[int, ]
) → ValueDescription
```
@@ -64,14 +64,14 @@ Build a clear tensor value.
---
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `encrypted_tensor_builder`
```python
encrypted_tensor_builder(
dtype: BaseDataType,
shape: Tuple[int, ]
shape: tuple[int, ]
) → ValueDescription
```
@@ -92,14 +92,14 @@ Build an encrypted tensor value.
---
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L33"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../frontends/concrete-python/concrete/fhe/values/tensor.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>function</kbd> `encrypted_tensor_builder`
```python
encrypted_tensor_builder(
dtype: BaseDataType,
shape: Tuple[int, ]
shape: tuple[int, ]
) → ValueDescription
```

2
docs/dev/api/concrete.fhe.values.value_description.md
View File

@@ -19,7 +19,7 @@ ValueDescription class, to combine data type, shape, and encryption status into
### <kbd>method</kbd> `__init__`
```python
__init__(dtype: BaseDataType, shape: Tuple[int, ], is_encrypted: bool)
__init__(dtype: BaseDataType, shape: tuple[int, ], is_encrypted: bool)
```