Struct Study 

pub struct Study {
    pub id: String,
    pub name: String,
    pub search_space: SearchSpace,
    pub strategy: SearchStrategy,
    pub pruning: PruningStrategy,
    pub objectives: Vec<Objective>,
    pub trials: Vec<Trial>,
    pub frozen: HashMap<String, Value>,
}

An optimization study: orchestrates multiple trials.

Fields

id: String

name: String

search_space: SearchSpace

strategy: SearchStrategy

pruning: PruningStrategy

objectives: Vec<Objective>

trials: Vec<Trial>

frozen: HashMap<String, Value>

Implementations

impl Study

pub fn new( name: impl Into<String>, search_space: SearchSpace, strategy: SearchStrategy, objectives: Vec<Objective>, ) -> Self

pub fn with_pruning(self, pruning: PruningStrategy) -> Self

pub fn completed_trials(&self) -> Vec<&Trial>

Get completed trials.

pub fn best_trial(&self) -> Option<&Trial>

Get the best trial for the primary objective.

pub fn total_trials(&self) -> Option<usize>

Number of total planned trials (if known).

pub fn progress(&self) -> f64

Fraction of trials completed.

Trait Implementations

impl Clone for Study

fn clone(&self) -> Study

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Study

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Study

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Study

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.