Struct Checkpoint 

pub struct Checkpoint {
    pub metadata: CheckpointMetadata,
    /* private fields */
}

A checkpoint containing executor state.

Fields

metadata: CheckpointMetadata

Checkpoint metadata

Implementations

impl Checkpoint

pub fn from_executor( executor: &Scirs2Exec, iteration: usize, ) -> TlBackendResult<Self>

Create a checkpoint from an executor.

pub fn from_executor_with_config( executor: &Scirs2Exec, iteration: usize, config: &CheckpointConfig, ) -> TlBackendResult<Self>

Create a checkpoint with custom configuration.

pub fn save<P: AsRef<Path>>(&self, path: P) -> TlBackendResult<()>

Save checkpoint to a file.

pub fn load<P: AsRef<Path>>(path: P) -> TlBackendResult<Self>

Load checkpoint from a file.

pub fn load_with_config<P: AsRef<Path>>( path: P, config: &CheckpointConfig, ) -> TlBackendResult<Self>

Load checkpoint with custom configuration.

pub fn restore(&self) -> TlBackendResult<Scirs2Exec>

Restore an executor from this checkpoint.

pub fn restore_into(&self, executor: &mut Scirs2Exec) -> TlBackendResult<()>

Restore tensors into an existing executor.

pub fn add_metadata(&mut self, key: String, value: String)

Add custom metadata to the checkpoint.

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

Get custom metadata from the checkpoint.

pub fn size_bytes(&self) -> usize

Get the size of this checkpoint in bytes (uncompressed).

pub fn size_human_readable(&self) -> String

Get a human-readable size string.

Trait Implementations

impl Clone for Checkpoint

fn clone(&self) -> Checkpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Checkpoint

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

Formats the value using the given formatter.