Enum TrialState 

pub enum TrialState {
    Waiting,
    Running,
    Paused,
    Complete,
    Pruned,
    Failed,
}

Where a trial is in its life cycle.

Variants

Waiting

Created, not yet picked up by a worker.

Running

A worker is evaluating it.

Paused

Suspended by a scheduler, with a checkpoint reference; may resume.

Legal in the state machine from the start, so that storage backends and journal formats needed no breaking change when pausing schedulers arrived.

Complete

Finished successfully; values hold the objective.

Pruned

Stopped early by a scheduler; the last intermediate value is the objective.

Failed

Stopped by an error; error holds the reason.

Implementations

impl TrialState

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

The stable lowercase spelling, such as "complete" or "pruned".

Storage text columns, the Python API, and the CLI reports all use this spelling, so it is written out here rather than derived from Debug: a change to an unrelated derive must not be able to rewrite it.

pub const fn is_finished(self) -> bool

true for the terminal states: Complete, Pruned, Failed.

Finished trials are immutable.

pub const fn is_active(self) -> bool

true if a worker is expected to be making progress on the trial.

Paused counts as active but not progressing: it is not finished and it still owns its checkpoint, so it is not is_active.

pub const fn can_transition_to(self, next: Self) -> bool

Whether self -> next is a legal transition.

From	To
Waiting	Running, Failed
Running	Complete, Pruned, Paused, Failed, Waiting
Paused	Running, Pruned, Failed
terminal	—

Running -> Waiting is legal but unused in-tree: stale-worker fail-over (fail_over_stale) moves the trial to Failed and, when the policy requeues, creates a replacement trial instead of returning the original to the pool. A transition to the same state is never legal — the caller has already lost the race (see Storage::try_transition).

Trait Implementations

impl Clone for TrialState

fn clone(&self) -> TrialState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TrialState

impl Debug for TrialState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TrialState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TrialState

Writes as_str.

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

Formats the value using the given formatter.

impl Eq for TrialState

impl Hash for TrialState

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 TrialState

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TrialState

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

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 TrialState