Struct burn::tensor::repr::HandleContainer

pub struct HandleContainer<H> {
    pub handles_orphan: Vec<TensorId>,
    /* private fields */
}

Keep all tensor handles in one place and ensure that all resources are used optimally.

Fields

handles_orphan: Vec<TensorId>

Handle candidates to be freed.

Implementations

impl<H> HandleContainer<H>

where H: Clone,

pub fn new() -> HandleContainer<H>

Create a new HandleContainer

pub fn register_handle(&mut self, id: TensorId, handle: H)

Register a handle for the given tensor id.

pub fn get_handle(&mut self, id: &TensorId, status: &TensorStatus) -> H

Get the handle for the given tensor id. The status is used to determine if the tensor should be popped out of the current tensor map, necessary for inplace operations.

Warnings

Make sure the status corresponds to the operation you want to execute the handle on, otherwise you might remove a tensor handle that will be required in the future.

pub fn get_float_tensor<B, const D: usize>( &mut self, tensor: &TensorDescription, ) -> <B as Backend>::FloatTensorPrimitive<D>

where B: ReprBackend<Handle = H>,

Get the float tensor corresponding to the given tensor description.

pub fn get_int_tensor<B, const D: usize>( &mut self, tensor: &TensorDescription, ) -> <B as Backend>::IntTensorPrimitive<D>

where B: ReprBackend<Handle = H>,

Get the int tensor corresponding to the given tensor description.

pub fn get_bool_tensor<B, const D: usize>( &mut self, tensor: &TensorDescription, ) -> <B as Backend>::BoolTensorPrimitive<D>

where B: ReprBackend<Handle = H>,

Get the bool tensor corresponding to the given tensor description.

pub fn register_float_tensor<B, const D: usize>( &mut self, id: &TensorId, tensor: <B as Backend>::FloatTensorPrimitive<D>, )

where B: ReprBackend<Handle = H>,

Register a new float tensor with the corresponding tensor id.

pub fn register_int_tensor<B, const D: usize>( &mut self, id: &TensorId, tensor: <B as Backend>::IntTensorPrimitive<D>, )

where B: ReprBackend<Handle = H>,

Register a new int tensor with the corresponding tensor id.

pub fn register_bool_tensor<B, const D: usize>( &mut self, id: &TensorId, tensor: <B as Backend>::BoolTensorPrimitive<D>, )

where B: ReprBackend<Handle = H>,

Register a new bool tensor with the corresponding tensor id.

pub fn create_tensor_uninit(&mut self) -> Arc<TensorId>

Lazily create a new empty tensor and return its corresponding tensor id.

pub fn free(&mut self, tensor: &TensorDescription)

Remove tensor handle from container if writable

pub fn free_orphans(&mut self, remaining: &[&TensorId])

Remove tensor handle from container if not in use

Trait Implementations

impl<H> Default for HandleContainer<H>

where H: Default,

fn default() -> HandleContainer<H>

Returns the “default value” for a type.