Struct MemoryBudget 

#[non_exhaustive]
pub struct MemoryBudget {
    pub device_bytes: u64,
    pub allow_ooc: bool,
    pub abort_on_exceed: bool,
}

GPU memory budget configuration.

Use MemoryBudget::default() or the builder methods (MemoryBudget::from_device_memory, MemoryBudget::with_limit, MemoryBudget::with_ooc) to construct.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

device_bytes: u64

Maximum device memory to use in bytes

allow_ooc: bool

Allow out-of-core execution (spill to host)

abort_on_exceed: bool

Abort on memory budget exceeded (vs try to continue)

Implementations

impl MemoryBudget

pub fn from_device_memory(total_bytes: u64) -> Self

Create a budget using 80% of available device memory

pub fn with_limit(device_bytes: u64) -> Self

Create a budget with explicit byte limit

pub fn with_ooc(self) -> Self

Enable out-of-core mode

Trait Implementations

impl Clone for MemoryBudget

fn clone(&self) -> MemoryBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryBudget

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

Formats the value using the given formatter.

impl Default for MemoryBudget

fn default() -> Self

Returns the “default value” for a type.