Skip to content
Snippets Groups Projects
Commit e9edab2b authored by Nathan Thoumine's avatar Nathan Thoumine
Browse files

Add a table to show the possibilities the Makefile offers.

parent 75c7d9e1
No related branches found
No related tags found
No related merge requests found
......@@ -34,11 +34,30 @@ import aidge_export_tensorrt
aidge_export_tensorrt.export("export_trt", "model.onnx")
```
The export povides a Makefile with several options to use the export on your machine. <br>
You can generate a C++ export or a Python export.
You also have the possibility to compile the export or/and the Python library by using Docker if your host machine doesn't have the correct packages. <br>
All of these options are resumed in the helper of the Makefile (run `make help` in the export folder for more details).
The export provides a Makefile with several options to utilize the export on your machine. You can generate either a C++ export or a Python export. <br>
Additionally, you have the option to compile the export and/or the Python library using Docker if your host machine lacks the necessary packages.
The available commands are summarized in the following table:
| Command | Description |
|-------------------------------|--------------------------------------------------------------------------------------------|
| `make / make help` | Display the different options available |
| `make build_cpp` | Compile the export on host for C++ apps (generate an executable in build/bin) |
| `make build_lib_python` | Compile the export on host for Python apps (generate a python lib in build/lib) |
| `make build_image_docker` | Generate the docker image of the tensorrt compiler |
| `make build_cpp_docker` | Compile the export in a container for C++ apps (generate an executable in build/bin) |
| `make test_cpp_docker` | Test the executable for C++ apps in a container |
| `make build_lib_python_docker`| Compile the export in a container for Python apps (generate a python lib in build/lib) |
| `make test_lib_python_docker` | Test the lib for Python apps in a container |
| `make clean` | Clean up the build and bin folders |
Here's an example to compile and test the export Python library using Docker:
```
cd export_trt/
make build_lib_python_docker
make test_lib_python_docker
```
This will execute the `test.py` file within the Docker container, initializing and profiling the selected model.
## Known issue
......
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