Enum Device 

pub enum Device {
    Default,
    Discrete {
        index: usize,
    },
    Integrated {
        index: usize,
    },
    Virtual {
        index: usize,
    },
    Cpu,
}

Where to run the compute. The library maps each variant onto the concrete Device type of whichever cubecl runtime was selected.

Some variants are only meaningful for certain backends. Integrated and Virtual are wgpu-only; Cpu is a no-op on the cpu runtime and selects WgpuDevice::Cpu on wgpu. Asking for a variant on a runtime that can’t honour it returns an error from the relevant to_* conversion.

Variants

Default

Backend-chosen default device.

Discrete

Discrete GPU at ordinal index.

Maps to CudaDevice { index }, AmdDevice { index }, or WgpuDevice::DiscreteGpu(index).

Fields

index: usize

Integrated

Integrated GPU at ordinal index. wgpu-only.

Fields

index: usize

Virtual

Virtual GPU at ordinal index. wgpu-only.

Fields

index: usize

Cpu

Software/CPU device. Valid on the cpu runtime and on wgpu (where it picks the lavapipe / software adapter).

Implementations

impl Device

pub fn to_wgpu(&self) -> Result<WgpuDevice, Error>

Available on crate features metal or vulkan only.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl Default for Device

fn default() -> Device

Returns the “default value” for a type.

impl Eq for Device

impl FromStr for Device

fn from_str(s: &str) -> Result<Self, Self::Err>

FromStr accepts the same syntax as the bench CLI:

• default
• discrete[:N], integrated[:N], virtual[:N] (default N = 0)
• cpu

type Err = String

The associated error which can be returned from parsing.

impl PartialEq for Device

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Device