Struct CompilationConfig 

pub struct CompilationConfig {
    pub logger: LoggerConfig<CompilationLogLevel>,
    pub cache: bool,
    pub check_mode: BoundsCheckMode,
    pub f16_evaluation: Option<F16Evaluation>,
    pub dump_dir: Option<PathBuf>,
    pub time_passes: bool,
    pub debug_info: Option<DebugInfo>,
    pub spirv_debug_format: SpirvDebugFormat,
    pub source_cache: Option<PathBuf>,
    pub parallelism: Option<usize>,
}

Configuration for compilation settings in CubeCL.

Fields

logger: LoggerConfig<CompilationLogLevel>

Logger configuration for compilation logs, using binary log levels.

cache: bool

Whether compiled kernels are cached in the active environment.

check_mode: BoundsCheckMode

Controls whether kernel launches enforce bounds checks.

f16_evaluation: Option<F16Evaluation>

How far the CPU runtime carries an f16 intermediate in f32 before rounding it. None chooses by whether the host computes in f16 directly. Other runtimes ignore it.

dump_dir: Option<PathBuf>

Directory for compiler dumps. Each kernel writes its IR after every compiler pass, and its final source, to a subdirectory named after the kernel. Set by CUBECL_DEBUG_PLIRON.

time_passes: bool

Log how long each compiler pass takes, at the info level. Set by CUBECL_TIME_PASSES.

debug_info: Option<DebugInfo>

The most debug data a kernel may carry. None keeps what the cargo profile and the kernel ask for. It can only lower that level. Set by CUBECL_DEBUG_INFO.

spirv_debug_format: SpirvDebugFormat

The format of the debug data in SPIR-V kernels. Set by CUBECL_SPIRV_DEBUG_FORMAT.

source_cache: Option<PathBuf>

A directory for the source text of kernels with full debug data. When no directory on this computer has the source files of a kernel, cubecl writes the texts into this directory, and the debug data points to them. None writes no files. Set by CUBECL_SOURCE_CACHE.

parallelism: Option<usize>

How many threads a server compiles a queue of kernels on — see LaunchMode::Queue. The queue itself is as long as what was queued; each thread takes the next kernel as it finishes one. None uses every core the process may run on; a smaller number leaves cores to other work. It does not bound memory: a batch holds every queued kernel’s artifacts until it ends.

Implementations

impl CompilationConfig

pub fn resolve_debug_info(&self, requested: DebugInfo) -> DebugInfo

The debug data of a kernel that asks for requested: at least PROFILE_DEBUG_INFO, at most debug_info.

pub fn parallelism(&self) -> usize

How many threads compile at once: the configured count, or every core the process may run on. Never zero, and one without threads — on wasm too, whatever is configured, since it cannot spawn them.

Trait Implementations

impl Clone for CompilationConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompilationConfig

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

Formats the value using the given formatter.

impl Default for CompilationConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompilationConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompilationConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.