Struct DataLoaderBuilder

pub struct DataLoaderBuilder<B, I, O>where
    B: Backend,
{ /* private fields */ }

Expand description

A builder for data loaders.

Implementations§

§

impl<B, I, O> DataLoaderBuilder<B, I, O>
where B: Backend, I: Send + Sync + Clone + Debug + 'static, O: Send + Clone + Debug + 'static,

pub fn new<Bt>(batcher: Bt) -> DataLoaderBuilder<B, I, O>
where Bt: Batcher<B, I, O> + 'static,

Creates a new data loader builder.

§Arguments

batcher - The batcher.

§Returns

The data loader builder.

pub fn batch_size(self, batch_size: usize) -> DataLoaderBuilder<B, I, O>

Sets the batch size to a fix number.

The fix batch strategy will be used.

§Arguments

batch_size - The batch size.

§Returns

The data loader builder.

pub fn shuffle(self, seed: u64) -> DataLoaderBuilder<B, I, O>

Sets the seed for shuffling.

Each time the dataloader starts a new iteration, the dataset will be shuffled.

§Arguments

seed - The seed.

§Returns

The data loader builder.

pub fn num_workers(self, num_workers: usize) -> DataLoaderBuilder<B, I, O>

Sets the number of workers.

Some(0) or None: the dataloader will run without work threads.
Some(n); n > 0: the dataloader will run with n background threads.

A 1-worker threaded dataloader will run loads in a background thread, while a 0-worker threaded dataloader will run loads in the main thread.

§Arguments

num_workers - The number of workers.

§Returns

The data loader builder.

pub fn set_device( self, device: ::Device, ) -> DataLoaderBuilder<B, I, O>

Sets the data loader device.

§Arguments

device - The device to use when loading a batch.

§Returns

The data loader builder.

pub fn build<D>(self, dataset: D) -> Arc<dyn DataLoader<B, O>>
where D: Dataset + 'static,

Builds the data loader.

§Arguments

dataset - The dataset.

§Returns

The data loader.

Auto Trait Implementations§

§

impl<B, I, O> !UnwindSafe for DataLoaderBuilder<B, I, O>

Blanket Implementations§

§

impl<T> Adaptor<()> for T

§

fn adapt(&self)

Adapt the type to be passed to a metric.

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§