Struct ai_dataloader::Builder

pub struct Builder<D, S = SequentialSampler, C = DefaultCollate>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,{ /* private fields */ }

Basic builder for creating dataloader.

Implementations

impl<D> Builder<D, SequentialSampler, DefaultCollate>where
    D: Dataset,
    DefaultCollate: Collate<D::Sample>,

pub fn new(dataset: D) -> Self

Create a new [DataLoaderBuilder], with default fields. By default the [DataLoaderBuilder] is sequential and have a batch_size of one.

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

pub fn shuffle(self) -> Builder<D, RandomSampler, C>

Use a random sampler.

pub fn batch_size(self, batch_size: usize) -> Self

Set the number of elements in a batch.

pub fn drop_last(self) -> Self

Drop the lasts element if they don’t feat into a batch. For instance if a dataset have 13 samples and a batch_size of 5, the last 3 samples will be droped.

pub fn collate_fn<CF>(self, collate_fn: CF) -> Builder<D, S, CF>where
    CF: Collate<D::Sample>,

Set a custom collate function.

pub fn sampler<SA>(self) -> Builder<D, SA, C>where
    SA: Sampler,

Set a custom Sampler.

pub fn build(self) -> DataLoader<D, S, C>

Create a [Dataloader] from a [DataLoaderBuilder].

Trait Implementations

impl<D: Clone, S: Clone, C: Clone> Clone for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug, S: Debug, C: Debug> Debug for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

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

Formats the value using the given formatter.

impl<D: Hash, S: Hash, C: Hash> Hash for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

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,

Feeds a slice of this type into the given Hasher.

impl<D: Ord, S: Ord, C: Ord> Ord for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

fn cmp(&self, other: &Builder<D, S, C>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<D: PartialEq, S: PartialEq, C: PartialEq> PartialEq<Builder<D, S, C>> for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

fn eq(&self, other: &Builder<D, S, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method 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<Builder<D, S, C>> for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

fn partial_cmp(&self, other: &Builder<D, S, C>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

impl<D, S, C> StructuralEq for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,

impl<D, S, C> StructuralPartialEq for Builder<D, S, C>where
    D: Dataset,
    S: Sampler,
    C: Collate<D::Sample>,