Struct burn::data::dataset::WindowDataset

pub struct WindowDataset<'a, I> {
    pub size: NonZero<usize>,
    /* private fields */
}

Dataset designed to work with overlapping windows of data.

Fields

size: NonZero<usize>

The size of the windows.

Implementations

impl<'a, I> WindowDataset<'a, I>

pub fn new<D>(dataset: &'a D, size: NonZero<usize>) -> WindowDataset<'a, I>

where D: Dataset<I>,

Creates a new WindowDataset instance. The windows overlap. Is empty if the input Dataset is shorter than size.

Parameters

• dataset: The dataset over which windows will be created.
• size: The size of the windows.

Returns

A WindowDataset instance.

Trait Implementations

impl<'a, I> Dataset<Vec<I>> for WindowDataset<'a, I>

fn get(&self, index: usize) -> Option<Vec<I>>

Retrieves a window of items from the dataset.

Parameters

• index: The index of the window.

Returns

A vector containing the items of the window.

fn len(&self) -> usize

Retrieves the number of windows in the dataset.

Returns

A size representing the number of windows.

fn is_empty(&self) -> bool

Checks if the dataset is empty.

fn iter(&self) -> DatasetIterator<'_, I>

where Self: Sized,

Returns an iterator over the dataset.

fn windows(&self, size: usize) -> WindowDataset<'_, I>

where Self: Sized,

Returns a new Dataset of all the windows of length size. The windows overlap. Is empty if the input Dataset is shorter than size.