Struct TensorBlockRef 

pub struct TensorBlockRef<'a> { /* private fields */ }

Reference to a TensorBlock

Implementations

impl<'a> TensorBlockRef<'a>

pub unsafe fn from_raw(ptr: *const mts_block_t) -> TensorBlockRef<'a>

Create a new TensorBlockRef from the given raw mts_block_t

This is a VERY unsafe function, creating a lifetime out of thin air. Make sure the lifetime is actually constrained by the lifetime of the owner of this mts_block_t.

pub fn as_ptr(&self) -> *const mts_block_t

Get the underlying raw pointer

impl<'a> TensorBlockRef<'a>

pub fn device(&self) -> Result<DLDevice, Error>

Get the device on which the values of this block are stored.

pub fn dtype(&self) -> Result<DLDataType, Error>

Get the data type of the values of this block.

pub fn data(&'a self) -> TensorBlockData<'a>

Get all the data and metadata inside this TensorBlockRef as a struct with separate fields, to allow borrowing them separately.

pub fn values(&self) -> ArrayRef<'a>

Get the array for the values in this block

pub fn samples(&self) -> Labels

Get the samples for this block

pub fn components(&self) -> Vec<Labels>

Get the components for this block

pub fn properties(&self) -> Labels

Get the properties for this block

pub fn gradient_list(&self) -> Vec<&'a str>

Get the full list of gradients in this block

pub fn gradient(&self, parameter: &str) -> Option<TensorBlockRef<'a>>

Get the data and metadata for the gradient with respect to the given parameter in this block, if it exists.

pub fn try_clone(&self) -> Result<TensorBlock, Error>

Clone this block, cloning all the data and metadata contained inside.

This can fail if the external data held inside an mts_array_t can not be cloned.

pub fn gradients(&self) -> GradientsIter<'_>

Get an iterator over parameter/TensorBlockRef pairs for all gradients in this block

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), Error>

Save the given block to the file at path

This is a convenience function calling crate::io::save_block

pub fn save_buffer(&self, buffer: &mut Vec<u8>) -> Result<(), Error>

Save the given block to an in-memory buffer

This is a convenience function calling crate::io::save_block_buffer

Trait Implementations

impl<'a> Clone for TensorBlockRef<'a>

fn clone(&self) -> TensorBlockRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TensorBlockRef<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for TensorBlockRef<'a>

impl Send for TensorBlockRef<'_>

impl Sync for TensorBlockRef<'_>