github/concrete
1
1
Fork 0
mirror of https://github.com/zama-ai/concrete.git synced 2026-02-16 15:45:44 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
33cf26196ece764b8f548b0422ffa0dde8eb6975
concrete/docs/dev/api/concrete.fhe.representation.graph.md
Benoit Chevallier-Mames 2424352dbf docs(compiler): update apidocs
2024-04-15 09:37:48 +02:00

516 lines
15 KiB
Markdown
Raw Blame History

<!-- markdownlint-disable -->
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.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.representation.graph`
Declaration of `Graph` class.
**Global Variables**
---------------
- **P_ERROR_PER_ERROR_SIZE_CACHE**
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/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>
## <kbd>class</kbd> `Graph`
Graph class, to represent computation graphs.
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L45"><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],
is_direct: bool = False,
name: str = 'main'
)
```
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L206"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `draw`
```python
draw(
horizontal: bool = False,
save_to: Optional[Path, str] = None,
show: bool = False
) → Path
```
Draw the graph.
That this function requires the python `pygraphviz` package which itself requires the installation of `graphviz` packages
(see https://pygraphviz.github.io/documentation/stable/install.html)
**Args:**
horizontal (bool, default = False): whether to draw horizontally
save_to (Optional[Path], default = None): path to save the drawing a temporary file will be used if it's None
show (bool, default = False): whether to show the drawing using matplotlib
**Returns:**
Path: path to the drawing
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L84"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `evaluate`
```python
evaluate(
*args: Any,
p_error: Optional[float] = None
) → Dict[Node, Union[bool_, integer, floating, ndarray]]
```
Perform the computation `Graph` represents and get resulting values for all nodes.
**Args:**
*args (List[Any]): inputs to the computation
p_error (Optional[float]): probability of error for table lookups
**Returns:**
Dict[Node, Union[np.bool\_, np.integer, np.floating, np.ndarray]]: nodes and their values during computation
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L345"><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,
show_types: bool = True,
show_bounds: bool = True,
show_tags: bool = True,
show_locations: bool = False,
show_assigned_bit_widths: bool = False
) → str
```
Get the textual representation of the `Graph`.
**Args:**
maximum_constant_length (int, default = 25): maximum length of formatted constants
highlighted_nodes (Optional[Dict[Node, List[str]]], default = None): nodes to be highlighted and their corresponding messages
highlighted_result (Optional[List[str]], default = None): messages corresponding to highlighted return line
show_types (bool, default = True): whether to show types of nodes
show_bounds (bool, default = True): whether to show bounds of nodes
show_tags (bool, default = True): whether to show tags of nodes
show_locations (bool, default = False): whether to show line information of nodes
show_assigned_bit_widths (bool, default = False) whether to show assigned bit width of nodes instead of their original bit width
**Returns:**
str: textual representation of the `Graph`
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L581"><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`
```python
format_bit_width_assignments() → str
```
Get the textual representation of bit width assignments of the graph.
**Returns:**
str: textual representation of bit width assignments of the graph
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L564"><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`
```python
format_bit_width_constraints() → str
```
Get the textual representation of bit width constraints of the graph.
**Returns:**
str: textual representation of bit width constraints of the graph
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L917"><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,
is_encrypted_filter: Optional[bool] = None,
custom_filter: Optional[Callable[[Node], bool]] = None
) → Optional[Tuple[int, int]]
```
Get integer range of the graph.
Only nodes after filtering will be used to calculate the result.
**Args:**
tag_filter (Optional[Union[str, List[str], re.Pattern]], default = None): filter for tags
operation_filter (Optional[Union[str, List[str], re.Pattern]], default = None): filter for operations
is_encrypted_filter (Optional[bool], default = None) filter for encryption status
custom_filter (Optional[Callable[[Node], bool]], default = None): flexible filter
**Returns:**
Optional[Tuple[int, int]]: minimum and maximum integer value observed during inputset evaluation if there are no integer nodes matching the query, result is None
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L867"><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,
is_encrypted_filter: Optional[bool] = None,
custom_filter: Optional[Callable[[Node], bool]] = None,
assigned_bit_width: bool = False
) → int
```
Get maximum integer bit-width within the graph.
Only nodes after filtering will be used to calculate the result.
**Args:**
tag_filter (Optional[Union[str, List[str], re.Pattern]], default = None): filter for tags
operation_filter (Optional[Union[str, List[str], re.Pattern]], default = None): filter for operations
is_encrypted_filter (Optional[bool], default = None): filter for encryption status
custom_filter (Optional[Callable[[Node], bool]], default = None): flexible filter
assigned_bit_width (Optional[bool], default = None): whether to query on assigned bit-widths
**Returns:**
int: maximum integer bit-width within the graph if there are no integer nodes matching the query, result is -1
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L621"><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]]]
```
Evaluate the `Graph` using an inputset and measure bounds.
inputset is either an iterable of anything for a single parameter
or
an iterable of tuples of anything (of rank number of parameters) for multiple parameters
e.g.,
.. code-block:: python
inputset = [1, 3, 5, 2, 4] def f(x): ...
inputset = [(1, 2), (2, 4), (3, 1), (2, 2)] def g(x, y): ...
**Args:**
inputset (Union[Iterable[Any], Iterable[Tuple[Any, ...]]]): inputset to use
**Returns:**
Dict[Node, Dict[str, Union[np.integer, np.floating]]]: bounds of each node in the `Graph`
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L731"><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]
```
Get the input nodes of the `Graph`, ordered by their indices.
**Returns:**
List[Node]: ordered input nodes
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L742"><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]
```
Get the output nodes of the `Graph`, ordered by their indices.
**Returns:**
List[Node]: ordered output nodes
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L753"><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]
```
Get predecessors of `node`, ordered by their indices.
**Args:**
node (Node): node whose predecessors are requested
**Returns:**
List[Node]: ordered predecessors of `node`.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L772"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `prune_useless_nodes`
```python
prune_useless_nodes()
```
Remove unreachable nodes from the graph.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L788"><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,
is_encrypted_filter: Optional[bool] = None,
custom_filter: Optional[Callable[[Node], bool]] = None,
ordered: bool = False
) → List[Node]
```
Query nodes within the graph.
Filters work like so: str -> nodes without exact match is skipped List[str] -> nodes without exact match with one of the strings in the list is skipped re.Pattern -> nodes without pattern match is skipped
**Args:**
tag_filter (Optional[Union[str, List[str], re.Pattern]], default = None): filter for tags
operation_filter (Optional[Union[str, List[str], re.Pattern]], default = None): filter for operations
is_encrypted_filter (Optional[bool], default = None) filter for encryption status
custom_filter (Optional[Callable[[Node], bool]], default = None): flexible filter
ordered (bool) whether to apply topological sorting before filtering nodes
**Returns:**
List[Node]: filtered nodes
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L692"><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 `ValueDescription`s within the `Graph` according to measured bounds.
**Args:**
bounds (Dict[Node, Dict[str, Union[np.integer, np.floating]]]): bounds of each node in the `Graph`
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L974"><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.
Process a single graph.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L981"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply`
```python
apply(graph: Graph)
```
Process the graph.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L987"><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]]])
```
Fail processing with an error.
**Args:**
graph (Graph): graph being processed
highlights (Mapping[Node, Union[str, List[str]]]): nodes to highlight along with messages
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/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>
## <kbd>class</kbd> `MultiGraphProcessor`
MultiGraphProcessor base class, to define the API for a multiple graph processing pipeline.
Processes multiple graphs at once.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L1025"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `apply`
```python
apply(graph: Graph)
```
Process a single graph.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/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> `apply_many`
```python
apply_many(graphs: Dict[str, Graph])
```
Process a dictionnary of graphs.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/fhe/representation/graph.py#L987"><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]]])
```
Fail processing with an error.
**Args:**
graph (Graph): graph being processed
highlights (Mapping[Node, Union[str, List[str]]]): nodes to highlight along with messages
Reference in New Issue View Git Blame Copy Permalink