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

PreprocessOptions	preprocess
	Intent-based preprocess interface (resize, color-convert, normalize, quantize, tessellate). More...
BoxDecodeType	decode_type = BoxDecodeType::Unspecified
	Detection topology to decode. More...
BoxDecodeTypeOption	decode_type_option = BoxDecodeTypeOption::Auto
float	score_threshold = 0.0f
	BoxDecode score threshold; 0 keeps all candidates. More...
float	nms_iou_threshold = ...
	BoxDecode IoU threshold for non-max suppression; 0 disables NMS. More...
int	top_k = 0
	BoxDecode top-K cap; 0 means no cap. More...
SuperPointOptions	superpoint
	SuperPoint profile/output options when decode_type is SuperPoint. More...
int	num_classes = 0
	Number of classes produced by detection heads. More...
YoloXSegPoseOptions	yolox_seg_pose
	YOLOX segmentation/pose-specific settings. More...
int	boxdecode_original_width = 0
	Original-image width hint for BoxDecode coordinate inversion. More...
int	boxdecode_original_height = 0
	Original-image height hint for BoxDecode coordinate inversion. More...
std::optional< ResizeMode >	boxdecode_resize_mode
std::string	upstream_name = "decoder"
	Name of the upstream Node feeding preprocess input (default: "decoder" — i.e., a video decoder). More...
std::string	name_suffix
	Optional suffix appended to every generated GStreamer element name (use to disambiguate concurrent Graphs). More...
bool	cleanup_extracted_model_data = true
	Whether to clean up the on-disk extracted model-archive directory on process exit. More...
VerboseOptions	verbose
	Diagnostic verbosity for model construction and route planning. More...
InferenceTerminalPolicy	inference_terminal
	Optional override for where the inference pipeline should terminate. More...
ProcessCvuOptions	processcvu
	Simple placement for model-managed processcvu stages. More...
ProcessMlaOptions	processmla
	MLA stage execution options. More...
PreparedRunnerOptions	prepared_runner
	Experimental prepared-route runner. Defaults off/passthrough. More...
int	async_queue_depth = 0
	Depth for internally inserted async queue2 elements. More...
AdvancedExecutionOptions	advanced_execution
	Preferred jargon-free execution surface (folded into the legacy fields above at Graph build time). 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 250 of file Model.h.

Public Member Attributes

advanced_execution

AdvancedExecutionOptions simaai::neat::Model::Options::advanced_execution

Preferred jargon-free execution surface (folded into the legacy fields above at Graph build time).

All-unset by default, so it is a no-op unless a field is set.

Definition at line 325 of file Model.h.

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 321 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 282 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 278 of file Model.h.

boxdecode_resize_mode

std::optional<ResizeMode> simaai::neat::Model::Options::boxdecode_resize_mode

Definition at line 283 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 300 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 262 of file Model.h.

decode_type_option

BoxDecodeTypeOption simaai::neat::Model::Options::decode_type_option = BoxDecodeTypeOption::Auto

Definition at line 263 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 306 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 291 of file Model.h.

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 265 of file Model.h.

num_classes

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

Number of classes produced by detection heads.

Set this for detection MPKs whose raw class-head depth cannot be inferred reliably (for example single-class YOLO split heads). 0 keeps legacy inference / MPK-provided metadata.

Definition at line 273 of file Model.h.

prepared_runner

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

Experimental prepared-route runner. Defaults off/passthrough.

Definition at line 317 of file Model.h.

preprocess

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

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

Definition at line 252 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 311 of file Model.h.

processmla

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

MLA stage execution options.

Definition at line 314 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 264 of file Model.h.

superpoint

SuperPointOptions simaai::neat::Model::Options::superpoint

SuperPoint profile/output options when decode_type is SuperPoint.

Definition at line 269 of file Model.h.

top_k

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

BoxDecode top-K cap; 0 means no cap.

Definition at line 267 of file Model.h.

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 288 of file Model.h.

verbose

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

Diagnostic verbosity for model construction and route planning.

Definition at line 303 of file Model.h.

yolox_seg_pose

YoloXSegPoseOptions simaai::neat::Model::Options::yolox_seg_pose

YOLOX segmentation/pose-specific settings.

Definition at line 274 of file Model.h.

---

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

• Model.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.