Enum Device 

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

Where to run the compute.

Each variant maps onto the concrete Device type of whichever cubecl runtime was selected.

Not every variant makes sense on every backend. Integrated and Virtual are wgpu-only, and Cpu does nothing on the cpu runtime while selecting WgpuDevice::Cpu on wgpu.

Asking for a variant a runtime cannot honour returns an error from the matching 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

The software device. Valid on the cpu runtime, and on wgpu where it picks the lavapipe or 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 Display for Device

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

Writes the selector spelling FromStr accepts, so a device prints as discrete:1 rather than as its enum variant.

impl Eq for Device

impl FromStr for Device

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

Accepts the same spellings as the bench CLI.

• default
• discrete[:N], integrated[:N], and virtual[:N], where N defaults to 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