diff --git a/README.md b/README.md index f62b1166341d6be5ee28972f92da92048b925d49..53c5b3e43bcb7614b278fc4da18d53607597b1ec 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,27 @@ The requirements for installing the library are the followings: - The AIDGE modules aidge_core, aidge_onnx and aidge_backend_cpu - Python (> 3.7) if you intend to use the pybind wrapper +#### 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) | + ### Pip installation ``` bash 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