Struct furiosa_device::DeviceConfig

pub struct DeviceConfig { /* private fields */ }

Describes a required set of devices for find_device_files.

Examples

use furiosa_device::DeviceConfig;

// 1 core
DeviceConfig::warboy().build();

// 1 core x 2
DeviceConfig::warboy().count(2);

// Fused 2 cores x 2
DeviceConfig::warboy().fused().count(2);

Textual Representation

DeviceConfig supports textual representation, which is its equivalent string representation. One can obtain the corresponding DeviceConfig from the textual representation by using the FromStr trait, or by calling from_env after setting an environment variable.

use std::str::FromStr;

use furiosa_device::DeviceConfig;

let config = DeviceConfig::from_env("SOME_OTHER_ENV_KEY").build();
let config = DeviceConfig::from_str("npu:0:0,npu:0:1").unwrap(); // get config directly from a string literal

The rules for textual representation are as follows:

use std::str::FromStr;

use furiosa_device::DeviceConfig;

// Using specific device names
DeviceConfig::from_str("npu:0:0").unwrap(); // npu0pe0
DeviceConfig::from_str("npu:0:0-1").unwrap(); // npu0pe0-1

// Using device configs
DeviceConfig::from_str("warboy*2").unwrap(); // single pe x 2 (equivalent to "warboy(1)*2")
DeviceConfig::from_str("warboy(1)*2").unwrap(); // single pe x 2
DeviceConfig::from_str("warboy(2)*2").unwrap(); // 2-pe fusioned x 2

// Combine multiple representations separated by commas
DeviceConfig::from_str("npu:0:0-1,npu:1:0-1").unwrap(); // npu0pe0-1, npu1pe0-1

Implementations

impl DeviceConfig

pub fn warboy() -> DeviceConfigBuilder<Arch, NotDetermined, NotDetermined>

Returns a builder associated with Warboy NPUs.

pub fn warboy_a0() -> DeviceConfigBuilder<Arch, NotDetermined, NotDetermined>

pub fn from_env<K: ToString>(key: K) -> EnvBuilder<NotDetermined>

Returns a builder struct to read config saved in an environment variable. You can provide fallback options to the builder in case the envrionment variable is empty.

Trait Implementations

impl Clone for DeviceConfig

fn clone(&self) -> DeviceConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceConfig

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

Formats the value using the given formatter.

impl Default for DeviceConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeviceConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DeviceConfig

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

Formats the value using the given formatter.

impl From<DeviceConfig> for String

fn from(config: DeviceConfig) -> Self

Converts to this type from the input type.

impl FromStr for DeviceConfig

type Err = DeviceError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl Serialize for DeviceConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a str> for DeviceConfig

type Error = DeviceError

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryInto<DeviceConfig> for NotDetermined

type Error = DeviceError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<DeviceConfig, Self::Error>

Performs the conversion.