Struct rerun::sdk::prelude::TensorData

pub struct TensorData {
    pub shape: ArrowBuffer<u64>,
    pub names: Option<Vec<ArrowString>>,
    pub buffer: TensorBuffer,
}

Datatype: An N-dimensional array of numbers.

The number of dimensions and their respective lengths is specified by the shape field. The dimensions are ordered from outermost to innermost. For example, in the common case of a 2D RGB Image, the shape would be [height, width, channel].

These dimensions are combined with an index to look up values from the buffer field, which stores a contiguous array of typed values.

Fields

shape: ArrowBuffer<u64>

The shape of the tensor, i.e. the length of each dimension.

names: Option<Vec<ArrowString>>

The names of the dimensions of the tensor (optional).

If set, should be the same length as datatypes::TensorData::shape. If it has a different length your names may show up improperly, and some constructors may produce a warning or even an error.

Example: ["height", "width", "channel", "batch"].

buffer: TensorBuffer

The content/data.

Implementations

impl TensorData

pub fn new( shape: impl Into<ArrowBuffer<u64>>, buffer: TensorBuffer, ) -> TensorData

Create a new tensor.

pub fn with_dim_names( self, names: impl IntoIterator<Item = impl Into<ArrowString>>, ) -> TensorData

Set the names of the dimensions to the provided names.

Any existing names will be overwritten.

If the wrong number of names are given, a warning will be logged, and the names might not show up correctly.

pub fn shape(&self) -> &[u64]

The shape of the tensor.

pub fn dim_name(&self, dim: usize) -> Option<&ArrowString>

Get the name of a specific dimension.

Returns None if the dimension does not have a name.

pub fn shape_short(&self) -> &[u64]

Returns the shape of the tensor with all leading & trailing dimensions of size 1 ignored.

If all dimension sizes are one, this returns only the first dimension.

pub fn num_dim(&self) -> usize

The number of dimensions of the tensor.

An image tensor will usually have two (height, width) or three (height, width, channels) dimensions.

pub fn is_vector(&self) -> bool

Returns true if either all dimensions have size 1 or only a single dimension has a size larger than 1.

Empty tensors return false.

pub fn get(&self, index: &[u64]) -> Option<TensorElement>

Get the value of the element at the given index.

Return None if out-of-bounds.

pub fn dtype(&self) -> TensorDataType

The datatype of the tensor.

pub fn size_in_bytes(&self) -> usize

The size of the tensor data, in bytes.

impl TensorData

pub fn from_image_file(path: &Path) -> Result<TensorData, TensorImageLoadError>

Construct a tensor from the contents of an image file on disk.

This will spend CPU cycles reading the file and decoding the image. To save CPU time and storage, we recommend you instead use EncodedImage::from_file.

Requires the image feature.

pub fn from_image_bytes( bytes: &[u8], format: ImageFormat, ) -> Result<TensorData, TensorImageLoadError>

Construct a tensor from the contents of an image file.

This will spend CPU cycles decoding the image. To save CPU time and storage, we recommend you instead use EncodedImage::from_file_contents.

Requires the image feature.

pub fn from_image( image: impl Into<DynamicImage>, ) -> Result<TensorData, TensorImageLoadError>

Construct a tensor from something that can be turned into a image::DynamicImage.

Requires the image feature.

pub fn from_dynamic_image( image: DynamicImage, ) -> Result<TensorData, TensorImageLoadError>

Construct a tensor from image::DynamicImage.

Requires the image feature.

Trait Implementations

impl Borrow<TensorData> for TensorData

fn borrow(&self) -> &TensorData

Immutably borrows from an owned value.

impl Clone for TensorData

fn clone(&self) -> TensorData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TensorData

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

Formats the value using the given formatter.

impl Default for TensorData

fn default() -> TensorData

Returns the “default value” for a type.

impl From<&[f16]> for TensorData

fn from(slice: &[f16]) -> TensorData

Converts to this type from the input type.

impl From<&[f32]> for TensorData

fn from(slice: &[f32]) -> TensorData

Converts to this type from the input type.

impl From<&[f64]> for TensorData

fn from(slice: &[f64]) -> TensorData

Converts to this type from the input type.

impl From<&[i16]> for TensorData

fn from(slice: &[i16]) -> TensorData

Converts to this type from the input type.

impl From<&[i32]> for TensorData

fn from(slice: &[i32]) -> TensorData

Converts to this type from the input type.

impl From<&[i64]> for TensorData

fn from(slice: &[i64]) -> TensorData

Converts to this type from the input type.

impl From<&[i8]> for TensorData

fn from(slice: &[i8]) -> TensorData

Converts to this type from the input type.

impl From<&[u16]> for TensorData

fn from(slice: &[u16]) -> TensorData

Converts to this type from the input type.

impl From<&[u32]> for TensorData

fn from(slice: &[u32]) -> TensorData

Converts to this type from the input type.

impl From<&[u64]> for TensorData

fn from(slice: &[u64]) -> TensorData

Converts to this type from the input type.

impl From<&[u8]> for TensorData

fn from(slice: &[u8]) -> TensorData

Converts to this type from the input type.

impl From<Vec<f16>> for TensorData

fn from(vec: Vec<f16>) -> TensorData

Converts to this type from the input type.

impl From<Vec<f32>> for TensorData

fn from(vec: Vec<f32>) -> TensorData

Converts to this type from the input type.

impl From<Vec<f64>> for TensorData

fn from(vec: Vec<f64>) -> TensorData

Converts to this type from the input type.

impl From<Vec<i16>> for TensorData

fn from(vec: Vec<i16>) -> TensorData

Converts to this type from the input type.

impl From<Vec<i32>> for TensorData

fn from(vec: Vec<i32>) -> TensorData

Converts to this type from the input type.

impl From<Vec<i64>> for TensorData

fn from(vec: Vec<i64>) -> TensorData

Converts to this type from the input type.

impl From<Vec<i8>> for TensorData

fn from(vec: Vec<i8>) -> TensorData

Converts to this type from the input type.

impl From<Vec<u16>> for TensorData

fn from(vec: Vec<u16>) -> TensorData

Converts to this type from the input type.

impl From<Vec<u32>> for TensorData

fn from(vec: Vec<u32>) -> TensorData

Converts to this type from the input type.

impl From<Vec<u64>> for TensorData

fn from(vec: Vec<u64>) -> TensorData

Converts to this type from the input type.

impl From<Vec<u8>> for TensorData

fn from(vec: Vec<u8>) -> TensorData

Converts to this type from the input type.

impl Loggable for TensorData

fn arrow_datatype() -> DataType

The underlying arrow::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, TensorData>>>>, ) -> Result<Arc<dyn Array>, SerializationError>

where TensorData: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &dyn Array, ) -> Result<Vec<Option<TensorData>>, DeserializationError>

where TensorData: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn arrow_empty() -> Arc<dyn Array>

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, ) -> Result<Arc<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow(data: &dyn Array) -> Result<Vec<Self>, DeserializationError>

Given an Arrow array, deserializes it into a collection of Loggables.

impl PartialEq for TensorData

fn eq(&self, other: &TensorData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for TensorData

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a f16>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a f16>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a f16>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a f32>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a f32>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a f32>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a f64>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a f64>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a f64>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a i16>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a i16>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i16>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a i32>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a i32>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i32>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a i64>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a i64>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i64>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a i8>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a i8>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a i8>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a u16>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a u16>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u16>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a u32>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a u32>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u32>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a u64>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a u64>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u64>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a TensorData> for ArrayBase<ViewRepr<&'a u8>, Dim<IxDynImpl>>

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: &'a TensorData, ) -> Result<ArrayBase<ViewRepr<&'a u8>, Dim<IxDynImpl>>, <ArrayBase<ViewRepr<&'a u8>, Dim<IxDynImpl>> as TryFrom<&'a TensorData>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<f16>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<f16>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<f16>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<f32>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<f32>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<f32>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<f64>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<f64>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<f64>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<i16>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<i16>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<i16>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<i32>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<i32>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<i32>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<i64>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<i64>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<i64>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<i8>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<i8>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<i8>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<u16>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<u16>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<u16>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<u32>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<u32>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<u32>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<u64>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<u64>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<u64>, D>>>::Error>

Performs the conversion.

impl<D> TryFrom<ArrayBase<OwnedRepr<u8>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( value: ArrayBase<OwnedRepr<u8>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<OwnedRepr<u8>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a f16>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a f16>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a f16>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a f32>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a f32>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a f32>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a f64>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a f64>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a f64>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a i16>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a i16>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a i16>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a i32>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a i32>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a i32>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a i64>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a i64>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a i64>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a i8>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a i8>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a i8>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a u16>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a u16>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a u16>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a u32>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a u32>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a u32>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a u64>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a u64>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a u64>, D>>>::Error>

Performs the conversion.

impl<'a, D> TryFrom<ArrayBase<ViewRepr<&'a u8>, D>> for TensorData

where D: Dimension,

type Error = TensorCastError

The type returned in the event of a conversion error.

fn try_from( view: ArrayBase<ViewRepr<&'a u8>, D>, ) -> Result<TensorData, <TensorData as TryFrom<ArrayBase<ViewRepr<&'a u8>, D>>>::Error>

Performs the conversion.

impl TryFrom<DynamicImage> for TensorData

type Error = TensorImageLoadError

The type returned in the event of a conversion error.

fn try_from( value: DynamicImage, ) -> Result<TensorData, <TensorData as TryFrom<DynamicImage>>::Error>

Performs the conversion.

impl<P, S> TryFrom<ImageBuffer<P, S>> for TensorData

where P: Pixel, DynamicImage: From<ImageBuffer<P, S>>,

type Error = TensorImageLoadError

The type returned in the event of a conversion error.

fn try_from( value: ImageBuffer<P, S>, ) -> Result<TensorData, <TensorData as TryFrom<ImageBuffer<P, S>>>::Error>

Performs the conversion.

impl StructuralPartialEq for TensorData