NVIDIA DeepStream SDK API Reference

9.2 Release
ModelBackendInfo Struct Reference

Detailed Description

One row of the backend registry.

Every field answers a question some call site used to answer by testing the enum.

Definition at line 168 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

Data Fields

const gchar * element
 gst factory name – also the name status/logs report as "backend" More...
 
const gchar *const * markers
 NULL-terminated config-file markers that identify this backend (see modelmux_detect_model_type). More...
 
guint positions
 MM_BACKEND_AT_* mask: where this backend is allowed to run. More...
 
gboolean engine_file
 a raw .engine is a meaningful artifact for this backend (nvinfer swaps it in via model-engine-file; Triton's repository owns its own checkpoints) More...
 
gboolean version_artifact
 a NEW version must bring its own config/engine. More...
 
gboolean inplace_reload
 supports nvinfer's native in-place engine/config hot-swap (model/update) More...
 
gboolean owns_placement
 the BACKEND schedules its own device(s), so the plugin cannot claim to have placed it (status reports the honest "triton_internal" rather than a device) More...
 
gboolean multi_gpu_scale
 gpus[] instance groups are the PLUGIN's to scale (vs delegated to the backend's own instance_group) More...
 
gboolean gpu_ids_list
 a derived config pins the device as gpu_ids: [N] inside an infer_config block (Triton grammar) rather than a scalar gpu-id in the property section (nvinfer grammar) More...
 
const gchar * config_prop
 property that takes the model's config FILE, or NULL when the element has no such property and is configured key-by-key from @config_group instead. More...
 
const gchar * config_group
 config-file group whose keys ARE the element's property names, applied one by one (see modelmux_config_apply_properties). More...
 
const gchar * engine_prop
 property carrying a PREBUILT engine. More...
 
gboolean gie_id
 the element carries a gie identity: unique-id to stamp into object meta and operate-on-gie-id to filter its input. More...
 
const gchar * cfg_section
 config-file section holding this backend's scalar keys, WITHOUT brackets ("property", "infer_config", "visionencoder"). More...
 
const gchar * gpu_key
 config key that pins the device inside @cfg_section More...
 

Field Documentation

◆ cfg_section

const gchar * ModelBackendInfo::cfg_section

config-file section holding this backend's scalar keys, WITHOUT brackets ("property", "infer_config", "visionencoder").

Used when DERIVING a per-version config: it is where an engine/gpu override is injected if the base declares the key nowhere. Rendered as "[x]" for INI and "x:" for YAML/protobuf by the caller.

Definition at line 216 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ config_group

const gchar * ModelBackendInfo::config_group

config-file group whose keys ARE the element's property names, applied one by one (see modelmux_config_apply_properties).

NULL for a backend that reads its own config file. Exactly one of @config_prop / @config_group is set.

Definition at line 203 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ config_prop

const gchar * ModelBackendInfo::config_prop

property that takes the model's config FILE, or NULL when the element has no such property and is configured key-by-key from @config_group instead.

Definition at line 199 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ element

const gchar * ModelBackendInfo::element

gst factory name – also the name status/logs report as "backend"

Definition at line 171 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ engine_file

gboolean ModelBackendInfo::engine_file

a raw .engine is a meaningful artifact for this backend (nvinfer swaps it in via model-engine-file; Triton's repository owns its own checkpoints)

Definition at line 179 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ engine_prop

const gchar * ModelBackendInfo::engine_prop

property carrying a PREBUILT engine.

Also the in-place OTA trigger: setting it on a live element is what model/update does. NULL = the backend has no engine artifact (its checkpoints live elsewhere).

Definition at line 207 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ gie_id

gboolean ModelBackendInfo::gie_id

the element carries a gie identity: unique-id to stamp into object meta and operate-on-gie-id to filter its input.

FALSE means the backend cannot be scoped to one upstream detector and cannot be attributed downstream.

Definition at line 211 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ gpu_ids_list

gboolean ModelBackendInfo::gpu_ids_list

a derived config pins the device as gpu_ids: [N] inside an infer_config block (Triton grammar) rather than a scalar gpu-id in the property section (nvinfer grammar)

Definition at line 195 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ gpu_key

const gchar * ModelBackendInfo::gpu_key

config key that pins the device inside @cfg_section

Definition at line 218 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ inplace_reload

gboolean ModelBackendInfo::inplace_reload

supports nvinfer's native in-place engine/config hot-swap (model/update)

Definition at line 185 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ markers

const gchar *const * ModelBackendInfo::markers

NULL-terminated config-file markers that identify this backend (see modelmux_detect_model_type).

The FIRST decisive line wins.

Definition at line 174 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ multi_gpu_scale

gboolean ModelBackendInfo::multi_gpu_scale

gpus[] instance groups are the PLUGIN's to scale (vs delegated to the backend's own instance_group)

Definition at line 191 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ owns_placement

gboolean ModelBackendInfo::owns_placement

the BACKEND schedules its own device(s), so the plugin cannot claim to have placed it (status reports the honest "triton_internal" rather than a device)

Definition at line 188 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ positions

guint ModelBackendInfo::positions

MM_BACKEND_AT_* mask: where this backend is allowed to run.

Definition at line 176 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.

◆ version_artifact

gboolean ModelBackendInfo::version_artifact

a NEW version must bring its own config/engine.

FALSE means a bare (name, version) is the correct and only form – the backend resolves the version itself.

Definition at line 183 of file sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux_priv.h.


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