This guide aims to help developers who are upgrading from older versions of Concrete ML. Although we cannot cover everything, we have compiled the most important points to assist you in your transition. If you encounter any issues, please do not hesitate to reach out to https://community.zama.ai or ask on the fhe.org Discord.
Please take note of the following changes when upgrading to version 1.0.0:
-
execute_in_fhe
argument in.predict()
methods has been replaced byfhe="disable|simulate|execute"
. Thedisable
option runs the model in Python, whilesimulate
performs a FHE simulation, andexecute
provides actual FHE execution. -
encrypt_run_decrypt
function can now only be executed in FHE. For FHE simulations, please use thesimulate
function instead. -
In some models, the
forward_fhe
function has been renamed tofhe_circuit
for consistency across all models. -
verbose_compilation
parameter has been renamed toverbose
in the compile functions. -
compilation_artifacts
parameter has been renamed toartifacts
. -
use_virtual_lib
parameter inconcrete.ml.torch
has been removed from the following functions:compile_onnx_model
compile_torch_model
compile_brevitas_qat_model
This means that models are now always converted to FHE, and only FHE-friendly models can be compiled.