Skip to content

Commit

Permalink
chore(tfhe): bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
IceTDrinker committed Feb 28, 2024
1 parent 8e17e31 commit 84e61c2
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion tfhe/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tfhe"
version = "0.4.3"
version = "0.4.4"
edition = "2021"
readme = "../README.md"
keywords = ["fully", "homomorphic", "encryption", "fhe", "cryptography"]
Expand Down
8 changes: 4 additions & 4 deletions tfhe/docs/core_crypto/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.4.3", features = [ "x86_64-unix" ] }
tfhe = { version = "0.4.4", features = [ "x86_64-unix" ] }
```

This enables the `x86_64-unix` feature to have efficient implementations of various algorithms for `x86_64` CPUs on a Unix-like system. The 'unix' suffix indicates that the `UnixSeeder`, which uses `/dev/random` to generate random numbers, is activated as a fallback if no hardware number generator is available (like `rdseed` on `x86_64` or if the [`Randomization Services`](https://developer.apple.com/documentation/security/1399291-secrandomcopybytes?language=objc) on Apple platforms are not available). To avoid having the `UnixSeeder` as a potential fallback or to run on non-Unix systems (e.g., Windows), the `x86_64` feature is sufficient.
Expand All @@ -19,19 +19,19 @@ For Apple Silicon, the `aarch64-unix` or `aarch64` feature should be enabled. `a
In short: For `x86_64`-based machines running Unix-like OSes:

```toml
tfhe = { version = "0.4.3", features = ["x86_64-unix"] }
tfhe = { version = "0.4.4", features = ["x86_64-unix"] }
```

For Apple Silicon or aarch64-based machines running Unix-like OSes:

```toml
tfhe = { version = "0.4.3", features = ["aarch64-unix"] }
tfhe = { version = "0.4.4", features = ["aarch64-unix"] }
```

For `x86_64`-based machines with the [`rdseed instruction`](https://en.wikipedia.org/wiki/RDRAND) running Windows:

```toml
tfhe = { version = "0.4.3", features = ["x86_64"] }
tfhe = { version = "0.4.4", features = ["x86_64"] }
```

### Commented code to double a 2-bit message in a leveled fashion and using a PBS with the `core_crypto` module.
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 @@ -8,12 +8,12 @@ To use `TFHE-rs` in your project, you first need to add it as a dependency in yo

If you are using an `x86` machine:
```toml
tfhe = { version = "0.4.3", features = [ "boolean", "shortint", "integer", "x86_64-unix" ] }
tfhe = { version = "0.4.4", features = [ "boolean", "shortint", "integer", "x86_64-unix" ] }
```

If you are using an `ARM` machine:
```toml
tfhe = { version = "0.4.3", features = [ "boolean", "shortint", "integer", "aarch64-unix" ] }
tfhe = { version = "0.4.4", features = [ "boolean", "shortint", "integer", "aarch64-unix" ] }
```

{% hint style="info" %}
Expand Down
2 changes: 1 addition & 1 deletion tfhe/docs/getting_started/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ fn main() {

The default configuration for x86 Unix machines:
```toml
tfhe = { version = "0.4.3", features = ["integer", "x86_64-unix"]}
tfhe = { version = "0.4.4", features = ["integer", "x86_64-unix"]}
```

Configuration options for different platforms can be found [here](../getting_started/installation.md). Other rust and homomorphic types features can be found [here](../how_to/rust_configuration.md).
Expand Down
28 changes: 14 additions & 14 deletions tfhe/docs/how_to/migrate_data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Managing Data Through Various TFHE-rs Versions

In what follows, the process to manage data when upgrading the TFHE-rs version (starting from the 0.4.3 release) is given. This page details the methods to make data, which have initially been generated with an older version of TFHE-rs, usable with a newer version.
In what follows, the process to manage data when upgrading the TFHE-rs version (starting from the 0.4.4 release) is given. This page details the methods to make data, which have initially been generated with an older version of TFHE-rs, usable with a newer version.

## Forward Compatibility Strategy

Expand All @@ -18,12 +18,12 @@ To be able to use older serialized data with newer versions, the following is do
In practice, if we take the 0.5 release as a concrete example, here is what will happen:

- 0.5.0 is released with breaking changes to the serialization;
- 0.4.3 has tfhe@0.5.0 as optional dependency gated by the `forward_compatibility` feature;
- Conversion code is added to 0.4.3, if possible without any user input, but some data migration will likely require some information to be provided by the developer writing the migration code;
- 0.4.3 is released.
- 0.4.4 has tfhe@0.5.0 as optional dependency gated by the `forward_compatibility` feature;
- Conversion code is added to 0.4.4, if possible without any user input, but some data migration will likely require some information to be provided by the developer writing the migration code;
- 0.4.4 is released.

{% hint style="info" %}
Note that if you do not need forward compatibility 0.4.3 will be equivalent to 0.4.1 from a usability perspective and you can safely update.
Note that if you do not need forward compatibility 0.4.4 will be equivalent to 0.4.1 from a usability perspective and you can safely update.
Note also that the 0.5.0 has no knowledge of previous releases.
{% endhint %}

Expand All @@ -36,10 +36,10 @@ Examples to migrate data:
An `Application` uses TFHE-rs 0.4.1 and needs/wants to upgrade to 0.5.0 to benefit from various improvements.

Example timeline of the data migration or `Bulk Data Migration`:
- A new transition version of the `Application` is compiled with the 0.4.3 release of TFHE-rs;
- A new transition version of the `Application` is compiled with the 0.4.4 release of TFHE-rs;
- The transition version of the `Application` adds code to read previously stored data, convert it to the proper format for 0.5.0 and save it back to disk;
- The service enters a maintenance period (if relevant);
- Migration of data from 0.4.3 to 0.5.0 is done with the transition version of the `Application`, note that depending on the volume of data this transition can take a significant amount of time;
- Migration of data from 0.4.4 to 0.5.0 is done with the transition version of the `Application`, note that depending on the volume of data this transition can take a significant amount of time;
- The updated version of the `Application` is compiled with the 0.5.0 release of TFHE-rs and put in production;
- Service is resumed with the updated `Application` (if relevant).

Expand All @@ -48,18 +48,18 @@ The above case is describing a simple use case, where only a single version of d
In order to manage more complicated cases, another method called `Migrate On Read` can be used.

Here is an example timeline where data is migrated only as needed with the `Migrate On Read` approach:
- A new version of the `Application` is compiled, it has tfhe@0.4.3 as dependency (the dependency will have to be renamed to avoid conflicts, a possible name is to use the major version like `tfhe_0_4`) and tfhe@0.5.0 which will not be renamed and can be accessed as `tfhe`
- A new version of the `Application` is compiled, it has tfhe@0.4.4 as dependency (the dependency will have to be renamed to avoid conflicts, a possible name is to use the major version like `tfhe_0_4`) and tfhe@0.5.0 which will not be renamed and can be accessed as `tfhe`
- Code to manage reading the data is added to the `Application`:
- The code determines whether the data was saved with the 0.4 `Application` or the 0.5 `Application`, if the data is already up to date with the 0.5 format it can be loaded right away, if it's in the 0.4 format the `Application` can check if an updated version of the data is already available in the 0.5 format and loads that if it's available, otherwise it converts the data to 0.5, saves the converted data to avoid having to convert it every time it is accessed and continue processing with the 0.5 data

The above is more complicated to manage as data will be present on disk with several versions, however it allows to run the service continuously or near-continuously once the new `Application` is deployed (it will require careful routing or error handling as nodes with outdated `Application` won't be able to process the 0.5 data).

Also, if required, several version of TFHE-rs can be "chained" to upgrade very old data to newer formats.
The above pattern can be extended to have `tfhe_0_4` (tfhe@0.4.3 renamed), `tfhe_0_5` (tfhe@0.5.0 renamed) and `tfhe` being tfhe@0.6.0, this will require special handling from the developers so that their protocol can handle data from 0.4.3, 0.5.0 and 0.6.0 using all the conversion tooling from the relevant version.
The above pattern can be extended to have `tfhe_0_4` (tfhe@0.4.4 renamed), `tfhe_0_5` (tfhe@0.5.0 renamed) and `tfhe` being tfhe@0.6.0, this will require special handling from the developers so that their protocol can handle data from 0.4.4, 0.5.0 and 0.6.0 using all the conversion tooling from the relevant version.

E.g., if some computation requires data from version 0.4.3 a conversion function could be called `upgrade_data_from_0_4_to_0_6` and do:
E.g., if some computation requires data from version 0.4.4 a conversion function could be called `upgrade_data_from_0_4_to_0_6` and do:

- read data from 0.4.3
- read data from 0.4.4
- convert to 0.5.0 format using `tfhe_0_4`
- convert to 0.6.0 format using `tfhe_0_5`
- save to disk in 0.6.0 format
Expand All @@ -80,8 +80,8 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
# The project used tfhe 0.4.1, it now depends on the 0.4.3 with the forward compatibility code
tfhe_0_4 = { package = "tfhe", version = "0.4.3", features = [
# The project used tfhe 0.4.1, it now depends on the 0.4.4 with the forward compatibility code
tfhe_0_4 = { package = "tfhe", version = "0.4.4", features = [
"x86_64-unix",
"boolean",
"shortint",
Expand Down Expand Up @@ -137,6 +137,6 @@ The noise level here is set at `usize::MAX` on a 64 bits system, it corresponds

## Breaking changes and additional migration information

The main breaking change going from 0.4.3 to 0.5.0 with respect to data migration is that the High Level API dropped support for `shortint`. The `boolean` format has changed to use `integer`'s `BooleanBlock` under the hood.
The main breaking change going from 0.4.4 to 0.5.0 with respect to data migration is that the High Level API dropped support for `shortint`. The `boolean` format has changed to use `integer`'s `BooleanBlock` under the hood.

This means that any data coming from the High Level API which previously used `boolean` or `shortint` is not supported for the data migration.
2 changes: 1 addition & 1 deletion tfhe/docs/how_to/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To serialize our data, a [data format](https://serde.rs/#data-formats) should be

[dependencies]
# ...
tfhe = { version = "0.4.3", features = ["integer","x86_64-unix"]}
tfhe = { version = "0.4.4", features = ["integer","x86_64-unix"]}
bincode = "1.3.3"
```

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 @@ -24,7 +24,7 @@ To use the `FheUint8` type, the `integer` feature must be activated:

[dependencies]
# Default configuration for x86 Unix machines:
tfhe = { version = "0.4.3", features = ["integer", "x86_64-unix"]}
tfhe = { version = "0.4.4", features = ["integer", "x86_64-unix"]}
```

Other configurations can be found [here](../getting_started/installation.md).
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 @@ -21,7 +21,7 @@ To use Booleans, the `booleans` feature in our Cargo.toml must be enabled:
# Cargo.toml

# Default configuration for x86 Unix machines:
tfhe = { version = "0.4.3", features = ["boolean", "x86_64-unix"]}
tfhe = { version = "0.4.4", features = ["boolean", "x86_64-unix"]}
```

Other configurations can be found [here](../getting_started/installation.md).
Expand Down

0 comments on commit 84e61c2

Please sign in to comment.