Struct TensorCreationOptions 

pub struct TensorCreationOptions<B>
where
    B: Backend,
{
    pub device: <B as Backend>::Device,
    pub dtype: Option<DType>,
}

Options for tensor creation.

This struct allows specifying the device and/or data type (dtype) when creating a tensor.

Fields

device: <B as Backend>::Device

Device where the tensor will be created.

dtype: Option<DType>

Optional data type. If None, the dtype will be inferred on creation from the backend’s default dtype for the tensor kind.

Implementations

impl<B> TensorCreationOptions<B>

where B: Backend,

pub fn new(device: <B as Backend>::Device) -> TensorCreationOptions<B>

Create new options with a specific device.

Data type will be inferred on creation from the backend’s default dtype for the tensor kind.

pub fn with_dtype(self, dtype: DType) -> TensorCreationOptions<B>

Set the tensor creation data type.

pub fn with_device( self, device: <B as Backend>::Device, ) -> TensorCreationOptions<B>

Set the tensor creation device.

pub fn float() -> TensorCreationOptions<B>

Create options with backend’s default device and float dtype.

pub fn int() -> TensorCreationOptions<B>

Create options with backend’s default device and int dtype.

pub fn bool() -> TensorCreationOptions<B>

Create options with backend’s default device and bool dtype.

pub fn dtype_or(&self, dtype: DType) -> DType

Returns the tensor data type, or a provided default if not set.

This is useful for cases where TensorCreationOptions may not have an explicit dtype.

Trait Implementations

impl<B> Clone for TensorCreationOptions<B>

where B: Clone + Backend,

fn clone(&self) -> TensorCreationOptions<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B> Debug for TensorCreationOptions<B>

where B: Debug + Backend,

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

Formats the value using the given formatter.

impl<B> Default for TensorCreationOptions<B>

where B: Backend,

fn default() -> TensorCreationOptions<B>

Returns new options with the backend’s default device.

impl<B> From<&<B as Backend>::Device> for TensorCreationOptions<B>

where B: Backend,

fn from(device: &<B as Backend>::Device) -> TensorCreationOptions<B>

Convenience conversion from a reference to a device.

Example:

use burn_tensor::backend::Backend;
use burn_tensor::TensorCreationOptions;

fn example<B: Backend>(device: B::Device) {
    let options: TensorCreationOptions<B> = (&device).into();
}

impl<B> From<(&<B as Backend>::Device, DType)> for TensorCreationOptions<B>

where B: Backend,

fn from(args: (&<B as Backend>::Device, DType)) -> TensorCreationOptions<B>

Convenience conversion for a specified (&device, dtype) tuple.