Struct SearchSpace 

pub struct SearchSpace<P: ParamKey = GenericParam> { /* private fields */ }

Type-safe search space for hyperparameters.

Example

use aprender::automl::{SearchSpace, LogScale};
use aprender::automl::params::RandomForestParam as RF;

let space = SearchSpace::new()
    .add(RF::NEstimators, 10..500)
    .add(RF::MaxDepth, 2..20);

assert_eq!(space.len(), 2);

Implementations

impl<P: ParamKey> SearchSpace<P>

pub fn new() -> Self

Create an empty search space.

pub fn len(&self) -> usize

Number of parameters in the space.

pub fn is_empty(&self) -> bool

Check if space is empty.

pub fn add(self, key: P, range: Range<i64>) -> Self

Add an integer parameter from a range.

pub fn add_continuous(self, key: P, low: f64, high: f64) -> Self

Add a continuous parameter from a float range.

pub fn add_log_scale(self, key: P, log_scale: LogScale) -> Self

Add a log-scale continuous parameter.

pub fn add_categorical<I, V>(self, key: P, choices: I) -> Self

where I: IntoIterator<Item = V>, V: Into<ParamValue>,

Add a categorical parameter from string choices.

pub fn add_bool(self, key: P, choices: [bool; 2]) -> Self

Add a boolean parameter.

pub fn add_param(self, key: P, param: HyperParam) -> Self

Add a raw HyperParam.

pub fn get(&self, key: &P) -> Option<&HyperParam>

Get parameter definition by key.

pub fn iter(&self) -> impl Iterator<Item = (&P, &HyperParam)>

Iterate over parameter definitions.

pub fn sample(&self, rng: &mut impl Rng) -> Trial<P>

Sample a random configuration.

pub fn grid(&self, points_per_param: usize) -> Vec<Trial<P>>

Generate all grid configurations.

Trait Implementations

impl<P: Clone + ParamKey> Clone for SearchSpace<P>

fn clone(&self) -> SearchSpace<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + ParamKey> Debug for SearchSpace<P>

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

Formats the value using the given formatter.

impl<P: ParamKey> Default for SearchSpace<P>

fn default() -> Self

Returns the “default value” for a type.