Enum Evaluation 

#[non_exhaustive]
pub enum Evaluation {
    Checkpoint,
    Recipe,
}

Which final-stage estimand an evaluation computes.

Read by the objective through TrialCtx::evaluation; a Subprocess child reads its name from ATUNE_EVALUATE. Configuration re-evaluation (Study::reevaluate) is not one of these: it is an ordinary fresh run, and the context reports None.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Checkpoint

Evaluate the trial’s latest checkpoint, without training. The context’s parent_checkpoint is that checkpoint.

Recipe

Train afresh following the trial’s recipe, readable through TrialCtx::recipe.

Implementations

impl Evaluation

pub const fn name(self) -> &'static str

The estimand’s stable name: "checkpoint" or "recipe".

Trait Implementations

impl Clone for Evaluation

fn clone(&self) -> Evaluation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Evaluation

impl Debug for Evaluation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Evaluation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Evaluation

impl Hash for Evaluation

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 Ord for Evaluation

fn cmp(&self, other: &Evaluation) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Evaluation

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Evaluation

fn partial_cmp(&self, other: &Evaluation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Evaluation

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 Evaluation