Skip to main content

Device

Struct Device 

Source
pub struct Device { /* private fields */ }
Expand description

A device on which tensors can be created and computations performed.

Internally this is an Arc<dyn DynBackendDevice> — a trait-object handle to the concrete backend device. CPU, CUDA, Metal, and arbitrary third-party backends are all accessed through this single type.

§Example

use fuel_tensor::{Device, DType};
use fuel_tensor::lazy::Tensor;
let dev = Device::cpu();
let t = Tensor::zeros((2, 3), DType::F32, &dev)?;
assert_eq!(t.shape().dims(), &[2, 3]);

Implementations§

Source§

impl Device

Source

pub fn cpu() -> Self

Returns a CPU device.

§Example
use fuel_tensor::Device;
let dev = Device::cpu();
assert!(dev.is_cpu());
Source

pub fn custom(device: Arc<dyn DynBackendDevice>) -> Self

Creates a device backed by a custom DynBackendDevice.

The device uses dynamic dispatch for all operations, enabling third-party backends without modifying fuel-core.

Source

pub fn as_dyn(&self) -> &Arc<dyn DynBackendDevice> ⓘ

Borrow the underlying Arc<dyn DynBackendDevice>.

Phase 7.5 work item G2: fuel-graph’s slot-populating constructors (Tensor::from_f32, const_f32_like, etc.) take a &Arc<dyn DynBackendDevice> so they can allocate Storage on the right device without depending on fuel-core. Callers that hold a &fuel_tensor::Device thread it through with dev.as_dyn().

Source

pub fn is_custom(&self) -> bool

Returns true if this is a custom (third-party) device.

Source

pub fn set_seed(&self, seed: u64) -> Result<()>

Sets the random seed for this device’s random number generator.

Source

pub fn get_current_seed(&self) -> Result<u64>

Returns the current random seed for this device.

Source

pub fn same_device(&self, rhs: &Self) -> bool

Returns true if both devices refer to the same physical device.

§Example
use fuel_tensor::Device;
assert!(Device::cpu().same_device(&Device::cpu()));
Source

pub fn location(&self) -> DeviceLocation

Returns the physical DeviceLocation for this device.

§Example
use fuel_tensor::{Device, DeviceLocation};
assert_eq!(Device::cpu().location(), DeviceLocation::Cpu);
Source

pub fn is_cpu(&self) -> bool

Returns true if this is the CPU device.

§Example
use fuel_tensor::Device;
assert!(Device::cpu().is_cpu());
Source

pub fn is_cuda(&self) -> bool

Returns true if this is a CUDA device.

§Example
use fuel_tensor::Device;
assert!(!Device::cpu().is_cuda());
Source

pub fn is_metal(&self) -> bool

Returns true if this is a Metal device.

§Example
use fuel_tensor::Device;
assert!(!Device::cpu().is_metal());
Source

pub fn supports_bf16(&self) -> bool

Returns true if this device has native BF16 support.

§Example
use fuel_tensor::Device;
// CPU does not have native BF16 support
assert!(!Device::cpu().supports_bf16());
Source

pub fn bf16_default_to_f32(&self) -> DType

Returns DType::BF16 if supported, otherwise DType::F32.

§Example
use fuel_tensor::{Device, DType};
assert_eq!(Device::cpu().bf16_default_to_f32(), DType::F32);
Source

pub fn synchronize(&self) -> Result<()>

Synchronizes the device, waiting for all pending operations to complete.

This is a no-op on CPU.

use fuel_tensor::Device;
Device::cpu().synchronize()?;

Trait Implementations§

Source§

impl Clone for Device

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Device

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more