This documentation is subject to changes, The version 4.6 has not been officially released.

Model pipeline selection and configuration

Nx Witness, Nx Go and Nx Meta will work in the same way for the configuration.

The device detail page is the central place to manage the model pipelines that the device should run. Pipelines are chains of one or more models that can run with the given video input from the device. Usually a device has a default pipeline configured after the plugin is enabled for the device.

Add a new pipeline

When no pipelines are set, the only available option is to add a new pipeline:

A device detail page without any pipelines

Clicking the "Add a pipeline" button redirects you to the model catalogue.

Selecting a model

In the model catalogue you can select a model to use in the new (or current) pipeline.

The top of the page will show a message that you are "Currently assigning...".

If you have uploaded custom models, they will also be available in the catalogue.

The model catalogue with the assignment message and the option to select a model for the current pipeline

When a model is selected it will be assigned and downloaded to the server for the current device.

Message that the model will be added to the server

You will be redirected to the device details page again, with the newly assigned model.

The device detail page with a single pipeline containing one model

Add a chained model

Chained models are models that use the input of a parent model instead of processing the video from the device directly.

You add a chained model by clicking the chain icon next to the parent model name. You will be redirected to the model catalogue to select a chained model.

Model pipeline with settings and buttons to manage models in the pipeline

The way a chained model will use the input can be chosen by setting a chaining method, currently there are three modes and not all of them may be available at the same time:

  • Direct - the chained model gets the output from the parent model as input

  • Conditional - the chained model will only run if a field with a given name outputs "true"

  • Feature extraction - the chained model will get the contents of the bounding boxes that have a certain label

A model pipeline with chaining options

Choose the appropriate method, and when you have entered new data the pipeline form will change to indicate that settings need to be saved.

A model pipeline with changes that need to be saved

The settings will be applied to the device when you click the "Save pipelines" button.

Change a model in a pipeline

A parent model or a chained model can be replaced by clicking the left-right arrow button next to the model title . This will redirect you to the normal model selection process where you can select a replacement model.

The rest of the settings in the model pipeline are not affected, unless they are directly related to the model.

Remove a chained model from a pipeline

Removing a chained model from a pipeline can be done by clicking the delete button next to a chained model and the model will be removed directly.

Undoing is not possible, to undo this you will have to select the same model again and set the same chaining options and pre- and post-processing.

Remove a pipeline

Removing a pipeline with all the models and settings can be done by clicking the delete button next to a parent model in a pipeline and the full model pipeline with all associated settings and chained models will be removed.

Undoing is not possible, to restore the settings the same model pipeline must be rebuilt completely.

Last updated