Skip to main content

SearchSpec

Struct SearchSpec 

Source
pub struct SearchSpec {
    pub algorithm: SearchAlgorithm,
    pub max_evaluations: u64,
    pub batch_size: usize,
    pub objective: Option<Objective>,
    pub space: Vec<FactorSpec>,
}
Expand description

A search as written, with its space still in the form that a spec uses.

Fields§

§algorithm: SearchAlgorithm

Search method, with its settings.

§max_evaluations: u64

Maximum number of evaluations, re-evaluations included.

§batch_size: usize

Maximum number of candidates that one ask returns.

§objective: Option<Objective>

Output a random search, hill climb or genetic algorithm scores. A Pattern Space Exploration has no objective.

§space: Vec<FactorSpec>

Factors the search varies. A range with no step spans every value from its min to its max.

Implementations§

Source§

impl SearchSpec

Source

pub fn check(&self) -> Result<(), SearchSpecError>

Checks the budget, the batch size, the objective and the settings of the algorithm.

A batch holds at most MAX_CONFIGS candidates, the same limit as the configs of a sweep’s plan.

§Errors

Returns SearchSpecError for no evaluations, a batch size of 0 or past MAX_CONFIGS, a missing objective for a random search, hill climb or genetic algorithm, an objective given to a Pattern Space Exploration, or a setting outside its range.

Source

pub fn watched_columns(&self) -> Vec<&str>

Returns the output columns each replicate of an evaluation reports, in the order Evaluation::outputs holds them.

Source

pub fn searcher( &self, space: &SearchSpace, root: u64, ) -> Result<Box<dyn Searcher + Send>, SearchSpecError>

Returns a searcher over space, drawing from search_seed of root.

§Errors

Returns SearchSpecError when Self::check rejects the spec.

Trait Implementations§

Source§

impl Clone for SearchSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SearchSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SearchSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSync for T
where T: Sync,