Struct RunConfig 

pub struct RunConfig {
    pub problem: Problem,
    pub sampler: SamplerChoice,
    pub scheduler: SchedulerChoice,
    pub seed: u64,
    pub budget: u64,
}

What a run is configured with.

Fields

problem: Problem

The function to minimize.

sampler: SamplerChoice

The sampler proposing trials.

scheduler: SchedulerChoice

The scheduler deciding on reports.

seed: u64

The study seed.

budget: u64

How many trials a run creates.

Implementations

impl RunConfig

pub const fn new_with_demo( problem: Problem, sampler: SamplerChoice, scheduler: SchedulerChoice, ) -> Self

A browser demo run with the defaults: seed 42, 100 trials.

pub const fn with_seed(self, seed: u64) -> Self

The same run from another study seed.

pub const fn with_budget(self, budget: u64) -> Self

The same run with another trial budget, raised to at least MIN_BUDGET.

pub const fn grid_side(&self) -> u64

Points per axis of the Grid sampler’s lattice: the largest square the budget holds, at least 2 and at most MAX_GRID_SIDE.

pub fn sampler_note(&self) -> String

The sampler’s sentence for this run: SamplerChoice::description, with Grid’s lattice spelled out for the budget.

pub const fn trains(&self) -> bool

Whether trials are simulated training runs that report every step (any scheduler, or DEHB’s fidelities), rather than one evaluation.

pub fn scheduler_note(&self) -> String

The scheduler’s sentence for this run: SchedulerChoice::description, with cart-pole’s parameters named by what they are.

pub fn trial_note(&self) -> String

What one trial of this run is, as the page explains it.

pub fn key(&self) -> String

The stable run identifier: problem/sampler/scheduler. Seed and budget are separate keys.

Trait Implementations

impl Clone for RunConfig

fn clone(&self) -> RunConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunConfig

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

Formats the value using the given formatter.

impl PartialEq for RunConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RunConfig