Skip to main content

Options Struct

User-provided options at Model construction time. More...

Declaration

struct simaai::neat::Model::Options { ... }

Included Headers

#include <Model.h>

Public Member Attributes Index

PreprocessOptionspreprocess

Intent-based preprocess interface (resize, color-convert, normalize, quantize, tessellate). More...

BoxDecodeTypedecode_type = BoxDecodeType::Unspecified

Detection topology to decode. More...

floatscore_threshold = 0.0f

BoxDecode score threshold; 0 keeps all candidates. More...

floatnms_iou_threshold = ...

BoxDecode IoU threshold for non-max suppression; 0 disables NMS. More...

inttop_k = 0

BoxDecode top-K cap; 0 means no cap. More...

intboxdecode_original_width = 0

Original-image width hint for BoxDecode coordinate inversion. More...

intboxdecode_original_height = 0

Original-image height hint for BoxDecode coordinate inversion. More...

std::stringupstream_name = "decoder"

Name of the upstream Node feeding preprocess input (default: "decoder" — i.e., a video decoder). More...

std::stringname_suffix

Optional suffix appended to every generated GStreamer element name (use to disambiguate concurrent Graphs). More...

boolcleanup_extracted_model_data = true

Whether to clean up the on-disk extracted model-archive directory on process exit. More...

VerboseOptionsverbose

Diagnostic verbosity for model construction and route planning. More...

InferenceTerminalPolicyinference_terminal

Optional override for where the inference pipeline should terminate. More...

ProcessCvuOptionsprocesscvu

Simple placement for model-managed processcvu stages. More...

ProcessMlaOptionsprocessmla

MLA stage execution options. More...

PreparedRunnerOptionsprepared_runner

Experimental prepared-route runner. Defaults off/passthrough. More...

intasync_queue_depth = 0

Depth for internally inserted async queue2 elements. More...

Description

User-provided options at Model construction time.

Most fields have sensible defaults; the most commonly-customized are preprocess (image preprocessing parameters: resize target, color format, normalization mean/std) and the decode_type family (when the MPK contract describes a YOLO-style detection model). Setting these upgrades the framework's basic dtype-bridge stages into fused Generic Preproc / BoxDecode kernels — same kernel slot, more work done in one pass.

See Also

"The dtype contract" (§0.5 of the design deep dive) for when adapters get attached

See Also

PreprocessOptions for the preprocess substructure

See Also

BoxDecodeType for the supported detection topologies

Definition at line 210 of file Model.h.

Public Member Attributes

async_queue_depth

int simaai::neat::Model::Options::async_queue_depth = 0

Depth for internally inserted async queue2 elements.

0 keeps the framework default.

Definition at line 272 of file Model.h.

boxdecode_original_height

int simaai::neat::Model::Options::boxdecode_original_height = 0

Original-image height hint for BoxDecode coordinate inversion.

Deprecated

BoxDecode original image size is now read from preprocess metadata. Kept for transition.

Definition at line 234 of file Model.h.

boxdecode_original_width

int simaai::neat::Model::Options::boxdecode_original_width = 0

Original-image width hint for BoxDecode coordinate inversion.

Deprecated

BoxDecode original image size is now read from preprocess metadata. Kept for transition.

Definition at line 230 of file Model.h.

cleanup_extracted_model_data

bool simaai::neat::Model::Options::cleanup_extracted_model_data = true

Whether to clean up the on-disk extracted model-archive directory on process exit.

  • true (default): per-process extracted model-archive data is removed on normal exit.
  • false: extracted data stays on disk after the process ends (useful for inspection/reuse).

Definition at line 251 of file Model.h.

decode_type

BoxDecodeType simaai::neat::Model::Options::decode_type = BoxDecodeType::Unspecified

Detection topology to decode.

Required for detection models with a BoxDecode stage.

Unspecified is the unset sentinel; if the route requires BoxDecode and this stays Unspecified, the build fails fast with an actionable error. Set to one of the supported topologies (YoloV5, YoloV8, DETR, EffDet, …) when loading a detection model.

Definition at line 222 of file Model.h.

inference_terminal

InferenceTerminalPolicy simaai::neat::Model::Options::inference_terminal

Optional override for where the inference pipeline should terminate.

Definition at line 257 of file Model.h.

name_suffix

std::string simaai::neat::Model::Options::name_suffix

Optional suffix appended to every generated GStreamer element name (use to disambiguate concurrent Graphs).

Definition at line 242 of file Model.h.

242 std::string name_suffix;

nms_iou_threshold

float simaai::neat::Model::Options::nms_iou_threshold

BoxDecode IoU threshold for non-max suppression; 0 disables NMS.

Initialiser
= 0.0f

Definition at line 224 of file Model.h.

prepared_runner

PreparedRunnerOptions simaai::neat::Model::Options::prepared_runner

Experimental prepared-route runner. Defaults off/passthrough.

Definition at line 268 of file Model.h.

preprocess

PreprocessOptions simaai::neat::Model::Options::preprocess

Intent-based preprocess interface (resize, color-convert, normalize, quantize, tessellate).

Definition at line 212 of file Model.h.

processcvu

ProcessCvuOptions simaai::neat::Model::Options::processcvu

Simple placement for model-managed processcvu stages.

Example: processcvu.pre_run_target = "EV74"; and processcvu.post_run_target = "A65";.

Definition at line 262 of file Model.h.

processmla

ProcessMlaOptions simaai::neat::Model::Options::processmla

MLA stage execution options.

Definition at line 265 of file Model.h.

score_threshold

float simaai::neat::Model::Options::score_threshold = 0.0f

BoxDecode score threshold; 0 keeps all candidates.

Definition at line 223 of file Model.h.

223 float score_threshold = 0.0f;

top_k

int simaai::neat::Model::Options::top_k = 0

BoxDecode top-K cap; 0 means no cap.

Definition at line 226 of file Model.h.

226 int top_k = 0;

upstream_name

std::string simaai::neat::Model::Options::upstream_name = "decoder"

Name of the upstream Node feeding preprocess input (default: "decoder" — i.e., a video decoder).

Definition at line 239 of file Model.h.

239 std::string upstream_name = "decoder";

verbose

VerboseOptions simaai::neat::Model::Options::verbose

Diagnostic verbosity for model construction and route planning.

Definition at line 254 of file Model.h.


The documentation for this struct was generated from the following file:


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.