docs: updating the doc a bit

refs #1050
This commit is contained in:
Benoit Chevallier-Mames
2021-12-02 16:46:45 +01:00
committed by Benoit Chevallier
parent 5c3950407c
commit 2f1e41e4fb
29 changed files with 977 additions and 26 deletions

View File

@@ -1,3 +1,10 @@
```{warning}
FIXME(Umut): update a bit, with the new API
FIXME(Umut/Arthur): update a bit to explain things with the tensors and new operations. At the same time, I think we can exhaustively give examples of every supported functions, since we start to have a lot, so maybe, we would just explain a bit?
FIXME(all): actually, I am not even sure we should keep this .md, it can't be exhaustive enough, and looks pretty trivial. What do you think
```
# Arithmetic Operations
In this tutorial, we are going to go over all arithmetic operations available in **Concrete**. Please read [Compiling and Executing](../howto/COMPILING_AND_EXECUTING.md) before reading further to see how you can compile the functions below.

View File

@@ -1,3 +1,7 @@
```{warning}
FIXME(Umut): check it is still valid. I guess yes, but some files may have gone or renamed.
```
# Compilation Artifacts
In this tutorial, we are going to go over the artifact system, which is designed to inspect/debug the compilation process easily.

View File

@@ -0,0 +1,4 @@
```{warning}
FIXME(jordan): do this section, maybe from one .ipynb that you would do
```
# Compiling a Torch Model

View File

@@ -0,0 +1,9 @@
```{warning}
FIXME(Umut): to be done
```
# Indexing
# Slicing

View File

@@ -0,0 +1,14 @@
```{warning}
FIXME(Andrei/Jordan): to be done
```
# Machine Learning Tools
Give examples with matrix multiplications, reshape, relu, sigmoid, flatten, clip, transpose, dot etc
Do we need to speak about batch norm?
Do we need to speak about sum?
Do we need to speak about pools?

View File

@@ -1,3 +1,8 @@
```{warning}
FIXME(Umut): update a bit, with the new API
FIXME(Umut): add the multiTLU case
```
# Table Lookup
In this tutorial, we are going to go over the ways to perform table lookups in **Concrete**. Please read [Compiling and Executing](../howto/COMPILING_AND_EXECUTING.md) before reading further to see how you can compile the functions below.

View File

@@ -1,3 +1,7 @@
```{warning}
FIXME(Arthur): update a bit, with the new API
```
# Working With Floating Points
## An example
@@ -110,6 +114,10 @@ List of supported binary functions if one of the two operators is a constant sca
- true_divide
<!--- gen_supported_ufuncs.py: inject supported operations [END] -->
```{warning}
FIXME(Benoit): see what kind of other supported operations we could list here
```
## Limitations
Floating point support in **Concrete** is very limited for the time being. They can't appear on inputs, or they can't be outputs. However, they can be used in intermediate results. Unfortunately, there are limitations on that front as well.