Class BatchConfigurationBuilder<TBatch>

Namespace

AiDotNet.Extensions

Assembly

AiDotNet.dll

Builder for configuring batch iteration with a fluent API.

public class BatchConfigurationBuilder<TBatch> : IEnumerable<TBatch>, IEnumerable

Type Parameters

TBatch

The type of batch returned by iteration.

Inheritance

object

BatchConfigurationBuilder<TBatch>

Implements

IEnumerable<TBatch>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DataPipelineExtensions.ToPipeline<T>(IEnumerable<T>)

EnumerableExtensions.RandomElement<T>(IEnumerable<T>)

Remarks

This builder allows chaining configuration methods before iteration. Implements IEnumerable to support foreach loops and LINQ operations.

Constructors

BatchConfigurationBuilder(IBatchIterable<TBatch>, int?)

Initializes a new instance of the BatchConfigurationBuilder.

public BatchConfigurationBuilder(IBatchIterable<TBatch> source, int? batchSize)

Parameters

source IBatchIterable<TBatch>

The batch iterable source.

batchSize int?

Optional batch size override.

Methods

DropLast()

Drops the last incomplete batch if the dataset doesn't divide evenly.

public BatchConfigurationBuilder<TBatch> DropLast()

Returns

BatchConfigurationBuilder<TBatch>

This builder for method chaining.

Remarks

Useful when your model requires consistent batch sizes (e.g., batch normalization).

GetEnumerator()

Returns an enumerator that iterates through the batches.

public IEnumerator<TBatch> GetEnumerator()

Returns

IEnumerator<TBatch>

An enumerator for the batch sequence.

KeepLast()

Keeps the last batch even if incomplete.

public BatchConfigurationBuilder<TBatch> KeepLast()

Returns

BatchConfigurationBuilder<TBatch>

This builder for method chaining.

Remarks

This is the default behavior. Call this explicitly for clarity or after DropLast().

NoShuffle()

Disables shuffling of data before batching.

public BatchConfigurationBuilder<TBatch> NoShuffle()

Returns

BatchConfigurationBuilder<TBatch>

This builder for method chaining.

Remarks

Use this when you need deterministic iteration order, such as during evaluation.

Shuffled()

Enables shuffling of data before batching.

public BatchConfigurationBuilder<TBatch> Shuffled()

Returns

BatchConfigurationBuilder<TBatch>

This builder for method chaining.

Remarks

Shuffling is enabled by default. Call this explicitly for clarity or after NoShuffle().

WithSeed(int)

Sets a random seed for reproducible shuffling.

public BatchConfigurationBuilder<TBatch> WithSeed(int seed)

Parameters

seed int

The random seed value.

Returns

BatchConfigurationBuilder<TBatch>

This builder for method chaining.

Remarks

Setting a seed ensures the same shuffle order each time for reproducibility.