Skip to content
Snippets Groups Projects
Commit df718f4d authored by Jean-Loup Farges's avatar Jean-Loup Farges
Browse files

Adding table and a tip w.r.t. CUDA

parent e6ee10af
No related branches found
No related tags found
No related merge requests found
Pipeline #70721 failed
......@@ -21,44 +21,16 @@ The requirements for installing the library are the followings:
#### Configuration of environment variables
| Variable | Default value | Description |
| :------------ |:------------------------------:| ----------------------------------------------------------------------------:|
| AIDGE_INSTALL | <path to env> / lib / libAidge |Path to the installation folder of Aidge, must be the same used for all aidge | dependencies
AIDGE_C_COMPILER
gcc
C Compiler to use
AIDGE_CXX_COMPILER
g++
CXX Compiler to use
AIDGE_BUILD_TYPE
Release
Can either be Release or Debug.
AIDGE_ASAN
OFF
Compile with ASAN for debug.
AIDGE_WITH_CUDA
ON
Compile CUDA kernel for quantization, requires nvcc and aidge_bakcend_cuda.
AIDGE_CMAKE_ARCH
""
Append architecture-specific arguments if provided.
AIDGE_BUILD_GEN
""
To specify a CMake generator (for example Ninja)
| Variable | Default value | Description |
| :----------------- |:------------------------------:| ----------------------------------------------------------------------------:|
| AIDGE_INSTALL | <path to env> / lib / libAidge | Path to the installation folder of Aidge, must be the same used for all aidge dependencies |
| AIDGE_C_COMPILER | gcc | C Compiler to use |
| AIDGE_CXX_COMPILER | g++ | CXX Compiler to use |
| AIDGE_BUILD_TYPE | Release | Can either be Release or Debug |
| AIDGE_ASAN | OFF | Compile with ASAN for debug |
| AIDGE_WITH_CUDA | ON | Compile CUDA kernel for quantization, requires nvcc and aidge_bakcend_cuda |
| AIDGE_CMAKE_ARCH | "" | Append architecture-specific arguments if provided |
| AIDGE_BUILD_GEN | "" | To specify a CMake generator (for example Ninja) |
### Pip installation
``` bash
......@@ -66,7 +38,8 @@ pip install . -v
```
> **TIPS :** Use environment variables to change compilation options :
> - `AIDGE_INSTALL` : to set the installation folder. Defaults to /usr/local/lib. :warning: This path must be identical to aidge_core install path.
> - `AIDGE_PYTHON_BUILD_TYPE` : to set the compilation mode to **Debug** or **Release**
> - `AIDGE_BUILD_TYPE` : to set the compilation mode to **Debug** or **Release**
> - `AIDGE_WITH_CUDA` : if your computer hasn't graphical card, don't forget to set if **OFF**
> - `AIDGE_BUILD_GEN` : to set the build backend with
## User guide
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment