Skip to content

Release v0.4.0

Choose a tag to compare

@github-actions github-actions released this 23 Jul 22:52
c15d17c

Neat Apps v0.4.0

Neat Apps v0.4.0 introduces a complete prebuilt Apps workflow. Developers can install and run all 14 examples without cloning the repository or compiling the applications.

The installer also installs the exact Neat Library version used to compile and validate the applications, together with the latest Neat Insight release.

Highlights

Prebuilt Applications

  • Installs one runnable prebuilt-apps/ bundle.
  • Includes 11 prebuilt C++ executables under each applicable example’s src/cpp/pre-built/ directory.
  • Includes C++ reference source, Python applications, configurations, READMEs, and runtime datasets.
  • Packages all 14 examples independently of internal test coverage.
  • Excludes models, tests, test datasets, build files, and portal-only assets.

Reproducible Neat Library Installation

  • Installs the exact Neat Library artifact used to compile and validate the Apps package.
  • Apps v0.4.0 uses Neat Library v0.3.0 at exact artifact revision 17a7c7788b07.
  • Records the installed Apps and Neat Library revisions under prebuilt-apps/deps/.
  • Installs Neat Insight automatically through sima-cli.

Predictable and Recoverable Upgrades

  • Installs the exact Apps artifact selected by the user instead of discovering candidates from existing directories.
  • Requests confirmation before replacing an existing installation.
  • Preserves the user-managed prebuilt-apps/models/ directory.
  • Retains the remaining previous installation under .prebuilt-apps-backup/.
  • Restores the previous installation if promotion of the new runtime fails.
  • Removes the downloaded archive, extracted package, installer, and dependency scratch files after installation.

Installed-First Documentation

  • Makes the installed bundle the primary workflow across the root and example READMEs.
  • Provides runnable C++ and Python commands using packaged paths.
  • Documents PyNeat activation and model installation through sima-cli, LLiMa, or example-specific commands.
  • Explains how to determine the installed platform version before downloading models.
  • Uses configurable Insight streams instead of repository-specific RTSP endpoints.

Runtime Assets and User-Managed Models

  • Includes 21 COCO images under assets/datasets/ for runtime input.
  • Keeps test datasets outside the customer package.
  • Does not package models. Users can store models under prebuilt-apps/models/ or configure another readable path.

Installation

Install Apps v0.4.0 on a supported Modalix or DevKit target:

sima-cli neat install apps@v0.4.0
cd prebuilt-apps

This command installs the compatible Neat Library artifact and the latest Neat Insight release before promoting the Apps runtime.

Compatibility

Component Version
SiMa.ai Platform 2.1.2
Neat Library v0.3.0
Neat Insight Latest release (v0.0.6 at release time)

Migration Notes

  • Installing Apps v0.4.0 may replace the currently installed Neat Library with v0.3.0:17a7c7788b07.
  • Neat Insight is not pinned by Apps. The installer selects the latest available Insight release.
  • Upgrading an existing Apps installation requires confirmation.
  • User-managed models under prebuilt-apps/models/ survive the upgrade.
  • Other files from the previous installation are retained under .prebuilt-apps-backup/ rather than merged into the new bundle.
  • Only one backup is retained. Replacing an existing backup requires confirmation.
  • Store custom configurations and other persistent user data outside the installer-managed bundle.

Validation

  • The release candidate passed the Apps SDK build and activated strict runtime suite on Modalix through Vulcan.
  • Package validation covers the archive layout, embedded Apps and Core metadata, prebuilt executable placement, runtime datasets, and customer-package exclusions.
  • Installation and upgrade tests cover clean installation, exact candidate selection, model preservation, backup handling, rollback, and cleanup.

Key Included Pull Requests

Full Changelog: v0.3.0...v0.4.0

Contributors

Thank you to everyone who contributed to this release: