aidge-backend-cpu 0.9.0

CPU implementation of operators of the AIDGE framework

Aidge CPU library

You can find in this folder the library that implements the CPU operators. Those operators can be used on any machine with an Linux OS.

[TOC]

Quick Start

ℹ️ First, make sure to go through installation instructions required for every module.

Dependencies

• aidge_core

# On Windows, from aidge/
# ----------[ C++ development]----------
setup.ps1 -Modules core -Clean -Tests

# ----------[ Python development]----------
setup.ps1 -Modules core -Clean -Tests -Python

# On Unix, from aidge/
# ----------[ C++ development]----------
./setup.sh -m core --clean --tests

# ----------[ Python development]----------
./setup.sh -m core --clean --tests --python

Using setup.ps1

[!NOTE] Windows only* *Unless you installed powershell on your system

# ----------[ C++ development]----------
# From aidge/
setup.ps1 -Modules backend_cpu -Clean -Tests

# ----------[ Python development]----------
# From aidge/
setup.ps1 -Modules backend_cpu -Clean -Tests -Python

[!TIP] Run Get-Help setup.ps1 --Full to display documentation

Using setup.sh

[!NOTE] Unix only*

# ----------[ C++ development]----------
# From aidge/
./setup.sh -m backend_cpu --clean --tests

# ----------[ Python development]----------
# From aidge/
./setup.sh -m backend_cpu --clean --tests --python

[!TIP] Run setup.sh -h to display documentation

Using pip

[!NOTE] If using virtual environment, make sure to use the same for every installation !

# ----------[ Python development]----------
# only in aidge/aidge/aidge_backend_cpu/
pip install . -v

# If you want to install test, do this instead
pip install .[test] -v

# Launch tests using pytest
pytest

[!TIP] -v is to enable verbose mode !

Development mode install

[!WARNING] Experimental Untested & experimental feature, see https://scikit-build-core.readthedocs.io/en/latest/configuration/index.html#editable-installs.

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

Using CMake

[!NOTE] Only for C++ development Don't use this method, if you wish to create a pip package Use pip instead.

A CMakePreset.json is available.

# Configure
cmake --preset clang-debug
# Build
cmake --build --preset clang-debug
# Install
cmake --install
# Test
ctest --test-dir build/

Feel free to create your own presets in CMakeUsersPresets.json by inheriting the ones available in CMakePresets.json.