Struct BurnConfig 

pub struct BurnConfig { /* private fields */ }

Represents the global configuration for Burn.

Implementations

impl BurnConfig

pub fn fusion(&self) -> &FusionConfig

Returns a reference to the operation-fusion configuration.

pub fn autodiff(&self) -> &AutodiffConfig

Returns a reference to the autodiff configuration.

pub fn remote(&self) -> &RemoteConfig

Returns a reference to the remote-backend configuration.

Trait Implementations

impl Clone for BurnConfig

fn clone(&self) -> BurnConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BurnConfig

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

Formats the value using the given formatter.

impl Default for BurnConfig

fn default() -> BurnConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BurnConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl RuntimeConfig for BurnConfig

fn storage() -> &'static Mutex<Option<Arc<BurnConfig>>>

Global storage for the configuration singleton.

fn file_names() -> &'static [&'static str]

File names searched in each directory during [Config::from_current_dir].

fn override_from_env(self) -> BurnConfig

Hook to override fields from environment variables after loading from disk.

fn section_file_names() -> &'static [(&'static str, &'static str)]

File names searched in each directory, where only a specific TOML section is loaded instead of the whole file.

fn on_loaded(&self)

Hook invoked exactly once, when the configuration singleton is first initialized — whether loaded from disk in [RuntimeConfig::get] or installed with [RuntimeConfig::set] / [RuntimeConfig::try_set].

fn get() -> Arc<Self>

Retrieves the current configuration, loading it from the current directory if not set.

fn set(config: Self)

Sets the configuration to the provided value.

fn try_set(config: Self) -> bool

Sets the configuration to the provided value, unless it has already been set or read — in which case the existing configuration is kept and false is returned.

fn save_default<P>(path: P) -> Result<(), Error>

where P: AsRef<Path>,

Save the default configuration to the provided file path.

fn from_current_dir() -> Self

Loads configuration from any of [Config::file_names] in the current directory or its parents.

fn from_file_path<P>(path: P) -> Result<Self, Error>

where P: AsRef<Path>,

Loads configuration from a specified file path.

fn from_section_file_path<P>(path: P, section: &str) -> Result<Self, Error>

where P: AsRef<Path>,

Loads configuration from a specific TOML section of the file at the given path.

impl Serialize for BurnConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.