Struct Checkpoint 

pub struct Checkpoint {
    pub version: u32,
    pub metadata: CheckpointMetadata,
    pub tensors: Vec<CheckpointTensor>,
}

A serialized model checkpoint containing metadata and named tensors.

Fields

version: u32

Format version (always 1 for new checkpoints).

metadata: CheckpointMetadata

Arbitrary key-value metadata (e.g. step, loss, lr).

tensors: Vec<CheckpointTensor>

Ordered list of tensor entries.

Implementations

impl Checkpoint

pub fn new() -> Self

Create an empty checkpoint (version 1, no metadata, no tensors).

pub fn add_tensor(&mut self, tensor: CheckpointTensor)

Append a tensor to the checkpoint.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Insert or replace a metadata key-value pair.

pub fn get_metadata(&self, key: &str) -> Option<&str>

Look up a metadata value by key.

pub fn get_tensor(&self, name: &str) -> Option<&CheckpointTensor>

Find a tensor by name (linear scan; checkpoints are small).

pub fn total_bytes(&self) -> usize

Total bytes occupied by all tensor data (sum of size_bytes()).

pub fn num_params(&self) -> u64

Total number of f32 parameters across all tensors.

pub fn save(&self, path: &Path) -> Result<(), CheckpointError>

Save the checkpoint to path, creating or truncating the file.

pub fn load(path: &Path) -> Result<Self, CheckpointError>

Load a checkpoint from path.

pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<(), CheckpointError>

Serialise the checkpoint into writer.

The writer is NOT flushed; callers that need it (e.g. BufWriter) must flush themselves, or use save which wraps a BufWriter and flushes on drop.

pub fn read_from<R: Read>(reader: &mut R) -> Result<Self, CheckpointError>

Deserialise a checkpoint from reader.

Trait Implementations

impl Debug for Checkpoint

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

Formats the value using the given formatter.

impl Default for Checkpoint

fn default() -> Self

Returns the “default value” for a type.