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
This commit is contained in:
Benoit Chevallier-Mames
2021-12-17 17:33:46 +01:00
committed by Benoit Chevallier
parent f387eaedba
commit d35a183a1e
7 changed files with 16 additions and 15 deletions

View File

@@ -8,4 +8,3 @@ Explanations
terminology_and_structure.md
float-fusing.md
mlir.md
quantization.md

View File

@@ -1,8 +0,0 @@
```{warning}
FIXME(Jordan/Andrei): do this
```
# Quantization in Depth
(as a researcher)

View File

@@ -1,4 +1,4 @@
# Compiling and Executing
# Compiling and Executing a Numpy Function
## Importing necessary components

View File

@@ -7,4 +7,5 @@ Getting Started
intro.md
installing.md
compiling_and_executing.md
../howto/compiling_torch_model.md
benchmarks.md

View File

@@ -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)
```

View File

@@ -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).

View File

@@ -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