Compatibility
This page is a version-compatibility reference, not a setup step.
Standard SDK installation already installs compatible defaults. To set up for the first time, first find out the DevKit software version, then check the Palette SDK — including its host requirements. Use the tables below only to pin versions, mix components across firmware versions, or diagnose a mismatch.
Use this page as a reference when you need to choose exact versions, upgrade one component independently, troubleshoot a version mismatch, or prepare a release. If you are setting up Palette SDK for the first time, start with the Palette SDK and Neat Library pages. Those flows install supported default combinations.
Palette SDK has several versioned components. In most cases, compatibility comes down to two rules:
- The Neat Library and Palette SDK must both be compatible with the DevKit software version they run or build against.
- The Model Compiler must be compatible with the Palette SDK or host environment where it is installed.
Each Palette SDK release series targets a specific DevKit software version. Patch revisions on the SDK may add tooling fixes without requiring a new DevKit image. For example, Palette SDK 2.1.3.x releases, including 2.1.3.0, are compatible with DevKit software 2.1.3.
You can also install a newer compatible Neat Library without reinstalling the SDK, as long as you use the pairing shown in the table below. For example, use Neat Library 0.6.1 with Palette SDK 3.0.0.1.
The versions listed on this page are the supported version combinations.
DevKit
Every Modalix DevKit ships with a specific DevKit software version. Check that version before choosing a Palette SDK or Neat Library version.
The compatibility tables below are keyed from the DevKit software version because the on-device runtime, firmware, and system packages are installed as a matched set.
After gaining shell access to the DevKit, check the installed software version. You can open a shell through SSH when the DevKit is reachable on the network, or through the serial console. For serial access instructions, see Set Up Serial Access.
devkit$cat /etc/buildinfoIf the DevKit software version is not compatible with the Neat Library version
you are trying to install, sima-cli neat install blocks the install instead
of mixing incompatible runtime components on the device. In that case, either
install a Neat Library version that supports your current DevKit software, or
update the DevKit firmware first.
For instructions on checking and updating DevKit firmware, see Firmware Update.
Palette SDK
Use this table to verify that the Palette SDK matches your DevKit software version.
| Palette SDK | Compatible host environment | Compatible DevKit software |
|---|---|---|
| 2.0.0 | Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon | 2.0.0 |
| 2.1.2.3 | Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon | 2.1.2 |
| 2.1.3.0 | Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon | 2.1.3 |
| 2.1.3.1 | Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon | 2.1.3 |
| 3.0.0.0 | Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon | 3.0.0 |
| 3.0.0.1 | Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon | 3.0.0 |
Install an exact SDK version compatible with your DevKit software. For example, install Palette SDK 3.0.0.1 for DevKit software 3.0.0 from the host:
host$sima-cli neat install sdk@v3.0.0.1See Install a specific SDK version for exact tags and release channels.
Only SDK 2.0.0, 2.1.2.0, and 2.1.2.1 require the Two Step SDK Installation.
Neat Library
Use this table to choose the Neat Library version to install or update in your Palette SDK and on your DevKit.
| Neat Library | Compatible Palette SDK | Compatible DevKit software | Notes |
|---|---|---|---|
| 0.1.0 | 2.0.0 | 2.0.0 | Maintained for the 2.0 firmware. |
| 0.2.2 | 2.1.2.2 | 2.1.2 | Latest 0.2 release. |
| 0.3.0 | 2.1.2.3 | 2.1.2 | Latest 0.3 release. |
| 0.4.0 | 2.1.3.0 | 2.1.3 | Supported release. |
| 0.5.0 | 2.1.3.1 | 2.1.3 | Supported release. |
| 0.6.0 | 3.0.0.0 | 3.0.0 | Supported release. |
| 0.6.1 | 3.0.0.1 | 3.0.0 | Current release. |
The DevKit software version matters because the on-device runtime, firmware, and system packages are installed as a matched set. If you mix components across firmware versions, unexpected behavior can occur even when your application builds.
You normally do not run these commands during first-time setup — the SDK installs a compatible Neat Library for you. Use them only to pin a specific Neat Library version from within a compatible Palette SDK or directly on the DevKit.
For Neat Library 0.6.1:
sdk or devkit$sima-cli neat install core@v0.6.1For Neat Library 0.1.0:
sdk or devkit$sima-cli neat install core@v0.1.0Neat Apps
Neat Apps versions are independent from Neat Library versions. Installing Apps automatically installs the compatible Neat Library version.
| Neat Apps | Compatible Neat Library |
|---|---|
| 0.4.0 | 0.3.0 |
| 0.5.0 | 0.4.0 |
| 0.5.1 | 0.5.0 |
| 0.6.0 | 0.6.0 |
| 0.6.1 | 0.6.1 |
Install Apps 0.6.1 from a compatible Palette SDK or DevKit:
sdk or devkit$sima-cli neat install apps@v0.6.1Model Compiler
The Model Compiler is required when you compile or quantize models yourself, including GenAI models, and is optional only if you exclusively use precompiled model packages. Use this table when you do need it.
The Model Compiler can be installed in two ways:
- inside a compatible Palette SDK. In this mode, use any host OS supported by that Palette SDK version. This is the path documented in Install Model Compiler.
- directly on a supported Ubuntu host machine or VM. In this mode, the host OS must match the Model Compiler host requirement below. See Install Model Compiler for the install commands.
During SDK install/setup, the setup flow prompts you to install the matching Model Compiler version automatically when one is available for your environment.
| Model Compiler | Compatible Palette SDK | Compatible host environment | Notes |
|---|---|---|---|
| 2.0.0 | 2.0.0 | Ubuntu 22.04 x86_64 | No Apple Silicon or aarch64/Linux support. |
| 2.1.2 | 2.1.2.3 | Ubuntu 24.04 x86_64 / aarch64 | Apple Silicon is supported by installing inside Palette SDK. |
| 2.1.3 | 2.1.3.0 | Ubuntu 24.04 x86_64 / aarch64 | Apple Silicon is supported by installing inside Palette SDK. |
| 2.1.3.1 | 2.1.3.1 | Ubuntu 24.04 x86_64 / aarch64 | Apple Silicon is supported by installing inside Palette SDK. |
| 3.0.0 | 3.0.0.0 | Ubuntu 24.04 x86_64 / aarch64 | Apple Silicon is supported by installing inside Palette SDK. |
| 3.0.0.1 | 3.0.0.1 | Ubuntu 24.04 x86_64 / aarch64 | Apple Silicon is supported by installing inside Palette SDK. |
The host environment column applies to standalone Model Compiler installs. For example, a customer on an Ubuntu 22.04 host can still use Model Compiler 2.1.3 by installing it inside Palette SDK 2.1.3.0, because the Palette SDK provides the compatible Ubuntu 24.04-based container environment.
For installation steps, see Install Model Compiler.
Verify Versions
From inside the Palette SDK or on the DevKit, run:
sdk or devkit$neatThe output example below shows the active environment, Palette SDK version, installed component versions, and whether updates are available:
Neat Environment
Mode Palette SDK
SDK Version 3.0.0_Palette_SDK_neat_v3.0.0.1
Platform Version 3.0.0
Sysroot /opt/toolchain/aarch64/modalix
Update check online
Components
Neat core 0.6.1 channel=release env=prod latest=0.6.1
PyNeat 0.6.1
neat-runtime 0.6.1
neat-gst-plugins 0.6.1
neat-llima 0.6.1
neat-insight 0.0.9 channel=release status=Running venv=/opt/neat-insight/venv
Model Compiler not installed
Update available: yellow component versions indicate available updates.
Run: neat update.
Use this output to confirm that your Neat Library, DevKit software, and optional Model Compiler are from a supported version combination.