Enum spectator::Message

pub enum Message {
    NewRun {
        name: String,
        solver: String,
        max_iter: u64,
        target_cost: f64,
        init_param: Option<Vec<f64>>,
        settings: KV,
        selected: HashSet<String>,
    },
    Samples {
        name: String,
        iter: u64,
        time: Duration,
        termination_status: TerminationStatus,
        kv: KV,
    },
    FuncCounts {
        name: String,
        iter: u64,
        kv: HashMap<String, u64>,
    },
    Param {
        name: String,
        iter: u64,
        param: Vec<f64>,
    },
    BestParam {
        name: String,
        iter: u64,
        param: Vec<f64>,
    },
    Termination {
        name: String,
        termination_status: TerminationStatus,
    },
}

Enum used to encode information sent to spectator.

Variants

NewRun

Fields

name: String

Name of the run

solver: String

Name of the solver

max_iter: u64

Maximum number of iterations

target_cost: f64

Target cost function value

init_param: Option<Vec<f64>>

Initial parameter vector

settings: KV

Solver-specific settings (returned by the init method of the Solver trait)

selected: HashSet<String>

Preselected metrics

Register a new run

Samples

Fields

name: String

Name of the run

iter: u64

Current iteration

time: Duration

Time needed for this iteration

termination_status: TerminationStatus

Current termination_status

kv: KV

Solver-specific metrics

A set of metrics samples sent after an iteration

FuncCounts

Fields

name: String

Name of the run

iter: u64

Current iteration

kv: HashMap<String, u64>

Function counts

Function evaluation counts (Cost function, gradient, Hessian, …)

Param

Fields

name: String

Name of the run

iter: u64

Current iteration

param: Vec<f64>

Current parameter vector

Parameter vector

BestParam

Fields

name: String

Name of the run

iter: u64

Current iteration

param: Vec<f64>

Current best parameter vector

Current best parameter vector

Termination

Fields

name: String

Name of the run

termination_status: TerminationStatus

Termination status

Termination

Implementations

impl Message

pub fn pack(&self) -> Result<Bytes, Error>

Serialize message

pub fn unpack(buf: &BytesMut) -> Result<Self, Error>

Deserialize message

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Message

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Message