Struct BatchingSampler 

pub struct BatchingSampler<S: Sampler> { /* private fields */ }

Wrapper that converts any sampler into a batch sampler

This sampler takes an underlying sampler and groups its output into batches of a specified size. The last batch may be smaller than the batch size unless drop_last is set to true.

Examples

use torsh_data::sampler::{SequentialSampler, BatchingSampler, BatchSampler};

let base_sampler = SequentialSampler::new(10);
let batch_sampler = BatchingSampler::new(base_sampler, 3, false);

let batches: Vec<Vec<usize>> = batch_sampler.iter().collect();
assert_eq!(batches.len(), 4); // [0,1,2], [3,4,5], [6,7,8], [9]

Implementations

impl<S: Sampler> BatchingSampler<S>

pub fn new(sampler: S, batch_size: usize, drop_last: bool) -> Self

Create a new batching sampler

Arguments

• sampler - The underlying sampler to batch
• batch_size - Size of each batch
• drop_last - Whether to drop the last incomplete batch

Panics

Panics if batch_size is 0

pub fn batch_size(&self) -> usize

Get the batch size

pub fn drop_last(&self) -> bool

Check if dropping last incomplete batch

pub fn sampler(&self) -> &S

Get a reference to the underlying sampler

pub fn into_sampler(self) -> S

Get the underlying sampler by value

pub fn into_distributed( self, num_replicas: usize, rank: usize, ) -> BatchingSampler<DistributedWrapper<S>>

Convert this batching sampler into a distributed version

This creates a distributed wrapper around the underlying sampler and then wraps it with a new BatchingSampler.

Arguments

• num_replicas - Total number of processes
• rank - Current process rank (0-based)

Trait Implementations

impl<S: Sampler> BatchSampler for BatchingSampler<S>

type Iter = BatchSamplerIter<<S as Sampler>::Iter>

Iterator type returned by the batch sampler

fn iter(&self) -> Self::Iter

Create an iterator over batches of indices

fn num_batches(&self) -> usize

Total number of batches that will be yielded

fn len(&self) -> usize

Total number of batches that will be yielded (alias for num_batches)

fn is_empty(&self) -> bool

Check if batch sampler is empty

impl<S: Clone + Sampler> Clone for BatchingSampler<S>

fn clone(&self) -> BatchingSampler<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + Sampler> Debug for BatchingSampler<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.