Struct Footprint 

#[non_exhaustive]
pub struct Footprint {
    pub mapped: u64,
    pub copied: u64,
    pub transient: u64,
}

What loading safetensors checkpoints holds in the GPU allocator, in bytes (see safetensors_footprint). Compare with nuvec_gpu::MemoryStats’s mapped, active and peak_with_mapped.

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.

mapped: u64

Kept mapped: of aligned files, the page-rounded ranges of the kept tensors (the whole file, header included, when every tensor is kept).

copied: u64

Read into allocator memory: the size-class-rounded tensors of files whose tensors are not aligned (as MLX writes them; mlx-community checkpoints). Such files are not mapped.

transient: u64

The peak of mapped + copied while loading: mapped + copied (no file is mapped and copied at once).

Trait Implementations

impl Clone for Footprint

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Footprint

impl Debug for Footprint

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

Formats the value using the given formatter.

impl Default for Footprint

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Footprint

impl PartialEq for Footprint

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Footprint