Skip to main content

Compatibility

Palette Neat has several versioned components. In most cases, compatibility comes down to two rules:

  1. The Neat Library and Neat Development Environment must both be compatible with the DevKit software version they run or build against.
  2. The Model Compiler must be compatible with the Neat Development Environment or host environment where it is installed.

The Neat Development Environment includes a Neat Library version. You can install a newer compatible Neat Library without reinstalling the Neat Development Environment. For example, use Neat Library 0.2.x with the 2.1.2 Neat Development Environment.

note

The versions listed on this page are the supported version combinations.

Neat Library

Use this table to choose the Neat Library version to install or update in your Neat Development Environment and on your DevKit.

Neat LibraryCompatible Neat Development EnvironmentCompatible DevKit softwareNotes
0.1.02.0.02.0.0Maintained for the 2.0 release family.
0.2.02.1.22.1.2Current development target.

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 release families, unexpected behavior can occur even when your application builds.

Install the Neat Library from within a compatible Neat Development Environment or directly on the DevKit:

For Neat Library 0.1.0:

sima-cli neat install core@0.1.0

For Neat Library 0.2.0:

sima-cli neat install core@0.2.0

Neat Development Environment

Use this table to choose the Neat Development Environment version to run on your host machine.

Neat Development EnvironmentCompatible host environmentCompatible DevKit software
2.0.0Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon2.0.0
2.1.2Windows 11 through WSL, Ubuntu 22.04 or 24.04, latest macOS on Apple Silicon2.1.2

Install a specific Neat Development Environment version with:

For Neat Development Environment 2.0.0:

sima-cli install ghcr:sima-neat/sdk-v2.0.0

For Neat Development Environment 2.1.2:

sima-cli install ghcr:sima-neat/sdk-v2.1.2

Model Compiler

Use this table only when you need to compile or validate models yourself. If you use precompiled model packages, you usually do not need the Model Compiler.

The Model Compiler can be installed in two ways:

  • inside a compatible Neat Development Environment
  • directly on a supported Ubuntu host machine or VM

During sima-cli sdk setup, the setup flow prompts you to install the matching Model Compiler version when one is available for your environment.

Model CompilerCompatible Neat Development EnvironmentCompatible host environmentNotes
2.0.02.0.0Ubuntu 22.04 x86_64No Apple Silicon or aarch64/Linux support.
2.1.22.1.2Ubuntu 24.04 x86_64 / aarch64Apple Silicon is supported by installing inside Neat Development Environment.

For a standalone Model Compiler installation, run the command that matches your host architecture:

For Model Compiler 2.0.0 on amd64 hosts:

sima-cli install -v 2.0.0 tools/model-compiler/amd64

For Model Compiler 2.1.2 on amd64 hosts:

sima-cli install -v 2.1.2 tools/model-compiler/amd64

For Model Compiler 2.1.2 on arm64 hosts:

sima-cli install -v 2.1.2 tools/model-compiler/arm64

Verify Versions

From inside the Neat Development Environment or on the DevKit, run:

neat

The output example below shows the active environment, SDK version, installed component versions, and whether updates are available:

Neat Environment
Mode Neat SDK
SDK Version 2.1.2_Palette_SDK_neat_develop_27498f5
Sysroot /opt/toolchain/aarch64/modalix
Update check online

Components
Neat core 0.2.0 channel=develop env=prod latest=24d60ac594bb
PyNeat 0.2.0
neat-runtime 0.2.0
neat-gst-plugins 0.2.0
neat-llima 0.2.0
neat-insight 0.0.0+main.e10ab17 channel=main latest=dd9e3e0 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.