mirror of
https://github.com/zama-ai/concrete.git
synced 2026-01-22 19:28:05 -05:00
599 lines
18 KiB
Markdown
599 lines
18 KiB
Markdown
<!-- markdownlint-disable -->
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
# <kbd>module</kbd> `concrete.fhe.compilation.server`
|
|
Declaration of `Server` class.
|
|
|
|
**Global Variables**
|
|
---------------
|
|
- **DEFAULT_GLOBAL_P_ERROR**
|
|
- **DEFAULT_P_ERROR**
|
|
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L53"><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#L71"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `__init__`
|
|
|
|
```python
|
|
__init__(
|
|
client_specs: ClientSpecs,
|
|
output_dir: Union[NoneType, str, Path],
|
|
support: LibrarySupport,
|
|
compilation_result: LibraryCompilationResult,
|
|
server_program: ServerProgram,
|
|
is_simulated: bool,
|
|
composition_rules: Optional[List[CompositionRule]]
|
|
)
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> complexity
|
|
|
|
Get complexity of the compiled program.
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> global_p_error
|
|
|
|
Get the probability of having at least one simple TLU error during the entire execution.
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> p_error
|
|
|
|
Get the probability of error for each simple TLU (on a scalar).
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> size_of_bootstrap_keys
|
|
|
|
Get size of the bootstrap keys of the compiled program.
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> size_of_keyswitch_keys
|
|
|
|
Get size of the key switch keys of the compiled program.
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> size_of_secret_keys
|
|
|
|
Get size of the secret keys of the compiled program.
|
|
|
|
---
|
|
|
|
#### <kbd>property</kbd> statistics
|
|
|
|
Get all statistics of the compiled program.
|
|
|
|
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L431"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `cleanup`
|
|
|
|
```python
|
|
cleanup()
|
|
```
|
|
|
|
Cleanup the temporary library output directory.
|
|
|
|
---
|
|
|
|
<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>
|
|
|
|
### <kbd>method</kbd> `clear_addition_count`
|
|
|
|
```python
|
|
clear_addition_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of clear additions in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L633"><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 = 'main'
|
|
) → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of clear additions per parameter in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L643"><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 = 'main') → 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#L651"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L707"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `clear_multiplication_count`
|
|
|
|
```python
|
|
clear_multiplication_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of clear multiplications in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L715"><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 = 'main'
|
|
) → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of clear multiplications per parameter in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L727"><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 = 'main') → 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#L735"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L97"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `create`
|
|
|
|
```python
|
|
create(
|
|
mlir: Union[str, Module],
|
|
configuration: Configuration,
|
|
is_simulated: bool = False,
|
|
compilation_context: Optional[CompilationContext] = None,
|
|
composition_rules: Optional[Iterable[CompositionRule]] = None
|
|
) → Server
|
|
```
|
|
|
|
Create a server using MLIR and output sign information.
|
|
|
|
|
|
|
|
**Args:**
|
|
mlir (MlirModule): mlir to compile
|
|
|
|
is_simulated (bool, default = False): whether to compile in simulation mode or not
|
|
|
|
configuration (Optional[Configuration]): configuration to use
|
|
|
|
compilation_context (CompilationContext): context to use for the Compiler
|
|
|
|
composition_rules (Iterable[Tuple[str, int, str, int]]): composition rules to be applied when compiling
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L665"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `encrypted_addition_count`
|
|
|
|
```python
|
|
encrypted_addition_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of encrypted additions in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L673"><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 = 'main'
|
|
) → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of encrypted additions per parameter in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L685"><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 = 'main') → 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#L693"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L749"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `encrypted_negation_count`
|
|
|
|
```python
|
|
encrypted_negation_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of encrypted negations 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>
|
|
|
|
### <kbd>method</kbd> `encrypted_negation_count_per_parameter`
|
|
|
|
```python
|
|
encrypted_negation_count_per_parameter(
|
|
function: str = 'main'
|
|
) → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of encrypted negations per parameter in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L769"><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 = 'main') → 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#L777"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L543"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `key_switch_count`
|
|
|
|
```python
|
|
key_switch_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of key switches in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L551"><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 = 'main') → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of key switches 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>
|
|
|
|
### <kbd>method</kbd> `key_switch_count_per_tag`
|
|
|
|
```python
|
|
key_switch_count_per_tag(function: str = 'main') → 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#L569"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L301"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `load`
|
|
|
|
```python
|
|
load(path: Union[str, Path]) → Server
|
|
```
|
|
|
|
Load the server from the given path in zip format.
|
|
|
|
|
|
|
|
**Args:**
|
|
path (Union[str, Path]): path to load the server from
|
|
|
|
|
|
|
|
**Returns:**
|
|
Server: server loaded from the filesystem
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L481"><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 = 'main') → Dict[str, int]
|
|
```
|
|
|
|
Get the memory usage of operations per location.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L583"><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`
|
|
|
|
```python
|
|
packing_key_switch_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of packing key switches in the compiled program.
|
|
|
|
---
|
|
|
|
<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> `packing_key_switch_count_per_parameter`
|
|
|
|
```python
|
|
packing_key_switch_count_per_parameter(
|
|
function: str = 'main'
|
|
) → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of packing key switches per parameter in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L603"><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 = 'main') → 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#L611"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L501"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `programmable_bootstrap_count`
|
|
|
|
```python
|
|
programmable_bootstrap_count(function: str = 'main') → int
|
|
```
|
|
|
|
Get the number of programmable bootstraps in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L509"><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 = 'main'
|
|
) → Dict[Parameter, int]
|
|
```
|
|
|
|
Get the number of programmable bootstraps per parameter in the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L521"><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 = 'main') → 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#L529"><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 = 'main'
|
|
) → Dict[str, Dict[Parameter, 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#L373"><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], ]],
|
|
evaluation_keys: Optional[EvaluationKeys] = None,
|
|
function_name: str = 'main'
|
|
) → Union[Value, Tuple[Value, ]]
|
|
```
|
|
|
|
Evaluate.
|
|
|
|
|
|
|
|
**Args:**
|
|
*args (Optional[Union[Value, Tuple[Optional[Value], ...]]]): argument(s) for evaluation
|
|
|
|
evaluation_keys (Optional[EvaluationKeys], default = None): evaluation keys required for fhe execution
|
|
|
|
function_name (str): The name of the function to run
|
|
|
|
|
|
|
|
**Returns:**
|
|
Union[Value, Tuple[Value, ...]]: result(s) of evaluation
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L247"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `save`
|
|
|
|
```python
|
|
save(path: Union[str, Path], via_mlir: bool = False)
|
|
```
|
|
|
|
Save the server into the given path in zip format.
|
|
|
|
|
|
|
|
**Args:**
|
|
path (Union[str, Path]): path to save the server
|
|
|
|
via_mlir (bool, default = False): export using the MLIR code of the program, this will make the export cross-platform
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L487"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `size_of_inputs`
|
|
|
|
```python
|
|
size_of_inputs(function: str = 'main') → int
|
|
```
|
|
|
|
Get size of the inputs of the compiled program.
|
|
|
|
---
|
|
|
|
<a href="../../frontends/concrete-python/concrete/fhe/compilation/server.py#L493"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
|
|
|
|
### <kbd>method</kbd> `size_of_outputs`
|
|
|
|
```python
|
|
size_of_outputs(function: str = 'main') → int
|
|
```
|
|
|
|
Get size of the outputs of the compiled program.
|
|
|
|
|