Struct Sample 

pub struct Sample { /* private fields */ }

A single training sample - a named collection of data buffers.

Implementations

impl Sample

pub fn new() -> Sample

Create an empty sample.

pub fn with(self, name: &str, tensor: Tensor) -> Sample

Add a named tensor to this sample (builder pattern).

pub fn with_metadata(self, source: impl Into<String>, index: u64) -> Sample

Attach metadata to this sample.

pub fn get(&self, name: &str) -> Option<&Tensor>

Get a tensor by name.

pub fn get_mut(&mut self, name: &str) -> Option<&mut Tensor>

Get a mutable reference to a tensor by name.

pub fn insert(&mut self, name: impl Into<String>, tensor: Tensor)

Insert a tensor with the given name.

pub fn remove(&mut self, name: &str) -> Option<Tensor>

Remove a field by name, returning the tensor if it existed.

pub fn contains(&self, name: &str) -> bool

Check whether a field with the given name exists.

pub fn iter(&self) -> impl Iterator<Item = (&str, &Tensor)>

Iterate over all (name, tensor) pairs.

pub fn len(&self) -> usize

Number of fields in this sample.

pub fn is_empty(&self) -> bool

Whether the sample has no fields.

pub fn metadata(&self) -> Option<&SampleMetadata>

Get the metadata, if any.

pub fn field_names(&self) -> impl Iterator<Item = &str>

Names of all fields in this sample.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl Default for Sample

fn default() -> Sample

Returns the “default value” for a type.