Reference

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

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 Compiler APIReference 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.
• Tutorial AssetsControl model archive paths and source-tree tutorial assets.
• BoxDecode Decode TypesChoose decode types and parse packed detection outputs.
• Error CodesMap framework error constants to causes and next steps.
• Plugin Error FormatUnderstand structured error fields reported by GStreamer plugin failures.

Terms & Setup

Shared vocabulary and host setup notes.

• GlossaryLook up terms and acronyms used across the docs.
• SDK Host SetupHost setup notes for Ubuntu, macOS, and Windows.