From d35a183a1ece4ca1db94cad925efaf7d64852dd8 Mon Sep 17 00:00:00 2001 From: Benoit Chevallier-Mames Date: Fri, 17 Dec 2021 17:33:46 +0100 Subject: [PATCH] chore: proposal for doc improvement - add Compiling a Torch Model to the Getting Started - rename to Compiling and Executing a Numpy Function for more clarity - changed the FAQ - removed a .md which is no more needed --- docs/dev/explanation/index.rst | 1 - docs/dev/explanation/quantization.md | 8 -------- docs/user/basics/compiling_and_executing.md | 2 +- docs/user/basics/index.rst | 1 + docs/user/basics/intro.md | 2 +- docs/user/howto/faq.md | 15 ++++++++++++--- docs/user/howto/index.rst | 2 +- 7 files changed, 16 insertions(+), 15 deletions(-) delete mode 100644 docs/dev/explanation/quantization.md diff --git a/docs/dev/explanation/index.rst b/docs/dev/explanation/index.rst index 76f75276f..fa7747868 100644 --- a/docs/dev/explanation/index.rst +++ b/docs/dev/explanation/index.rst @@ -8,4 +8,3 @@ Explanations terminology_and_structure.md float-fusing.md mlir.md - quantization.md diff --git a/docs/dev/explanation/quantization.md b/docs/dev/explanation/quantization.md deleted file mode 100644 index e9c136bbf..000000000 --- a/docs/dev/explanation/quantization.md +++ /dev/null @@ -1,8 +0,0 @@ -```{warning} -FIXME(Jordan/Andrei): do this -``` - -# Quantization in Depth - -(as a researcher) - diff --git a/docs/user/basics/compiling_and_executing.md b/docs/user/basics/compiling_and_executing.md index 31408b55f..eb494c87c 100644 --- a/docs/user/basics/compiling_and_executing.md +++ b/docs/user/basics/compiling_and_executing.md @@ -1,4 +1,4 @@ -# Compiling and Executing +# Compiling and Executing a Numpy Function ## Importing necessary components diff --git a/docs/user/basics/index.rst b/docs/user/basics/index.rst index 2050fd6b1..36d2387ef 100644 --- a/docs/user/basics/index.rst +++ b/docs/user/basics/index.rst @@ -7,4 +7,5 @@ Getting Started intro.md installing.md compiling_and_executing.md + ../howto/compiling_torch_model.md benchmarks.md diff --git a/docs/user/basics/intro.md b/docs/user/basics/intro.md index 8b5be2efa..3faa8af2e 100644 --- a/docs/user/basics/intro.md +++ b/docs/user/basics/intro.md @@ -43,5 +43,5 @@ The main _current_ limits are: To overcome the above limitations, Concrete has a [popular quantization](../explanation/quantization.md) method built in the framework that allows map floating point values to integers. We can [use this approach](../howto/use_quantization.md) to run models in FHE. Lastly, we give hints to the user on how to [reduce the precision](../howto/reduce_needed_precision.md) of a model to make it work in Concrete. ```{warning} -FIXME(Jordan/Andrei): add an .md about the repository of FHE-friendly models (#1212) +FIXME(all: add an .md about the repository of FHE-friendly models (#1212) ``` diff --git a/docs/user/howto/faq.md b/docs/user/howto/faq.md index 2bc5a654c..2247cd8db 100644 --- a/docs/user/howto/faq.md +++ b/docs/user/howto/faq.md @@ -1,14 +1,23 @@ # FAQ -## What is **Concrete**? +## What is **Concrete Framework**? -See [here](../basics/intro.md) +See [here](../basics/intro.md). Also, you can have a look to Zama's [website](https://zama.ai) or to the [Concrete library GitHub](https://github.com/zama-ai/concrete). ## Is it an open source project? +FIXME(Jeremy/AlexQ): would you write a short section here? or link to somewhere on Zama's website + ## Can I use it freely? +See our license in the root of the repository. + ## Can I contribute? -## What are the future features of **Concrete**? +See this [section](../../dev/howto/contributing.md). + +## What are the future features of **Concrete Framework**? + +See this [section](../explanation/future_features.md). + diff --git a/docs/user/howto/index.rst b/docs/user/howto/index.rst index a90cbb427..b3855438b 100644 --- a/docs/user/howto/index.rst +++ b/docs/user/howto/index.rst @@ -6,8 +6,8 @@ How To numpy_support.md printing_and_drawing.md - use_quantization.md compiling_torch_model.md + use_quantization.md reduce_needed_precision.md debug_support_submit_issues.md faq.md