Struct LrSchedulerRecord 

pub struct LrSchedulerRecord { /* private fields */ }

The serialized state of a learning rate scheduler, stored in the burnpack format.

Scheduler state is just a handful of scalars (step counters, current learning rate), so the record holds named typed scalars and no tensors. Composed schedulers nest their children’s records under an index prefix via with_record / record.

Implementations

impl LrSchedulerRecord

pub fn new() -> LrSchedulerRecord

Create an empty record.

pub fn is_empty(&self) -> bool

Whether the record holds no scalars.

pub fn with_scalar<V>(self, key: &str, value: V) -> LrSchedulerRecord

where V: Into<Scalar>,

Store a scalar under key.

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

where V: TryFrom<Scalar>,

Read the scalar stored under key, if present and of a compatible type.

pub fn with_record( self, prefix: &str, record: LrSchedulerRecord, ) -> LrSchedulerRecord

Merge a child record’s scalars under prefix (used to compose schedulers).

pub fn record(&self, prefix: &str) -> LrSchedulerRecord

Extract the child record previously merged under prefix.

pub fn from_state<S>(state: &S) -> LrSchedulerRecord

where S: RecordState,

Build a record from a scheduler state.

Scheduler state is scalar-only, so this reuses the same RecordState decomposition as optimizer states (it panics in debug builds if a tensor leaf is produced).

pub fn into_state<S>(&self) -> Option<S>

where S: RecordState,

Reconstruct a scheduler state from this record.

Uses the default device; scheduler state is scalar-only so no tensor is ever allocated.

pub fn into_bytes(self) -> Result<Bytes, RecordError>

Serialize the record to an in-memory burnpack byte buffer.

pub fn from_bytes(bytes: Bytes) -> Result<LrSchedulerRecord, RecordError>

Reconstruct a record from an in-memory burnpack byte buffer.

pub fn save<P>(self, path: P) -> Result<(), RecordError>

where P: AsRef<Path>,

Save the record to a burnpack file on disk.

pub fn load<P>(path: P) -> Result<LrSchedulerRecord, RecordError>

where P: AsRef<Path>,

Load the record from a burnpack file on disk.

Trait Implementations

impl Checkpoint for LrSchedulerRecord

fn save(self, path: PathBuf) -> Result<(), CheckpointerError>

Save the record to path.

fn load(path: PathBuf) -> Result<LrSchedulerRecord, CheckpointerError>

Load the record from path.

fn checkpoint_from_bytes(bytes: Bytes) -> Result<LrSchedulerRecord, RecordError>

Creates a checkpoint from bytes

fn checkpoint_into_bytes(self) -> Result<Bytes, RecordError>

Transforms a checkpoint into bytes

impl Clone for LrSchedulerRecord

fn clone(&self) -> LrSchedulerRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LrSchedulerRecord

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

Formats the value using the given formatter.

impl Default for LrSchedulerRecord

fn default() -> LrSchedulerRecord

Returns the “default value” for a type.