Options Struct
User-provided options at Model construction time. More...
Declaration
Included Headers
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... | |
| 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... | |
| 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::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 Sessions). More... | |
| bool | cleanup_extracted_model_data = true |
|
Whether to clean up the on-disk extracted MPK 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... | |
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 contains 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 204 of file Model.h.
Public Member Attributes
async_queue_depth
|
Depth for internally inserted async queue2 elements.
0 keeps the framework default.
Definition at line 266 of file Model.h.
boxdecode_original_height
|
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 228 of file Model.h.
boxdecode_original_width
|
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 224 of file Model.h.
cleanup_extracted_model_data
|
Whether to clean up the on-disk extracted MPK directory on process exit.
- true (default): per-process extracted MPK data is removed on normal exit.
- false: extracted data stays on disk after the process ends (useful for inspection/reuse).
Definition at line 245 of file Model.h.
decode_type
|
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.
inference_terminal
|
Optional override for where the inference pipeline should terminate.
name_suffix
|
Optional suffix appended to every generated GStreamer element name (use to disambiguate concurrent Sessions).
Definition at line 236 of file Model.h.
nms_iou_threshold
|
BoxDecode IoU threshold for non-max suppression; 0 disables NMS.
- Initialiser
-
= 0.0f
Definition at line 218 of file Model.h.
prepared_runner
|
Experimental prepared-route runner. Defaults off/passthrough.
preprocess
|
Intent-based preprocess interface (resize, color-convert, normalize, quantize, tessellate).
processcvu
|
Simple placement for model-managed processcvu stages.
Example: processcvu.pre_run_target = "EV74"; and processcvu.post_run_target = "A65";.
processmla
|
MLA stage execution options.
score_threshold
|
BoxDecode score threshold; 0 keeps all candidates.
Definition at line 217 of file Model.h.
top_k
|
upstream_name
|
Name of the upstream Node feeding preprocess input (default: "decoder" — i.e., a video decoder).
Definition at line 233 of file Model.h.
verbose
|
Diagnostic verbosity for model construction and route planning.
The documentation for this struct was generated from the following file:
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.