github/tfhe-rs
1
1
Fork 0
mirror of https://github.com/zama-ai/tfhe-rs.git synced 2026-01-09 14:47:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore(doc): fix TOML

Browse Source
This commit is contained in:
J-B Orfila
2023-04-14 14:31:15 +02:00
committed by Arthur Meyre
parent 343f31e070
commit 7a72dd2619
3 changed files with 18 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -58,7 +58,7 @@ tfhe = { version = "*", features = ["boolean", "shortint", "integer", "x86_64"]
Note: aarch64-based machines are not yet supported for Windows as it's currently missing an entropy source to be able to seed the [CSPRNGs](https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator) used in TFHE-rs
Note that when running code that uses `tfhe-rs`, it is highly recommended
to run in release mode with cargo`s `--release` flag to have the best performances possible,
to run in release mode with cargo's `--release` flag to have the best performances possible,
eg: `cargo run --release`.
Here is a full example evaluating a Boolean circuit:

2
tfhe/docs/high_level_api/serialization.md
View File

@@ -11,7 +11,7 @@ To serialize our data, a [data format](https://serde.rs/#data-formats) should be
[dependencies]
# ...
tfhe = { version = "0.2.0", features = ["integer"]}
tfhe = { version = "0.2.0", features = ["integer","x86_64-unix"]}
bincode = "1.3.3"
```

29
tfhe/docs/high_level_api/tutorial.md
View File

@@ -44,10 +44,13 @@ fn main() {
}
```
Default configuration for x86 Unix machines:
```toml
tfhe = { version = "0.2.0", features = ["integer"]}
tfhe = { version = "0.2.0", features = ["integer", "x86_64-unix"]}
```
Other configurations can be found [here](../getting_started/installation.md).
### Imports.
`tfhe` uses `traits` to have a consistent API for creating FHE types and enable users to write generic functions. To be able to use associated functions and methods of a trait, the trait has to be in scope.
@@ -64,13 +67,8 @@ The first step is the creation of the configuration. The configuration is used t
Creating a configuration is done using the ConfigBuilder type.
In this example, 8-bit unsigned integers with default parameters are used. The `integers` feature must also be enabled, as per the table on the Getting Started page.
{% hint style="info" %}
```toml
tfhe = { version = "0.2.0", features = ["integer"]}
```
{% endhint %}
In this example, 8-bit unsigned integers with default parameters are used. The `integers`
feature must also be enabled, as per the table on the [Getting Started page](../getting_started/installation.md).
The config is done by first creating a builder with all types deactivated. Then, the `uint8` type with default parameters is activated.
@@ -191,10 +189,13 @@ To use the `FheUint8` type, the `integer` feature must be activated:
# Cargo.toml
[dependencies]
# ...
tfhe = { version = "0.2.0", features = ["integer"]}
# Default configuration for x86 Unix machines:
tfhe = { version = "0.2.0", features = ["integer", "x86_64-unix"]}
```
Other configurations can be found [here](../getting_started/installation.md).
```rust
use tfhe::{FheUint8, ConfigBuilder, generate_keys, set_server_key, ClientKey};
use tfhe::prelude::*;
@@ -317,11 +318,13 @@ To use Booleans, the `booleans` feature in our Cargo.toml must be enabled:
```toml
# Cargo.toml
[dependencies]
# ...
tfhe = { version = "0.2.0", features = ["booleans"]}
# Default configuration for x86 Unix machines:
tfhe = { version = "0.2.0", features = ["boolean", "x86_64-unix"]}
```
Other configurations can be found [here](../getting_started/installation.md).
#### function definition
First, the verification function is defined.