Reference

Use this section when you already know what you are building and need exact API details, diagnostics, environment knobs, or release information.

APIs

Generated reference material for Neat application code.

• C++ APIBrowse the generated Neat C++ API reference.
• Python APIBrowse PyNeat bindings and Python-facing runtime APIs.
• Model CompilerReference material for model compilation tooling.

Diagnostics & Runtime

Operational details for debugging, configuration, and runtime behavior.

• TroubleshootingFind symptom-first fixes for common setup, runtime, and pipeline issues.
• Environment VariablesReview runtime and builder environment variables.
• Error CodesMap framework error constants to causes and next steps.
• Plugin Error FormatUnderstand structured error fields reported by GStreamer plugin failures.

Release & Terms

Shared vocabulary, host setup notes, and version history.

• GlossaryLook up terms and acronyms used across the docs.
• SDK Host SetupHost setup notes for Ubuntu, macOS, and Windows.
• Release NotesReview SDK, Model Compiler, and Neat changes by release.