aidge-export-cpp

Aidge CPP Export

This module depends on aidge_core and registers generic C++ implementations for DNN operators.

Examples

If you want to generate exports and/or better understand how it works in Aidge, you may take a look at the following resources :

• Example Scripts : Python scripts examples to export common models;
• Export Tutorials : Notebooks to better understand the export process (you may find these tutorials on the Aidge documentation page as well);
• User Guide : Theoretical guides detailing the export structure.

Quick start

System Requirements

• python >= 3.10

pip install aidge-export-cpp

Static analysis of generated C/C++ code

Host C++ exports provide opt-in strict compilation and blocking analysis with Cppcheck and Clang-Tidy. These tools are system dependencies: installing Aidge does not install them. Install the profiles you intend to use and ensure the executables are available in PATH.

For example, on Debian or Ubuntu:

sudo apt install cppcheck clang-tidy

Select a profile through the Python export configuration:

from aidge_core.export_utils import export
from aidge_core.export_utils.config import ExportConfig

export(
    graph=model,
    config=ExportConfig(
        target="host",
        export_folder="export_model_float32_host",
        static_analysis="static-analysis",
    ),
    input_tensors=[input_tensor],
)

static_analysis is disabled by default. It accepts the following values:

Passing True is a convenience equivalent to running static-analysis and strict. Passing False or None disables the feature.

The same profiles are available as standalone targets in a generated host export:

cmake -S . -B build
cmake --build build --target strict
cmake --build build --target cppcheck
cmake --build build --target cppcheck-strict
cmake --build build --target clang-tidy
cmake --build build --target clang-tidy-strict
cmake --build build --target static-analysis
cmake --build build --target static-analysis-strict

The regular executable remains at build/run_export. The strict target writes its separate executable to build/strict/run_export. Analysis requested via the Python API is currently supported only by CMake-based exports; requesting it for a Make-based bare-metal target raises an explicit error.

🛠 Build from Source

Prerequisite (in addition to previous one):

• Please review the global installation instructions before proceeding.
• If using a virtual environment, use the same one for all Aidge modules.

1. Python installation using setup scripts

[!TIP] Use Get-Help setup.ps1 (Windows) or ./setup.sh -h (Unix) for full documentation.

2. Python Installation using pip

Run these commands from the aidge_export_cpp/ directory:

#fStandard install
pip install . -v

# Install with testing dependencies
pip install .[test] -v && pytest

Editable Install (Experimental)

Use this for real-time development without re-installing.

pip install --no-build-isolation -ve . --config-settings=editable.rebuild=true -Cbuild-dir=build

Export Support

The following models have been tested :

On the table above, validation is done using the aidge_cmp option, which evaluates the results between the aidge_backend_cpu and aidge_export_cpp kernels, with an absolute precision of 10^-3 (for float exports).

An example script is provided for each of these models (examples/export_<model_name>/<model_name>.py).