Table of Contents

Class ByteTrack<T>

Namespace
AiDotNet.Video.Tracking
Assembly
AiDotNet.dll

ByteTrack: Multi-Object Tracking by Associating Every Detection Box.

public class ByteTrack<T> : NeuralNetworkBase<T>, INeuralNetworkModel<T>, INeuralNetwork<T>, IFullModel<T, Tensor<T>, Tensor<T>>, IModel<Tensor<T>, Tensor<T>, ModelMetadata<T>>, IModelSerializer, ICheckpointableModel, IParameterizable<T, Tensor<T>, Tensor<T>>, IFeatureAware, IFeatureImportance<T>, ICloneable<IFullModel<T, Tensor<T>, Tensor<T>>>, IGradientComputable<T, Tensor<T>, Tensor<T>>, IJitCompilable<T>, IInterpretableModel<T>, IInputGradientComputable<T>, IDisposable

Type Parameters

T

The numeric type used for calculations.

Inheritance
ByteTrack<T>
Implements
IFullModel<T, Tensor<T>, Tensor<T>>
IModel<Tensor<T>, Tensor<T>, ModelMetadata<T>>
IParameterizable<T, Tensor<T>, Tensor<T>>
ICloneable<IFullModel<T, Tensor<T>, Tensor<T>>>
IGradientComputable<T, Tensor<T>, Tensor<T>>
Inherited Members
Extension Methods

Remarks

For Beginners: ByteTrack is a simple yet powerful multi-object tracking method that tracks all detection boxes, including low-confidence ones that other trackers ignore.

Key capabilities:

  • Track multiple objects across video frames
  • Handle occlusions and crowded scenes
  • Associate detections between frames using motion prediction
  • Maintain object IDs consistently over time

Example usage:

var model = new ByteTrack<double>(arch);
var tracks = model.Track(videoFrames);
foreach (var track in tracks)
    Console.WriteLine($"Object {track.Id} at {track.BoundingBox}");

Technical Details: - YOLOX-based detector backbone - Kalman filter for motion prediction - Two-stage association (high + low confidence boxes) - IoU-based matching with Hungarian algorithm

Reference: "ByteTrack: Multi-Object Tracking by Associating Every Detection Box" https://arxiv.org/abs/2110.06864

Constructors

ByteTrack(NeuralNetworkArchitecture<T>, IGradientBasedOptimizer<T, Tensor<T>, Tensor<T>>?, ILossFunction<T>?, int, int, double, double, int) 

public ByteTrack(NeuralNetworkArchitecture<T> architecture, IGradientBasedOptimizer<T, Tensor<T>, Tensor<T>>? optimizer = null, ILossFunction<T>? lossFunction = null, int numFeatures = 256, int numClasses = 1, double highThreshold = 0.6, double lowThreshold = 0.1, int maxAge = 30)

Parameters

architecture NeuralNetworkArchitecture<T>
optimizer IGradientBasedOptimizer<T, Tensor<T>, Tensor<T>>
lossFunction ILossFunction<T>
numFeatures int
numClasses int
highThreshold double
lowThreshold double
maxAge int

ByteTrack(NeuralNetworkArchitecture<T>, string, int) 

public ByteTrack(NeuralNetworkArchitecture<T> architecture, string onnxModelPath, int numClasses = 1)

Parameters

architecture NeuralNetworkArchitecture<T>
onnxModelPath string
numClasses int

Properties

SupportsTraining

Indicates whether this network supports training (learning from data).

public override bool SupportsTraining { get; }

Property Value

bool

Remarks

For Beginners: Not all neural networks can learn. Some are designed only for making predictions with pre-set parameters. This property tells you if the network can learn from data.

Methods

CreateNewInstance()

Creates a new instance of the same type as this neural network.

protected override IFullModel<T, Tensor<T>, Tensor<T>> CreateNewInstance()

Returns

IFullModel<T, Tensor<T>, Tensor<T>>

A new instance of the same neural network type.

Remarks

For Beginners: This creates a blank version of the same type of neural network.

It's used internally by methods like DeepCopy and Clone to create the right type of network before copying the data into it.

DeserializeNetworkSpecificData(BinaryReader)

Deserializes network-specific data that was not covered by the general deserialization process.

protected override void DeserializeNetworkSpecificData(BinaryReader reader)

Parameters

reader BinaryReader

The BinaryReader to read the data from.

Remarks

This method is called at the end of the general deserialization process to allow derived classes to read any additional data specific to their implementation.

For Beginners: Continuing the suitcase analogy, this is like unpacking that special compartment. After the main deserialization method has unpacked the common items (layers, parameters), this method allows each specific type of neural network to unpack its own unique items that were stored during serialization.

Detect(Tensor<T>)

Detects objects in a single frame.

public List<Detection<T>> Detect(Tensor<T> frame)

Parameters

frame Tensor<T>

Returns

List<Detection<T>>

GetModelMetadata()

Gets the metadata for this neural network model.

public override ModelMetadata<T> GetModelMetadata()

Returns

ModelMetadata<T>

A ModelMetaData object containing information about the model.

InitializeLayers()

Initializes the layers of the neural network based on the architecture.

protected override void InitializeLayers()

Remarks

For Beginners: This method sets up all the layers in your neural network according to the architecture you've defined. It's like assembling the parts of your network before you can use it.

Predict(Tensor<T>)

Makes a prediction using the neural network.

public override Tensor<T> Predict(Tensor<T> input)

Parameters

input Tensor<T>

The input data to process.

Returns

Tensor<T>

The network's prediction.

Remarks

For Beginners: This is the main method you'll use to get results from your trained neural network. You provide some input data (like an image or text), and the network processes it through all its layers to produce an output (like a classification or prediction).

ResetTracks()

Resets tracking state for a new video.

public void ResetTracks()

SerializeNetworkSpecificData(BinaryWriter)

Serializes network-specific data that is not covered by the general serialization process.

protected override void SerializeNetworkSpecificData(BinaryWriter writer)

Parameters

writer BinaryWriter

The BinaryWriter to write the data to.

Remarks

This method is called at the end of the general serialization process to allow derived classes to write any additional data specific to their implementation.

For Beginners: Think of this as packing a special compartment in your suitcase. While the main serialization method packs the common items (layers, parameters), this method allows each specific type of neural network to pack its own unique items that other networks might not have.

Track(List<Tensor<T>>)

Tracks objects across video frames.

public List<List<Track<T>>> Track(List<Tensor<T>> frames)

Parameters

frames List<Tensor<T>>

Returns

List<List<Track<T>>>

Train(Tensor<T>, Tensor<T>)

Trains the neural network on a single input-output pair.

public override void Train(Tensor<T> input, Tensor<T> expectedOutput)

Parameters

input Tensor<T>

The input data.

expectedOutput Tensor<T>

The expected output for the given input.

Remarks

This method performs one training step on the neural network using the provided input and expected output. It updates the network's parameters to reduce the error between the network's prediction and the expected output.

For Beginners: This is how your neural network learns. You provide: - An input (what the network should process) - The expected output (what the correct answer should be)

The network then:

  1. Makes a prediction based on the input
  2. Compares its prediction to the expected output
  3. Calculates how wrong it was (the loss)
  4. Adjusts its internal values to do better next time

After training, you can get the loss value using the GetLastLoss() method to see how well the network is learning.

UpdateParameters(Vector<T>)

Updates the network's parameters with new values.

public override void UpdateParameters(Vector<T> parameters)

Parameters

parameters Vector<T>

The new parameter values to set.

Remarks

For Beginners: During training, a neural network's internal values (parameters) get adjusted to improve its performance. This method allows you to update all those values at once by providing a complete set of new parameters.

This is typically used by optimization algorithms that calculate better parameter values based on training data.

UpdateTracks(List<Detection<T>>)

Updates tracks with new detections.

public List<Track<T>> UpdateTracks(List<Detection<T>> detections)

Parameters

detections List<Detection<T>>

Returns

List<Track<T>>
Edit this page