Struct TrialTemplate 

#[non_exhaustive]
pub struct TrialTemplate {
    pub fixed: Assignment,
    pub parent: Option<TrialId>,
}

A request to create a trial with something already decided.

Covers two cases:

• enqueued trials: fixed parameters the user wants evaluated, which take priority over sampling (what a trial’s parameters actually are);
• forks: a child of parent, used by PBT-style schedulers. Storage persists the reference onto FrozenTrial::parent and does nothing else with it.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fixed: Assignment

Parameters that must not be sampled.

parent: Option<TrialId>

The trial this one forks from, if any.

Implementations

impl TrialTemplate

pub fn new_with_fixed_params(params: Assignment) -> Self

A template with fixed parameters and no parent.

pub fn new_with_parent_and_mutation( parent: TrialId, mutation: Assignment, ) -> Self

A template that forks parent, carrying mutated parameters.

pub fn is_empty(&self) -> bool

true if nothing is fixed and there is no parent.

Trait Implementations

impl Clone for TrialTemplate

fn clone(&self) -> TrialTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrialTemplate

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

Formats the value using the given formatter.

impl Default for TrialTemplate

fn default() -> TrialTemplate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrialTemplate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TrialTemplate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TrialTemplate

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 TrialTemplate