Struct DataLoader

pub struct DataLoader<D, S = SequentialSampler, C = DefaultCollate> { /* private fields */ }

Data loader. Combines a dataset and a sampler, and provides an iterable over the given dataset.

use ai_dataloader::indexable::DataLoader;

let loader = DataLoader::builder(vec![(0, "hola"), (1, "hello"), (2, "hallo"), (3, "bonjour")]).batch_size(2).shuffle().build();

for (label, text) in &loader {
    println!("Label {label:?}");
    println!("Text {text:?}");
}

Implementations

impl<D> DataLoader<D, SequentialSampler, DefaultCollate>

where D: Dataset, DefaultCollate: Collate<D::Sample>,

pub fn builder(dataset: D) -> Builder<D, SequentialSampler, DefaultCollate>

Helper to return a DataLoader builder.

impl<D, S, C> DataLoader<D, S, C>

where D: Dataset + Sync, S: Sampler, C: Collate<D::Sample>, D::Sample: Send,

pub fn iter(&self) -> SingleProcessDataLoaderIter<'_, D, S, C>

Return not owning iterator over the dataloader.

Trait Implementations

impl<D: Clone, S: Clone, C: Clone> Clone for DataLoader<D, S, C>

fn clone(&self) -> DataLoader<D, S, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug, S: Debug, C: Debug> Debug for DataLoader<D, S, C>

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

Formats the value using the given formatter.

impl<D: Hash, S: Hash, C: Hash> Hash for DataLoader<D, S, C>

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<'dataset, D, S, C> IntoIterator for &'dataset DataLoader<D, S, C>

where D: Dataset + Sync, S: Sampler, C: Collate<D::Sample>, D::Sample: Send,

type Item = <C as Collate<<D as GetSample>::Sample>>::Output

The type of the elements being iterated over.

type IntoIter = SingleProcessDataLoaderIter<'dataset, D, S, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<D, S, C> Len for DataLoader<D, S, C>

where D: Dataset, S: Sampler, C: Collate<D::Sample>,

fn len(&self) -> usize

Return the number of batch that contain the dataloader.

fn is_empty(&self) -> bool

Return true if the collection has no element.

impl<D: Ord, S: Ord, C: Ord> Ord for DataLoader<D, S, C>

fn cmp(&self, other: &DataLoader<D, S, C>) -> 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<D: PartialEq, S: PartialEq, C: PartialEq> PartialEq for DataLoader<D, S, C>

fn eq(&self, other: &DataLoader<D, S, C>) -> 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<D: PartialOrd, S: PartialOrd, C: PartialOrd> PartialOrd for DataLoader<D, S, C>

fn partial_cmp(&self, other: &DataLoader<D, S, C>) -> 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<D: Eq, S: Eq, C: Eq> Eq for DataLoader<D, S, C>

impl<D, S, C> StructuralPartialEq for DataLoader<D, S, C>