Struct FileCheckpoint

pub struct FileCheckpoint {
    pub frequency: CheckpointingFrequency,
    pub directory: PathBuf,
    pub filename: PathBuf,
}

Handles saving a checkpoint to disk as a binary file.

Fields

frequency: CheckpointingFrequency

Indicates how often a checkpoint is created

directory: PathBuf

Directory where the checkpoints are saved to

filename: PathBuf

Name of the checkpoint files

Implementations

impl FileCheckpoint

pub fn new<N: AsRef<str>>( directory: N, name: N, frequency: CheckpointingFrequency, ) -> Self

Create a new FileCheckpoint instance

Example

use argmin_checkpointing_file::{FileCheckpoint, CheckpointingFrequency};

let directory = "checkpoints";
let filename = "optimization";

// When passed to an `Executor`, this will save a checkpoint in the file
// `checkpoints/optimization.arg` in every iteration.
let checkpoint = FileCheckpoint::new(directory, filename, CheckpointingFrequency::Always);

Trait Implementations

impl<S, I> Checkpoint<S, I> for FileCheckpoint

where S: Serialize + DeserializeOwned, I: Serialize + DeserializeOwned,

fn save(&self, solver: &S, state: &I) -> Result<(), Error>

Writes checkpoint to disk.

If the directory does not exist already, it will be created. It uses bincode to serialize the data. It will return an error if creating the directory or file or serialization failed.

Example

use argmin_checkpointing_file::{FileCheckpoint, CheckpointingFrequency, Checkpoint};

checkpoint.save(&solver, &state);

fn load(&self) -> Result<Option<(S, I)>, Error>

Load a checkpoint from disk.

If there is no checkpoint on disk, it will return Ok(None). Returns an error if opening the file or deserialization failed.

Example

use argmin_checkpointing_file::{FileCheckpoint, CheckpointingFrequency, Checkpoint};

let (solver, state) = checkpoint.load()?.unwrap();

fn frequency(&self) -> CheckpointingFrequency

Returns the how often a checkpoint is to be saved.

Used internally by save_cond.

fn save_cond(&self, solver: &S, state: &I, iter: u64) -> Result<(), Error>

Saves a checkpoint when the checkpointing condition is met.

impl Clone for FileCheckpoint

fn clone(&self) -> FileCheckpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileCheckpoint

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

Formats the value using the given formatter.

impl Default for FileCheckpoint

fn default() -> FileCheckpoint

Create a default FileCheckpoint instance.

This will save the checkpoint in the file .checkpoints/checkpoint.arg.

Example

use argmin_checkpointing_file::FileCheckpoint;

let checkpoint = FileCheckpoint::default();

impl Hash for FileCheckpoint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FileCheckpoint

fn eq(&self, other: &FileCheckpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FileCheckpoint

impl StructuralPartialEq for FileCheckpoint