Struct argmin_observer_paramwriter::ParamWriter

pub struct ParamWriter { /* private fields */ }

Write parameter vectors to a file during optimization.

This observer requires a directory to save the files to and a file prefix. Files will be written to disk as <directory>/<file_prefix>_<iteration_number>.<extension>. For serialization either JSON or Binary (via bincode) can be chosen via the enum ParamWriterFormat.

Example

Create an observer for saving the parameter vector into a JSON file.

use argmin_observer_paramwriter::{ParamWriter, ParamWriterFormat};

let observer = ParamWriter::new("directory", "file_prefix", ParamWriterFormat::JSON);

Create an observer for saving the parameter vector into a binary file using bincode.

use argmin_observer_paramwriter::{ParamWriter, ParamWriterFormat};

let observer = ParamWriter::new("directory", "file_prefix", ParamWriterFormat::Binary);

Implementations

impl ParamWriter

pub fn new<N: AsRef<str>>( dir: N, prefix: N, serializer: ParamWriterFormat, ) -> Self

Create a new instance of ParamWriter.

Example

let observer = ParamWriter::new("directory", "file_prefix", ParamWriterFormat::JSON);

Trait Implementations

impl Clone for ParamWriter

fn clone(&self) -> ParamWriter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParamWriter

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

Formats the value using the given formatter.

impl<I> Observe<I> for ParamWriter

where I: State, <I as State>::Param: Serialize,

ParamWriter only implements observer_iter and not observe_init to avoid saving the initial parameter vector. It will only save if there is a parameter vector available in the state, otherwise it will skip saving silently.

fn observe_iter(&mut self, state: &I, _kv: &KV) -> Result<(), Error>

Called at every iteration of the solver

fn observe_init( &mut self, _name: &str, _state: &I, _kv: &KV, ) -> Result<(), Error>

Called once after initialization of the solver.

fn observe_final(&mut self, _state: &I) -> Result<(), Error>

Called at the end of a solver run

impl PartialEq for ParamWriter

fn eq(&self, other: &ParamWriter) -> 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 ParamWriter

impl StructuralPartialEq for ParamWriter