Module configuration

Note

These classes aren’t meant to be instantiated directly. They are used for module config validation with OmegaConf Structured config and provided here as a general reference of module config file format.

Main module configuration entities

Module and pipeline elements configuration templates.

Inheritance diagram of PipelineElement, ModelElement, PyFuncElement

PipelineElement hierarchy

Module

Module configuration template.

Pipeline

Pipeline configuration template.

PipelineElement

Base pipeline element configuration template.

PyFuncElement

A pipeline element that will use an object implementing BasePyFuncPlugin to apply custom processing to gstreamer buffers.

ModelElement

A pipeline element that will run inference with specified deep learning model.

ElementGroup

Pipeline elements wrapper that can be used to add a condition on whether to load the group into the pipeline.

GroupCondition

Determines if a group should be loaded into the pipeline.

DrawFunc

A pipeline element that will use an object implementing BaseNvDsDrawFunc to draw metadata on frames.

DynamicGstProperty

Allows configuring a gstreamer element property to be automatically updated to current value of a dynamic parameter from parameter storage.

Module configuration manager

Module configuration.

ModuleConfig

Singleton that provides module configuration loading and access.

OmegaConf resolvers

initializer_resolver

OmegaConf resolver that provides config variable value by polling a number of different value stores in order of their priority and returning result from the first available one.

calc_resolver

OmegaConf resolver that provides config variable value by evaluating an arithmetic expression passed by string representation.

json_resolver

OmegaConf resolver that provides config variable value by parsing a JSON string.