Struct SearchPlan 

pub struct SearchPlan { /* private fields */ }

A search spec checked against a model, with its space resolved.

Implementations

impl SearchPlan

pub fn new( spec: &SweepSpec, schema: &ModelSchema<'_>, ) -> Result<Self, SearchPlanError>

Checks the search of spec against schema, and resolves its space.

Errors

Returns SearchPlanError for a spec with no search or with blocks, search settings or a space that the search rejects, fixed values or actions that the model rejects, a batch of more than MAX_RUNS runs, or a budget whose runs overflow a 64-bit count.

pub fn base(&self) -> &Arc<Plan>

Plan of the spec’s fixed values and actions. Every candidate starts from the plan’s one config.

pub fn search(&self) -> &SearchSpec

Search settings of the spec.

pub fn space(&self) -> &SearchSpace

Space of the search, resolved against the model.

pub fn search_hash(&self) -> u64

Hash of every setting that fixes the search’s trajectory, from search_hash.

pub fn run_count(&self) -> u64

Number of runs in the whole budget, every evaluation times the replicates.

pub fn replicates(&self) -> u64

Number of runs of each evaluation.

pub fn config(&self, genome: &Genome) -> Config

Returns the config genome decodes to, over the spec’s fixed values and actions.

Panics

Panics when genome and the space have different gene counts.

pub fn run(&self, candidate: &Candidate, index: u64) -> PlannedRun

Returns run index of candidate, counting from 0.

Under independent seeds, a re-evaluation draws from the seeds of the candidate it repeats.

pub fn run_key(&self, run: &PlannedRun, config: &Config) -> u64

Returns the key that identifies the results of run, a run of a candidate whose config is config.

pub fn replay(&self, run: &PlannedRun, config: &Config) -> Replay

Returns the Replay of run, a run of a candidate whose config is config.

pub fn watched_reducers( &self, measure: &MeasurePlan, ) -> Result<Vec<usize>, SearchPlanError>

Returns the position of each watched column among the reducer columns of measure.

Errors

Returns SearchPlanError::UnknownColumn for a watched column that no reducer writes.

pub fn outline(&self) -> SearchOutline

Returns the budget, objective and space of the search.

Trait Implementations

impl Clone for SearchPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchPlan

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

Formats the value using the given formatter.