optimizer 1.0.1

Bayesian and population-based optimization library with an Optuna-like API for hyperparameter tuning and black-box optimization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

use optimizer::parameter::{FloatParam, IntParam, Parameter};
use optimizer::sampler::random::RandomSampler;
use optimizer::{Direction, Study, generate_html_report};

#[test]
fn html_report_creates_file() {
    let study: Study<f64> = Study::with_sampler(Direction::Minimize, RandomSampler::with_seed(42));
    let x = FloatParam::new(0.0, 10.0).name("x");
    let y = IntParam::new(1, 5).name("y");

    study
        .optimize(10, |trial: &mut optimizer::Trial| {
            let xv = x.suggest(trial)?;
            let yv = y.suggest(trial)?;
            Ok::<_, optimizer::Error>(xv + yv as f64)
        })
        .unwrap();

    let path = std::env::temp_dir().join("test_report_creates_file.html");
    generate_html_report(&study, &path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();
    assert!(content.contains("<!DOCTYPE html>"));
    assert!(content.contains("plotly"));
    std::fs::remove_file(&path).ok();
}

#[test]
fn html_report_contains_all_chart_sections() {
    let study: Study<f64> = Study::with_sampler(Direction::Minimize, RandomSampler::with_seed(42));
    let x = FloatParam::new(0.0, 10.0).name("x");
    let y = FloatParam::new(-5.0, 5.0).name("y");

    study
        .optimize(20, |trial: &mut optimizer::Trial| {
            let xv = x.suggest(trial)?;
            let yv = y.suggest(trial)?;
            Ok::<_, optimizer::Error>(xv * xv + yv * yv)
        })
        .unwrap();

    let path = std::env::temp_dir().join("test_report_all_charts.html");
    generate_html_report(&study, &path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();

    // Should contain all chart divs.
    assert!(content.contains("id=\"history\""));
    assert!(content.contains("id=\"slices\""));
    assert!(content.contains("id=\"parcoords\""));
    assert!(content.contains("id=\"importance\""));
    assert!(content.contains("id=\"timeline\""));

    // Should contain chart titles.
    assert!(content.contains("Optimization History"));
    assert!(content.contains("Slice Plots"));
    assert!(content.contains("Parallel Coordinates"));
    assert!(content.contains("Parameter Importance"));
    assert!(content.contains("Trial Timeline"));

    // Should show direction and trial count.
    assert!(content.contains("Minimize"));
    assert!(content.contains("20 trials"));

    std::fs::remove_file(&path).ok();
}

#[test]
fn html_report_empty_study() {
    let study: Study<f64> = Study::new(Direction::Minimize);

    let path = std::env::temp_dir().join("test_report_empty.html");
    generate_html_report(&study, &path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();
    assert!(content.contains("<!DOCTYPE html>"));
    assert!(content.contains("0 trials"));

    std::fs::remove_file(&path).ok();
}

#[test]
fn html_report_single_param_no_parcoords() {
    let study: Study<f64> = Study::with_sampler(Direction::Minimize, RandomSampler::with_seed(42));
    let x = FloatParam::new(0.0, 10.0).name("x");

    study
        .optimize(5, |trial: &mut optimizer::Trial| {
            let xv = x.suggest(trial)?;
            Ok::<_, optimizer::Error>(xv * xv)
        })
        .unwrap();

    let path = std::env::temp_dir().join("test_report_single_param.html");
    generate_html_report(&study, &path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();

    // Should have slice plot but not parallel coordinates (needs >= 2 params).
    assert!(content.contains("id=\"slices\""));
    assert!(!content.contains("id=\"parcoords\""));

    std::fs::remove_file(&path).ok();
}

#[test]
fn html_report_maximize_direction() {
    let study: Study<f64> = Study::with_sampler(Direction::Maximize, RandomSampler::with_seed(42));
    let x = FloatParam::new(0.0, 10.0).name("x");

    study
        .optimize(5, |trial: &mut optimizer::Trial| {
            let xv = x.suggest(trial)?;
            Ok::<_, optimizer::Error>(xv)
        })
        .unwrap();

    let path = std::env::temp_dir().join("test_report_maximize.html");
    generate_html_report(&study, &path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();
    assert!(content.contains("Maximize"));

    std::fs::remove_file(&path).ok();
}

#[test]
fn export_html_convenience_method() {
    let study: Study<f64> = Study::with_sampler(Direction::Minimize, RandomSampler::with_seed(42));
    let x = FloatParam::new(0.0, 10.0).name("x");

    study
        .optimize(5, |trial: &mut optimizer::Trial| {
            let xv = x.suggest(trial)?;
            Ok::<_, optimizer::Error>(xv * xv)
        })
        .unwrap();

    let path = std::env::temp_dir().join("test_export_html.html");
    study.export_html(&path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();
    assert!(content.contains("<!DOCTYPE html>"));
    assert!(content.contains("id=\"history\""));

    std::fs::remove_file(&path).ok();
}

#[test]
fn html_report_with_intermediate_values() {
    use optimizer::pruner::MedianPruner;

    let mut study: Study<f64> =
        Study::with_sampler(Direction::Minimize, RandomSampler::with_seed(42));
    study.set_pruner(MedianPruner::new(Direction::Minimize));
    let x = FloatParam::new(0.0, 10.0).name("x");

    study
        .optimize(10, |trial: &mut optimizer::Trial| {
            let xv = x.suggest(trial)?;
            for step in 0..5 {
                let val = xv * xv + step as f64;
                trial.report(step, val);
                if trial.should_prune() {
                    return Err(optimizer::TrialPruned.into());
                }
            }
            Ok::<_, optimizer::Error>(xv * xv)
        })
        .unwrap();

    let path = std::env::temp_dir().join("test_report_intermediate.html");
    generate_html_report(&study, &path).unwrap();

    let content = std::fs::read_to_string(&path).unwrap();
    assert!(content.contains("id=\"intermediate\""));
    assert!(content.contains("Intermediate Values"));

    std::fs::remove_file(&path).ok();
}