Skip to main content

Suggest

hyperopt_core

Trait Suggest 

Source 
pub trait Suggest {
    // Required methods
    fn suggest_float(&mut self, name: &str, low: f64, high: f64) -> f64;
    fn suggest_loguniform(&mut self, name: &str, low: f64, high: f64) -> f64;
    fn suggest_int(&mut self, name: &str, low: i64, high: i64) -> i64;
    fn suggest_categorical(&mut self, name: &str, choices: &[&str]) -> String;
    fn report(&mut self, step: usize, value: f64);
    fn should_prune(&mut self) -> bool;
}
Expand description

The portable objective interface: exactly the operations a user objective performs on a trial (suggest parameters, report intermediate values, ask whether to prune).

TrialContext implements it for local execution, and the distributed worker’s remote trial implements it too, so the same objective closure can run unchanged locally or against a coordinator — just write it against &mut impl Suggest instead of &mut TrialContext:

use hyperopt_core::Suggest;

fn objective(trial: &mut impl Suggest) -> f64 {
    let x = trial.suggest_float("x", -10.0, 10.0);
    let y = trial.suggest_int("y", 0, 5) as f64;
    (x - 2.0).powi(2) + y
}

Required Methods§

Source

fn suggest_float(&mut self, name: &str, low: f64, high: f64) -> f64

Suggest a continuous value uniformly over [low, high].

Source

fn suggest_loguniform(&mut self, name: &str, low: f64, high: f64) -> f64

Suggest a continuous value log-uniformly over [low, high].

Source

fn suggest_int(&mut self, name: &str, low: i64, high: i64) -> i64

Suggest an integer uniformly over the inclusive range [low, high].

Source

fn suggest_categorical(&mut self, name: &str, choices: &[&str]) -> String

Suggest one of choices, returning the chosen label.

Source

fn report(&mut self, step: usize, value: f64)

Report an intermediate objective value at step, for pruners.

Source

fn should_prune(&mut self) -> bool

Ask whether this trial should stop early given what it has reported.

Takes &mut self (unlike TrialContext::should_prune, which only reads) so a remote implementation can perform the round-trip to its coordinator through the same connection; local implementations simply ignore the mutability.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§