tenzr::data::DataLoader¶

Iterates a Dataset in batches with optional collation.

#include <dataloader.h>

Public Classes¶

Public Functions¶

Friends¶

Public Functions Documentation¶

function DataLoader¶

DataLoader(
    std::shared_ptr< Dataset > dataset,
    DataLoaderOptions options,
    CollateFn collate_fn =nullptr
)

Parameters:

• dataset Dataset to iterate; must not be null.
• options Batching, shuffling, and worker settings.
• collate_fn Optional collate function.

Create a loader over dataset, defaulting to default_collate when none is supplied.

function ~DataLoader¶

~DataLoader()

function DataLoader¶

DataLoader(
    const DataLoader & 
) =delete

function operator=¶

DataLoader & operator=(
    const DataLoader & 
) =delete

function DataLoader¶

DataLoader(
    DataLoader && 
)

function operator=¶

DataLoader & operator=(
    DataLoader && 
)

function begin¶

Iterator begin()

Return:

• Iterator to the first batch.
• Beginning iterator.

Iterator to the first batch.

function end¶

Iterator end()

Return:

• Past-the-end iterator.
• End iterator.

Sentinel iterator past the last batch.

function Size¶

size_t Size() const

Return:

• Number of batches.
• Batch count.

Number of batches per epoch.

function DatasetSize¶

size_t DatasetSize() const

Return:

• Number of samples in the dataset.
• Dataset size.

Number of samples in the underlying dataset.

function Options¶

inline const DataLoaderOptions & Options() const

Return: Const reference to the loader configuration.

Friends¶

friend Iterator¶

friend class Iterator(
    Iterator 
);