From 1a66f2c8655c8451824c8b3ef88ce0b6aec77749 Mon Sep 17 00:00:00 2001 From: Benoit Chevallier-Mames Date: Mon, 3 Jan 2022 15:54:45 +0100 Subject: [PATCH] chore: update the doc, few things will not be done for Q4 refs #1111 --- docs/dev/explanation/compilation.md | 2 +- docs/user/basics/benchmarks.md | 4 ---- docs/user/basics/compiling_and_executing.md | 9 +++++---- docs/user/explanation/fhe_and_framework_limits.md | 4 ---- docs/user/howto/printing_and_drawing.md | 5 ----- 5 files changed, 6 insertions(+), 18 deletions(-) diff --git a/docs/dev/explanation/compilation.md b/docs/dev/explanation/compilation.md index fcdad3ee0..454e93dd2 100644 --- a/docs/dev/explanation/compilation.md +++ b/docs/dev/explanation/compilation.md @@ -47,7 +47,7 @@ There are several approaches to compute bounds, and they will be discussed in th The final step is to transform the operation graph to equivalent `MLIR` code. How this is done will be explained in detail in its own chapter. -Once the MLIR is prepared, the rest of the stack, which you can learn more about [here](http://fixme.com/), takes over and completes the compilation process. +Once the MLIR is prepared, the rest of the stack, which you can learn more about [here](http://docs.zama.ai/concrete/), takes over and completes the compilation process. Here is the visual representation of the pipeline: diff --git a/docs/user/basics/benchmarks.md b/docs/user/basics/benchmarks.md index db11ebffd..1dfab3279 100644 --- a/docs/user/basics/benchmarks.md +++ b/docs/user/basics/benchmarks.md @@ -9,10 +9,6 @@ To track our progress over time, we have created a [progress tracker](https://pr Note that we are not limited to these, and we'll certainly add more information (e.g., key generation time, encryption time, inference time, decryption time, etc.) once the explicit inference API is available. -```{warning} -FIXME(all): update the sentence above when the encrypt, decrypt, run_inference, keygen API's are available -``` - Our public benchmarks can be used by competing frameworks or technologies for comparison with **Concrete Framework**. Notably, you can see: - if the same functions can be compiled - what are the discrepancies in the exactness of the evaluations diff --git a/docs/user/basics/compiling_and_executing.md b/docs/user/basics/compiling_and_executing.md index 472b9df8f..c20fd1763 100644 --- a/docs/user/basics/compiling_and_executing.md +++ b/docs/user/basics/compiling_and_executing.md @@ -97,10 +97,11 @@ Be careful about the inputs, though. If you were to run with values outside the range of the inputset, the result might not be correct. ``` -```{warning} -FIXME(benoit): explain the API to encrypt, run_inference, decrypt, keygen etc when they are available - -``` +Today, we cannot simulate a client / server API in python, but it is for very soon. Then, we will have: + - a `keygen` API, which is used to generate both public and private keys + - an `encrypt` API, which happens on the user's device, and is using private keys + - a `run_inference` API, which happens on the untrusted server and only uses public material + - a `encrypt` API, which happens on the user's device to get final clear result, and is using private keys ## Further reading diff --git a/docs/user/explanation/fhe_and_framework_limits.md b/docs/user/explanation/fhe_and_framework_limits.md index 67d672d10..f868f51e5 100644 --- a/docs/user/explanation/fhe_and_framework_limits.md +++ b/docs/user/explanation/fhe_and_framework_limits.md @@ -22,10 +22,6 @@ Since this is an early version of the product, not everything is done, to say th ### Currently executing locally -```{warning} -FIXME(Benoit): we'll see later if this is still a valid limit, #1111 -``` - As of today, the execution of the FHE program is done locally. Notably, in the current version, there is no client (on which we encrypt the private data, or decrypt the returned result) or server (on which the computation is done completely over encrypted data), but a single host. As explained in [this section](future_features.md), this limit will be removed in the next version, such that the **Concrete Framework** can be used in production. ### Currently slow diff --git a/docs/user/howto/printing_and_drawing.md b/docs/user/howto/printing_and_drawing.md index 8ce7c3281..da226d7e9 100644 --- a/docs/user/howto/printing_and_drawing.md +++ b/docs/user/howto/printing_and_drawing.md @@ -1,8 +1,3 @@ -```{warning} -FIXME(all): should we update to the new API or have it for both? -FIXME(all): we should add an example drawing and printing with fusing (so subgraphs) -``` - # Printing and Drawing a FHE circuit Sometimes, it can be useful to print or draw fhe circuits, we provide methods to just do that. Please read [Compiling and Executing](../basics/compiling_and_executing.md) before reading further to see how you can compile your function into an fhe circuit.