Runtime

DeepNet

Main neural-network interface for training, detection, tracking, prediction, and export.

12 config keys · 6 public methods

Import

from Xenonix.Runtime import DeepNet

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

Config key	Default	Common values	What it controls
`GPU`	`True`	`True`, `False`	Uses GPU acceleration where available.
`Threshold`	`0.5`	Any valid value	Confidence threshold.
`Image_Size`	`False`	Any valid value	Input image size.
`NMS`	`0.5`	Any valid value	Non-maximum suppression overlap threshold.
`NMS_Batch`	`False`	Any valid value	Batch NMS setting.
`Margin`	`10`	Any valid value	Extra region margin.
`Max_Age`	`30`	Any valid value	Maximum track age before dropping a track.
`TopK`	`300`	Any valid value	Top-K candidates to keep.
`Text_Region`	`False`	Any valid value	Draws/shows region text.
`Text_Class`	`True`	Any valid value	Draws/shows class text.
`Text_Score`	`False`	Any valid value	Draws/shows score text.
`Text_ID`	`False`	Any valid value	Draws/shows track ID text.

Public methods

Create

Creates a new DeepNet instance.

Create(Path=False)

Arguments

Argument	Default	Accepted values	What it does
`Path`	`False`	Any valid value	File path used for reading or writing.

Output

Creates a new DeepNet object.

Config_Get

Reads one or more configuration values by name.

Config_Get(*Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`*args`	Any valid value	Input value used by the operation.

Output

Returns selected configuration values.

Config

Changes one or more supported settings. Pass only the configuration keys you want to update.

Config(**Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Updates configuration values on the object.

Detect

Runs object detection on a frame and returns detections/overlay data.

Detect(Frame)

Arguments

Argument	Default	Accepted values	What it does
`Frame`	Required	Any valid value	Input image/frame data. Can be an image object, array, or frame accepted by this tool.

Output

Returns the calculated result.

Track

Runs detection with tracking state and returns tracked results.

Track(Frame)

Arguments

Argument	Default	Accepted values	What it does
`Frame`	Required	Any valid value	Input image/frame data. Can be an image object, array, or frame accepted by this tool.

Output

Returns the calculated result.

Predict

Runs the model prediction pipeline on a frame.

Predict(Frame)

Arguments

Argument	Default	Accepted values	What it does
`Frame`	Required	Any valid value	Input image/frame data. Can be an image object, array, or frame accepted by this tool.

Output

Returns the calculated result.