Struct MemorySnapshot 

pub struct MemorySnapshot {
    pub ram_bytes: u64,
    pub vram_bytes: Option<u64>,
    pub vram_total_bytes: Option<u64>,
    pub vram_per_process: Option<bool>,
    pub gpu_name: Option<String>,
}

Memory snapshot at a point in time.

Captures process RAM (resident set size) and optionally GPU VRAM. Use MemorySnapshot::now to take a measurement, and MemoryReport::new to compute deltas between two snapshots.

Example

use candle_mi::MemorySnapshot;

let before = MemorySnapshot::now(&candle_core::Device::Cpu)?;
// ... load a model ...
let after = MemorySnapshot::now(&candle_core::Device::Cpu)?;
let report = candle_mi::MemoryReport::new(before, after);
println!("RAM delta: {:+.1} MB", report.ram_delta_mb());

Fields

ram_bytes: u64

Process resident set size (working set on Windows) in bytes.

vram_bytes: Option<u64>

GPU memory used in bytes. Per-process when measured via DXGI/NVML, device-wide when via nvidia-smi fallback. None if no GPU is present or measurement failed.

vram_total_bytes: Option<u64>

Total GPU memory on the active device in bytes. None if no GPU is present or measurement failed.

vram_per_process: Option<bool>

Whether the VRAM measurement is per-process (true) or device-wide (false). None if no VRAM data is available.

gpu_name: Option<String>

GPU adapter name (e.g., NVIDIA GeForce RTX 5060 Ti). None if not available (non-DXGI path or no GPU).

Implementations

impl MemorySnapshot

pub fn now(device: &Device) -> Result<Self>

Capture current memory state.

RAM is always measured (per-process RSS). VRAM is measured only if device is CUDA — first via DXGI (Windows, per-process), then NVML (Linux, per-process), falling back to nvidia-smi (device-wide).

Errors

Returns MIError::Memory if the RAM query fails (platform API error). VRAM measurement failures are non-fatal — vram_bytes is set to None.

pub fn ram_mb(&self) -> f64

Format RAM usage as megabytes.

pub fn vram_mb(&self) -> Option<f64>

Format VRAM usage as megabytes, if available.

Trait Implementations

impl Clone for MemorySnapshot

fn clone(&self) -> MemorySnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemorySnapshot

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

Formats the value using the given formatter.