Files
concrete/docs/dev/api/concrete.compiler.simulated_value_exporter.md
Benoit Chevallier-Mames 2424352dbf docs(compiler): update apidocs
2024-04-15 09:37:48 +02:00

106 lines
2.7 KiB
Markdown

<!-- markdownlint-disable -->
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_exporter.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
# <kbd>module</kbd> `concrete.compiler.simulated_value_exporter`
SimulatedValueExporter.
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_exporter.py#L18"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
## <kbd>class</kbd> `SimulatedValueExporter`
A helper class to create `Value`s.
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_exporter.py#L21"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `__init__`
```python
__init__(value_exporter: SimulatedValueExporter)
```
Wrap the native C++ object.
**Args:**
value_exporter (_SimulatedValueExporter): object to wrap
**Raises:**
TypeError: if `value_exporter` is not of type `_SimulatedValueExporter`
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_exporter.py#L53"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `export_scalar`
```python
export_scalar(position: int, value: int) Value
```
Export scalar.
**Args:**
position (int): position of the argument within the circuit
value (int): scalar to export
**Returns:**
Value: exported scalar
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_exporter.py#L71"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `export_tensor`
```python
export_tensor(position: int, values: List[int], shape: List[int]) Value
```
Export tensor.
**Args:**
position (int): position of the argument within the circuit
values (List[int]): tensor elements to export
shape (List[int]): tensor shape to export
**Returns:**
Value: exported tensor
---
<a href="../../../compilers/concrete-compiler/compiler/lib/Bindings/Python/concrete/compiler/simulated_value_exporter.py#L41"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
### <kbd>method</kbd> `new`
```python
new(
client_parameters: ClientParameters,
circuitName: str = 'main'
) SimulatedValueExporter
```
Create a value exporter.