aidge-learning 0.9.0

Functions and algorithms to train models in the AIDGE framework

aidge_learning

In this module, you can find functions and classes to train your models:

• Optimizer (SGD)
• LRScheduler (ConstantLR, StepLR)
• loss functions (MSE)

Quick Start

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

Dependencies

Aidge dependencies

• aidge_core
• aidge_backend_cpu
  • Only needed for tests.

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

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

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

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

Using setup.ps1

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

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

# ----------[ Python development]----------
# From aidge/
setup.ps1 -Modules learning -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 learning --clean --tests

# ----------[ Python development]----------
# From aidge/
./setup.sh -m learning --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_learning/
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.