Struct BatchSampler

pub struct BatchSampler<S = SequentialSampler> {
    pub sampler: S,
    pub batch_size: usize,
    pub drop_last: bool,
}

Wraps another sampler to yield a mini-batch of indices.

Arguments

• sampler - Base sampler.
• batch_size - Size of mini-batch.
• drop_last - If true, the sampler will drop the last batch if its size would be less than batch_size.

Examples:

use ai_dataloader::sampler::SequentialSampler;
use ai_dataloader::sampler::BatchSampler;

let dataset = vec![0, 1, 2, 3];
let batch_sampler = BatchSampler {
    sampler: SequentialSampler {
    data_source_len: dataset.len(),
    },
    batch_size: 2,
    drop_last: false,
};
let mut iter = batch_sampler.iter();
assert_eq!(iter.next(), Some(vec![0, 1]));
assert_eq!(iter.next(), Some(vec![2, 3]));

Fields

sampler: S

Base sampler.

batch_size: usize

Size of mini batch.

drop_last: bool

If true, the sampler will drop the last batch if its size were less than batch_size.

Implementations

impl<S: Sampler> BatchSampler<S>

pub fn iter(&self) -> BatchIterator<S::IntoIter>

Return an iterator over the BatchSampler.

Trait Implementations

impl<S: Clone> Clone for BatchSampler<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for BatchSampler<S>

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

Formats the value using the given formatter.

impl<S: Hash> Hash for BatchSampler<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: Sampler> IntoIterator for &BatchSampler<S>

type IntoIter = BatchIterator<<S as IntoIterator>::IntoIter>

Which kind of iterator are we turning this into?

type Item = Vec<usize>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

fn len(&self) -> usize

Returns the number of batch.

If drop_last is set to false, even an incomplete batch will be counted.

fn is_empty(&self) -> bool

Return true if the collection has no element.

impl<S: Ord> Ord for BatchSampler<S>

fn cmp(&self, other: &BatchSampler<S>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq for BatchSampler<S>

fn eq(&self, other: &BatchSampler<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: PartialOrd> PartialOrd for BatchSampler<S>

fn partial_cmp(&self, other: &BatchSampler<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: Eq> Eq for BatchSampler<S>

impl<S> StructuralPartialEq for BatchSampler<S>