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>,
    pub seeds: Vec<i64>,
    pub composite: Option<CompositeObjective>,
    pub created_at: Option<DateTime<Utc>>,
    pub updated_at: Option<DateTime<Utc>>,
    pub tags: Vec<String>,
    pub git_sha: Option<String>,
    pub planned_trials: Option<usize>,
}

An optimization study: orchestrates multiple trials.

Fields

id: String

Unique identifier, generated by Study::new.

name: String

Human-readable name; needs no uniqueness.

search_space: SearchSpace

The dimensions trials are sampled from.

strategy: SearchStrategy

How configurations are chosen (grid, random, TPE, …).

pruning: PruningStrategy

Early-stopping policy for unpromising trials; None by default.

objectives: Vec<Objective>

Declared objectives. Only the first is scored today (see Study::objective_value), unless composite overrides it.

trials: Vec<Trial>

Every trial the study has run, in start order — terminal and in-flight alike.

frozen: HashMap<String, Value>

Study-level fixed parameters, injected into every trial’s params by the runner (same mechanism as SearchSpace::freeze, but settable after the space was built).

seeds: Vec<i64>

Experiment seeds: when non-empty, every sampled configuration is evaluated once per seed (trial params carry "seed"), giving each seed an independent cache line and resumable trial.

composite: Option<CompositeObjective>

Scalar objective composed from several metrics; takes precedence over objectives when set.

created_at: Option<DateTime<Utc>>

When the study was created. serde(default): absent in pre-timestamp JSON.

updated_at: Option<DateTime<Utc>>

When the study was last saved/modified.

tags: Vec<String>

Free-form labels for filtering studies in listings.

git_sha: Option<String>

Git commit the study ran at, for reproducibility bookkeeping.

planned_trials: Option<usize>

Total trials resolved by the sampler at run start (grid sizes are unknown until the search space is prepared).

Implementations

impl Study

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

A fresh study with a generated id and created_at stamped now: no trials, no pruning (PruningStrategy::None), no composite objective. Layer options on with the with_* builders.

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

Builder: replace the pruning strategy (the default from Study::new is PruningStrategy::None).

pub fn with_composite(self, composite: CompositeObjective) -> Self

Builder: set the composite objective. Once set it becomes the value the optimizer sees, overriding objectives for scoring and direction — see Study::objective_value.

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

Trials in TrialState::Completed — the population pruners compare against. Pruned and failed trials are excluded.

pub fn primary_direction(&self) -> Option<Direction>

Direction of the effective objective (composite if set, else the first declared objective).

pub fn objective_value(&self, trial: &Trial) -> Option<f64>

The single source of truth for scoring a trial: the composite objective if set, else the best value of the first objective’s metric. None for incomplete trials or missing metrics.

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

Get the best trial for the effective objective.

pub fn best_value(&self) -> Option<f64>

Objective value of the best trial.

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

Number of total planned trials (if known). Prefers the count the sampler resolved at run start (covers grid strategies).

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.