Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs version to be 0.11 #1920

Merged
merged 1 commit into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tfhe/docs/fundamentals/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ In the following example, we use [bincode](https://crates.io/crates/bincode) for

[dependencies]
# ...
tfhe = { version = "0.10.0", features = ["integer"] }
tfhe = { version = "0.11.0", features = ["integer"] }
bincode = "1.3.3"
```

Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/getting_started/benchmarks/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document summarizes the timings of some homomorphic operations over 64-bit encrypted integers, depending on the hardware. More details are given for [the CPU](cpu\_benchmarks.md), [the GPU](gpu\_benchmarks.md), or [zeros-knowledge proofs](zk\_proof\_benchmarks.md).

You can get the parameters used for benchmarks by cloning the repository and checking out the commit you want to use (starting with the v0.10.0 release) and run the following make command:
You can get the parameters used for benchmarks by cloning the repository and checking out the commit you want to use (starting with the v0.11.0 release) and run the following make command:

```console
make print_doc_bench_parameters
Expand Down
4 changes: 2 additions & 2 deletions tfhe/docs/getting_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This document provides instructions to set up **TFHE-rs** in your project.
First, add **TFHE-rs** as a dependency in your `Cargo.toml`.

```toml
tfhe = { version = "0.10.0", features = ["boolean", "shortint", "integer"] }
tfhe = { version = "0.11.0", features = ["boolean", "shortint", "integer"] }
```

{% hint style="info" %}
Expand Down Expand Up @@ -35,5 +35,5 @@ By default, **TFHE-rs** makes the assumption that hardware AES features are enab
To add support for older CPU, import **TFHE-rs** with the `software-prng` feature in your `Cargo.toml`:

```toml
tfhe = { version = "0.10.0", features = ["boolean", "shortint", "integer", "software-prng"] }
tfhe = { version = "0.11.0", features = ["boolean", "shortint", "integer", "software-prng"] }
```
4 changes: 2 additions & 2 deletions tfhe/docs/getting_started/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ edition = "2021"
Then add the following configuration to include **TFHE-rs**:

```toml
tfhe = { version = "0.10.0", features = ["integer"] }
tfhe = { version = "0.11.0", features = ["integer"] }
```

Your updated `Cargo.toml` file should look like this:
Expand All @@ -71,7 +71,7 @@ version = "0.1.0"
edition = "2021"

[dependencies]
tfhe = { version = "0.10.0", features = ["integer"] }
tfhe = { version = "0.11.0", features = ["integer"] }
```

If you are on a different platform please refer to the [installation documentation](installation.md) for configuration options of other supported platforms.
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/guides/array.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following example shows a complete workflow of working with encrypted arrays
# Cargo.toml

[dependencies]
tfhe = { version = "0.10.0", features = ["integer"] }
tfhe = { version = "0.11.0", features = ["integer"] }
```

```rust
Expand Down
4 changes: 2 additions & 2 deletions tfhe/docs/guides/data_versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ You can load serialized data with the `unversionize` function, even in newer ver

[dependencies]
# ...
tfhe = { version = "0.10.0", features = ["integer"] }
tfhe-versionable = "0.2.0"
tfhe = { version = "0.11.0", features = ["integer"] }
tfhe-versionable = "0.4.0"
bincode = "1.3.3"
```

Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/guides/run_on_gpu.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To use the **TFHE-rs** GPU backend in your project, add the following dependency


```toml
tfhe = { version = "0.10.0", features = ["boolean", "shortint", "integer", "gpu"] }
tfhe = { version = "0.11.0", features = ["boolean", "shortint", "integer", "gpu"] }
```

{% hint style="success" %}
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/references/core-crypto-api/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Welcome to this tutorial about `TFHE-rs` `core_crypto` module.
To use `TFHE-rs`, it first has to be added as a dependency in the `Cargo.toml`:

```toml
tfhe = { version = "0.10.0" }
tfhe = { version = "0.11.0" }
```

### Commented code to double a 2-bit message in a leveled fashion and using a PBS with the `core_crypto` module.
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/tutorials/ascii_fhe_string.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To use the `FheUint8` type, enable the `integer` feature:

[dependencies]
# Default configuration for x86 Unix machines:
tfhe = { version = "0.10.0", features = ["integer"] }
tfhe = { version = "0.11.0", features = ["integer"] }
```

Refer to the [installation guide](../getting\_started/installation.md) for other configurations.
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/tutorials/parity_bit.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This function returns a Boolean (`true` or `false`) so that the total count of `
```toml
# Cargo.toml

tfhe = { version = "0.10.0", features = ["integer"] }
tfhe = { version = "0.11.0", features = ["integer"] }
```

First, define the verification function.
Expand Down
Loading