Struct GlobalConfig

pub struct GlobalConfig {
    pub profiling: ProfilingConfig,
    pub autotune: AutotuneConfig,
    pub compilation: CompilationConfig,
}

Represents the global configuration for CubeCL, combining profiling, autotuning, and compilation settings.

Fields

profiling: ProfilingConfig

Configuration for profiling CubeCL operations.

autotune: AutotuneConfig

Configuration for autotuning performance parameters.

compilation: CompilationConfig

Configuration for compilation settings.

Implementations

impl GlobalConfig

pub fn get() -> Arc<Self>

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

If no configuration is set, it attempts to load one from cubecl.toml or CubeCL.toml in the current directory or its parents. If no file is found, a default configuration is used.

Notes

Calling this function is somewhat expensive, because of a global static lock. The config format is optimized for parsing, not for consumption. A good practice is to use a local static atomic value that you can populate with the appropriate value from the global config during initialization of the atomic value.

For example, the autotune level uses a core::sync::atomic::AtomicI32 with an initial value of -1 to indicate an uninitialized state. It is then set to the proper value based on the super::autotune::AutotuneLevel config. All subsequent fetches of the value are lock-free.

pub fn save_default<P: AsRef<Path>>(path: P) -> Result<()>

Save the default configuration to the provided file path.

pub fn set(config: Self)

Sets the global configuration to the provided value.

Panics

Panics if the configuration has already been set or read, as it cannot be overridden.

Warning

This method must be called at the start of the program, before any calls to get. Attempting to set the configuration after it has been initialized will cause a panic.

pub fn override_from_env(self) -> Self

Overrides configuration fields based on environment variables.

Trait Implementations

impl Clone for GlobalConfig

fn clone(&self) -> GlobalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalConfig

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

Formats the value using the given formatter.

impl Default for GlobalConfig

fn default() -> GlobalConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlobalConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GlobalConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.