Struct ProcessModeOverride 

pub struct ProcessModeOverride { /* private fields */ }

Applies a process mode to the whole process while it lives, counting what it triggers into a collector, on every thread and every device.

A build that compiles everything and then tunes with it compiled opens two, one after the other, with one collector:

use cubecl_runtime::execution::{ProcessModeOverride, ProcessMode, StatisticsCollector};

let collector = StatisticsCollector::new();

// Gather every kernel the warm-up reaches, and compile them together...
let compile = ProcessModeOverride::new(ProcessMode::CompileOnly, &collector);
warm_up();
core::mem::drop(compile);

// ...then tune with them compiled.
let tune = ProcessModeOverride::new(ProcessMode::CompileAndAutotune, &collector);
warm_up();
core::mem::drop(tune);

let statistics = collector.statistics();
assert_eq!(statistics.compilation.settled(), statistics.compilation.registered);

Overlapping overrides of one process mode and one collector compose, so one opened while another is still open leaves the process mode until the last of them drops. One process mode and one collector at a time: the process mode is process-wide, and the work under it counts to one collector.

The process mode is read where a launch is issued, with relaxed ordering, so a launch another thread had already begun issuing may still execute. What is guaranteed is the launches issued by the thread that opened it, and every launch issued after other threads observe it.

There is deliberately no configuration file or environment variable for it. An override left open by accident turns the rest of the process into launches that quietly do nothing and read back uninitialized memory, so its lifetime belongs to a scope in the code that wants it.

Implementations

impl ProcessModeOverride

pub fn new(mode: ProcessMode, collector: &StatisticsCollector) -> Self

Panics

If an override of another process mode, or of another collector, is open.

pub fn mode(&self) -> ProcessMode

The process mode it applies.

Trait Implementations

impl Debug for ProcessModeOverride

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

Formats the value using the given formatter.

impl Drop for ProcessModeOverride

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.