Enum burn::backend::candle::CandleDevice

pub enum CandleDevice {
    Cpu,
    Cuda(CudaDevice),
    Metal(MetalDevice),
}

The device type for the candle backend. The device struct when using the candle backend.

To create a Cuda or Metal device from the index, use the associated methods to create the variant:

use burn_candle::CandleDevice;

// Create a Cuda device from its index
let device = CandleDevice::cuda(0);
// Create a Metal device from its index
let device = CandleDevice::metal(0);

Variants

Cpu

CPU device.

Cuda(CudaDevice)

Cuda device with the given index. The index is the index of the Cuda device in the list of all Cuda devices found on the system.

Metal(MetalDevice)

Metal device with the given index. The index is the index of the Metal device in the list of all Metal devices found on the system.

Implementations

impl CandleDevice

pub fn cuda(index: usize) -> CandleDevice

Create a Cuda device with the given index. The index is the index of the Cuda device in the list of all Cuda devices found on the system.

pub fn metal(index: usize) -> CandleDevice

Create a Metal device with the given index. The index is the index of the Metal device in the list of all Metal devices found on the system.

Trait Implementations

impl Clone for CandleDevice

fn clone(&self) -> CandleDevice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CandleDevice

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

Formats the value using the given formatter.

impl Default for CandleDevice

fn default() -> CandleDevice

Returns the “default value” for a type.

impl DeviceOps for CandleDevice

fn id(&self) -> DeviceId

Return the device id.

impl From<CandleDevice> for Device

fn from(device: CandleDevice) -> Device

Converts to this type from the input type.

impl From<Device> for CandleDevice

fn from(device: Device) -> CandleDevice

Converts to this type from the input type.

impl PartialEq for CandleDevice

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CandleDevice

impl StructuralPartialEq for CandleDevice