Struct CheckpointBuilder

Source

pub struct CheckpointBuilder { /* private fields */ }

Expand description

Builder for creating checkpoints.

Implementations§

Source §

impl CheckpointBuilder

Source

pub fn new() -> Self

Create a new checkpoint builder.

Source

pub fn model_state(self, state: StateDict) -> Self

Set the model state.

Source

pub fn optimizer_state(self, state: StateDict) -> Self

Set the optimizer state.

Source

pub fn training_state(self, state: TrainingState) -> Self

Set the training state.

Source

pub fn rng_state(self, state: Vec<u8>) -> Self

Set the RNG state.

Source

pub fn config(self, key: &str, value: &str) -> Self

Add a configuration value.

Source

pub fn epoch(self, epoch: usize) -> Self

Set the epoch.

Source

pub fn global_step(self, step: usize) -> Self

Set the global step.

Source

pub fn build(self) -> Checkpoint

Build the checkpoint.

Trait Implementations§

Source §

impl Default for CheckpointBuilder

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for CheckpointBuilder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §