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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
//! `kurobako report` command.
use self::rankings::{Borda, Firsts};
use crate::markdown as md;
use crate::markdown::MarkdownWriter;
use crate::record::{ProblemRecord, SolverRecord, StudyRecord};
use kurobako_core::num::OrderedFloat;
use kurobako_core::{Error, ErrorKind, Result};
use rustats::fundamental::{average, stddev};
use rustats::hypothesis_testings::MannWhitneyU;
use serde::Serialize;
use std::cmp::Ordering;
use std::collections::BTreeMap;
use std::io::Write;
use std::str::FromStr;
use std::time::Duration;
use structopt::StructOpt;

mod rankings;

/// Options of the `kurobako report` command.
#[derive(Debug, StructOpt, Serialize)]
#[structopt(rename_all = "kebab-case")]
pub struct ReportOpt {
    /// Metric precedences used to compare the results of solvers.
    #[structopt(
        long,
        possible_values = Metric::POSSIBLE_VALUES
    )]
    pub metrics: Vec<Metric>,
}

/// Evaluation metric.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize)]
pub enum Metric {
    /// Best value.
    BestValue,

    /// Auc of the best value.
    Auc,

    /// Wall-clock time consumed by solver.
    ElapsedTime,
}
impl Metric {
    const POSSIBLE_VALUES: &'static [&'static str] = &["best-value", "auc", "elapsed-time"];
}
impl FromStr for Metric {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        match s {
            "best-value" => Ok(Metric::BestValue),
            "auc" => Ok(Metric::Auc),
            "elapsed-time" => Ok(Metric::ElapsedTime),
            _ => track_panic!(ErrorKind::InvalidInput, "Unknown metric name: {:?}", s),
        }
    }
}

/// Reporter that builds and prints a benchmark report.
#[derive(Debug)]
pub struct Reporter {
    studies: Vec<StudyRecord>,
    opt: ReportOpt,
}
impl Reporter {
    /// Makes a `Reporter` instance.
    pub fn new(studies: Vec<StudyRecord>, mut opt: ReportOpt) -> Self {
        if opt.metrics.is_empty() {
            opt.metrics = vec![Metric::BestValue, Metric::Auc];
        }
        Self { studies, opt }
    }

    /// Prints a full report.
    pub fn report_all(&self, mut writer: impl Write) -> Result<()> {
        let mut writer = MarkdownWriter::new(&mut writer);
        let mut writer = track!(writer.heading("Benchmark Result Report"))?;

        let mut list = writer.list();
        track!(list.item(&format!(
            "Kurobako Version: [{}](https://github.com/sile/kurobako/tree/{})",
            env!("CARGO_PKG_VERSION"),
            env!("CARGO_PKG_VERSION"),
        )))?;
        track!(list.item(&format!(
            "Number of Solvers: {}",
            track!(self.solvers())?.count()
        )))?;
        track!(list.item(&format!(
            "Number of Problems: {}",
            track!(self.problems())?.count()
        )))?;
        let metrics = self
            .opt
            .metrics
            .iter()
            .map(|m| match m {
                Metric::BestValue => "best value",
                Metric::Auc => "AUC",
                Metric::ElapsedTime => "elapsed time",
            })
            .collect::<Vec<_>>();
        track!(list.item(&format!("Metrics Precedence: `{}`", metrics.join(" -> "))))?;
        track_writeln!(writer.inner_mut())?;

        track_writeln!(
            writer.inner_mut(),
            "Please refer to \
             [\"A Strategy for Ranking Optimizers using Multiple Criteria\"]\
             [Dewancker, Ian, et al., 2016] for the ranking strategy used in this report.\n\n\
             [Dewancker, Ian, et al., 2016]: \
             http://proceedings.mlr.press/v64/dewancker_strategy_2016.pdf"
        )?;

        {
            let mut writer = track!(writer.heading("Table of Contents"))?;
            let mut list = writer.list().numbered();
            track!(list.item("[Overall Results](#overall-results)"))?;
            track!(list.item("[Individual Results](#individual-results)"))?;
            track!(list.item("[Solvers](#solvers)"))?;
            track!(list.item("[Problems](#problems)"))?;
            track!(list.item("[Studies](#studies)"))?;
            track_writeln!(writer.inner_mut())?;
        }

        track!(self.report_overall_results(&mut writer))?;
        track!(self.report_individual_results(&mut writer))?;
        track!(self.report_solvers(&mut writer))?;
        track!(self.report_problems(&mut writer))?;
        track!(self.report_studies(&mut writer))?;

        Ok(())
    }

    fn report_overall_results<W: Write>(&self, writer: &mut MarkdownWriter<W>) -> Result<()> {
        let mut writer = track!(writer.heading("Overall Results"))?;
        track_writeln!(writer.inner_mut())?;

        let contests = track!(self.contests())?;
        let (solver_ids, solvers): (Vec<_>, Vec<_>) = track!(self.solvers())?.unzip();
        let mut borda_ranking = Borda::new(solver_ids.iter());
        let mut firsts_ranking = Firsts::new(solver_ids.iter());
        let mut excluded_problems = Vec::new();
        let alpha = self.alpha(solvers.len());
        for (problem_id, contest) in contests {
            if !solver_ids
                .iter()
                .all(|s| contest.competitors.contains_key(s))
            {
                excluded_problems.push((problem_id, contest.problem));
                continue;
            }

            borda_ranking.compete(|&a, &b| {
                let a = &contest.competitors[a];
                let b = &contest.competitors[b];
                self.compete(a, b, contest.auc_start_step, alpha)
            });
            firsts_ranking.compete(|&a, &b| {
                let a = &contest.competitors[a];
                let b = &contest.competitors[b];
                self.compete(a, b, contest.auc_start_step, alpha)
            });
        }

        let mut table = md::Table::new(
            vec![
                md::ColumnHeader::new("Solver", md::Align::Left),
                md::ColumnHeader::new("Borda", md::Align::Right),
                md::ColumnHeader::new("Firsts", md::Align::Right),
            ]
            .into_iter(),
        );

        for (((solver_id, solver), borda), firsts) in solver_ids
            .iter()
            .zip(solvers.iter())
            .zip(borda_ranking.scores())
            .zip(firsts_ranking.scores())
        {
            table
                .row()
                .item(format!("[{}](#id-{})", solver.spec.name, solver_id))
                .item(borda)
                .item(firsts);
        }
        track!(writer.write_table(&table))?;
        track!(writer.newline())?;

        if !excluded_problems.is_empty() {
            let mut writer = track!(writer.heading("Note"))?;
            track!(writer.newline())?;
            track_writeln!(
                writer.inner_mut(),
                "The following problems aren't considered in the above \
                 result because some of the solvers don't participate in the problems:"
            )?;

            let mut list = writer.list();
            for (problem_id, problem) in excluded_problems {
                track!(list.item(&format!("[{}](#id-{})", problem.spec.name, problem_id)))?;
            }
            track!(writer.newline())?;
        }

        Ok(())
    }

    fn report_individual_results<W: Write>(&self, writer: &mut MarkdownWriter<W>) -> Result<()> {
        let mut writer = track!(writer.heading("Individual Results"))?;
        track_writeln!(writer.inner_mut())?;

        let contests = track!(self.contests())?;
        for (problem_no, (problem_id, contest)) in contests.into_iter().enumerate() {
            let mut writer = track!(writer.heading(&format!(
                "({}) Problem: [{}](#id-{})",
                problem_no + 1,
                contest.problem.spec.name,
                problem_id
            )))?;

            // FIXME: Reduce redundant calculation.
            let auc_start_step = contest.auc_start_step;
            let mut rankings = BTreeMap::new();
            let alpha = self.alpha(contest.competitors.len());
            for (solver_id0, competitor0) in &contest.competitors {
                let mut ranking = 1;
                for (solver_id1, competitor1) in &contest.competitors {
                    if solver_id0 == solver_id1 {
                        continue;
                    }

                    if self.compete(competitor0, competitor1, auc_start_step, alpha)
                        == Ordering::Greater
                    {
                        ranking += 1;
                    }
                }
                rankings.insert(solver_id0, ranking);
            }
            let mut rankings = rankings.into_iter().map(|x| (x.1, x.0)).collect::<Vec<_>>();
            rankings.sort();

            let mut table = md::Table::new(
                vec![
                    md::ColumnHeader::new("Ranking", md::Align::Right),
                    md::ColumnHeader::new("Solver", md::Align::Left),
                    md::ColumnHeader::new("Best (avg +- sd)", md::Align::Right),
                    md::ColumnHeader::new("AUC (avg +- sd)", md::Align::Right),
                    md::ColumnHeader::new("Elapsed (avg +- sd)", md::Align::Right),
                ]
                .into_iter(),
            );
            for (ranking, solver_id) in rankings {
                let c = &contest.competitors[solver_id];

                let solver = format!(
                    "[{}](#id-{}) ([study](#id-{}))",
                    c.solver.spec.name,
                    solver_id,
                    track!(c.studies[0].id())?
                );

                let best_values = c.best_values().map(|x| x.0).collect::<Vec<_>>();
                let best_value = format!(
                    "{:.06} +- {:.06}",
                    average(best_values.iter().copied()),
                    stddev(best_values.iter().copied())
                );

                let aucs = c.aucs(auc_start_step).map(|x| x.0).collect::<Vec<_>>();
                let auc = format!(
                    "{:.03} +- {:.03}",
                    average(aucs.iter().copied()),
                    stddev(aucs.iter().copied())
                );

                let elapsed_times = c
                    .elapsed_times()
                    .map(|x| x.as_secs_f64())
                    .collect::<Vec<_>>();
                let elapsed_time = format!(
                    "{:.03} +- {:.03}",
                    average(elapsed_times.iter().copied()),
                    stddev(elapsed_times.iter().copied())
                );
                table
                    .row()
                    .item(ranking)
                    .item(solver)
                    .item(best_value)
                    .item(auc)
                    .item(elapsed_time);
            }

            track!(writer.write_table(&table))?;
            track_writeln!(writer.inner_mut())?;
        }

        Ok(())
    }

    fn report_solvers<W: Write>(&self, writer: &mut MarkdownWriter<W>) -> Result<()> {
        let mut writer = track!(writer.heading("Solvers"))?;
        for (id, solver) in track!(self.solvers())? {
            let mut writer = track!(writer.heading(&format!("ID: {}", id)))?;

            track_writeln!(writer.inner_mut(), "recipe:")?;
            let json = track!(serde_json::to_string_pretty(&solver.recipe).map_err(Error::from))?;
            track!(writer.code_block("json", &json))?;
            track_writeln!(writer.inner_mut())?;

            track_writeln!(writer.inner_mut(), "specification:")?;
            let json = track!(serde_json::to_string_pretty(&solver.spec).map_err(Error::from))?;
            track!(writer.code_block("json", &json))?;
            track_writeln!(writer.inner_mut())?;
        }
        Ok(())
    }

    fn report_problems<W: Write>(&self, writer: &mut MarkdownWriter<W>) -> Result<()> {
        let mut writer = track!(writer.heading("Problems"))?;
        for (id, problem) in track!(self.problems())? {
            let mut writer = track!(writer.heading(&format!("ID: {}", id)))?;

            track_writeln!(writer.inner_mut(), "recipe:")?;
            let json = track!(serde_json::to_string_pretty(&problem.recipe).map_err(Error::from))?;
            track!(writer.code_block("json", &json))?;
            track_writeln!(writer.inner_mut())?;

            track_writeln!(writer.inner_mut(), "specification:")?;
            let json = track!(serde_json::to_string_pretty(&problem.spec).map_err(Error::from))?;
            track!(writer.code_block("json", &json))?;
            track_writeln!(writer.inner_mut())?;
        }
        Ok(())
    }

    fn report_studies<W: Write>(&self, writer: &mut MarkdownWriter<W>) -> Result<()> {
        let mut writer = track!(writer.heading("Studies"))?;
        let mut studies = BTreeMap::<_, Vec<_>>::new();
        for study in &self.studies {
            let id = track!(study.id())?;
            studies
                .entry((&study.problem.spec.name, &study.solver.spec.name, id))
                .or_default()
                .push(study);
        }
        for ((problem_name, solver_name, id), studies) in studies {
            let mut writer = track!(writer.heading(&format!("ID: {}", id)))?;
            let mut list = writer.list();
            track!(list.item(&format!(
                "problem: [{}](#id-{})",
                problem_name,
                track!(studies[0].problem.id())?
            )))?;
            track!(list.item(&format!(
                "solver: [{}](#id-{})",
                solver_name,
                track!(studies[0].solver.id())?
            )))?;
            track!(list.item(&format!("budget: {}", studies[0].budget)))?;
            track!(list.item(&format!("repeats: {}", studies.len())))?;
            track!(list.item(&format!("concurrency: {}", studies[0].concurrency)))?;
            if studies[0].concurrency.get() > 1 {
                track!(list.item(&format!("scheduling: {}", studies[0].scheduling)))?;
            }
            track_writeln!(writer.inner_mut())?;
        }
        Ok(())
    }

    fn solvers(&self) -> Result<impl '_ + Iterator<Item = (String, &SolverRecord)>> {
        let mut map = BTreeMap::new();
        for study in &self.studies {
            let id = track!(study.solver.id())?;
            map.insert((&study.solver.spec.name, id), &study.solver);
        }
        Ok(map.into_iter().map(|(k, v)| (k.1, v)))
    }

    fn problems(&self) -> Result<impl '_ + Iterator<Item = (String, &ProblemRecord)>> {
        let mut map = BTreeMap::new();
        for study in &self.studies {
            let id = track!(study.problem.id())?;
            map.insert((&study.problem.spec.name, id), &study.problem);
        }
        Ok(map.into_iter().map(|(k, v)| (k.1, v)))
    }

    fn compete(&self, a: &Competitor, b: &Competitor, auc_start_step: u64, alpha: f64) -> Ordering {
        for metric in &self.opt.metrics {
            let order = match metric {
                Metric::BestValue => {
                    MannWhitneyU::new(a.best_values(), b.best_values()).order(alpha)
                }
                Metric::Auc => {
                    MannWhitneyU::new(a.aucs(auc_start_step), b.aucs(auc_start_step)).order(alpha)
                }
                Metric::ElapsedTime => {
                    MannWhitneyU::new(a.elapsed_times(), b.elapsed_times()).order(alpha)
                }
            };
            if order != Ordering::Equal {
                return order;
            }
        }
        Ordering::Equal
    }

    fn alpha(&self, solvers: usize) -> f64 {
        let n = num_integer::binomial(solvers, 2);
        let candidates = [
            0.05f64, 0.025, 0.01, 0.007_5, 0.005, 0.002_5, 0.001, 0.000_75, 0.000_5, 0.000_25,
            0.000_1, 0.000_075, 0.000_05, 0.000_025, 0.000_01,
        ];
        for &a in &candidates {
            if 1.0 - (1.0 - a).powi(n as i32) < 0.05 {
                return a;
            }
        }
        0.000_01
    }

    fn contests(&self) -> Result<BTreeMap<String, Contest>> {
        let mut contests = BTreeMap::new();
        for study in &self.studies {
            let problem_id = track!(study.problem.id())?;
            let contest = contests.entry(problem_id).or_insert_with(|| Contest {
                problem: &study.problem,
                competitors: BTreeMap::new(),
                auc_start_step: study.problem.spec.steps.last(),
            });
            if let Some(trial) = study.first_complete_trial() {
                if let Some(step) = trial.start_step() {
                    if contest.auc_start_step < step {
                        contest.auc_start_step = step;
                    }
                }
            }

            let solver_id = track!(study.solver.id())?;
            contest
                .competitors
                .entry(solver_id)
                .or_insert_with(|| Competitor {
                    solver: &study.solver,
                    studies: Vec::new(),
                })
                .studies
                .push(study)
        }
        Ok(contests)
    }
}

struct Contest<'a> {
    problem: &'a ProblemRecord,
    competitors: BTreeMap<String, Competitor<'a>>,
    auc_start_step: u64,
}

struct Competitor<'a> {
    solver: &'a SolverRecord,
    studies: Vec<&'a StudyRecord>,
}
impl<'a> Competitor<'a> {
    fn best_values(&self) -> impl '_ + Iterator<Item = OrderedFloat<f64>> {
        self.studies
            .iter()
            .filter_map(|s| s.best_value())
            .map(OrderedFloat)
    }

    fn aucs(&self, start_step: u64) -> impl '_ + Iterator<Item = OrderedFloat<f64>> {
        self.studies
            .iter()
            .filter_map(move |s| s.auc(start_step))
            .map(OrderedFloat)
    }

    fn elapsed_times(&self) -> impl '_ + Iterator<Item = Duration> {
        self.studies.iter().map(|s| s.solver_elapsed())
    }
}