Interface ICountable

Namespace

AiDotNet.Interfaces

Assembly

AiDotNet.dll

Defines capability to report dataset size and iteration progress.

public interface ICountable

Remarks

Data loaders that implement this interface provide information about their size and current position, useful for progress tracking and determining when an epoch is complete.

For Beginners: Knowing how much data you have and where you are in processing is essential for: - Showing progress bars - Knowing when an epoch (full pass through data) is complete - Calculating metrics like "samples processed per second"

Properties

BatchCount

Gets the total number of batches based on current batch size.

int BatchCount { get; }

Property Value

int

Remarks

This is typically ceil(TotalCount / BatchSize).

CurrentBatchIndex

Gets the current batch index in the iteration (0-based).

int CurrentBatchIndex { get; }

Property Value

int

CurrentIndex

Gets the current sample index in the iteration (0-based).

int CurrentIndex { get; }

Property Value

int

Progress

Gets the progress through the current epoch as a value from 0.0 to 1.0.

double Progress { get; }

Property Value

double

Remarks

Returns CurrentIndex / TotalCount, useful for progress displays.

For Beginners: This gives you a percentage of how far through the data you are: - 0.0 = just started - 0.5 = halfway through - 1.0 = finished (time to reset for next epoch)

TotalCount

Gets the total number of samples in the dataset.

int TotalCount { get; }

Property Value

int