trane 0.29.0

An automated system for learning complex skills
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

//! CLI to run trane scheduler benchmarks with simulated student profiles.

use std::path::PathBuf;

use anyhow::Result;
use clap::Parser;
use trane::benchmark::{Benchmark, StudentResult};
use ustr::Ustr;

#[derive(Parser)]
#[command(about = "Run trane scheduler benchmarks with simulated student profiles")]
struct Args {
    #[arg(long, help = "Path to the trane library directory")]
    library_dir: PathBuf,

    #[arg(
        long,
        help = "ID of an advanced course used to decide when to check for full mastery"
    )]
    advanced_course: String,
}

/// Prints the result of a benchmark run for a given student profile.
fn print_result(label: &str, result: &StudentResult, max_days: u32) {
    match result.days_to_mastery {
        Some(days) => println!(
            "  {label}: mastery in {days} days, {sessions} sessions, {exercises} exercises",
            sessions = result.sessions_run,
            exercises = result.exercises_practiced,
        ),
        None => println!(
            "  {label}: no mastery in {max_days} days, {sessions} sessions, {exercises} exercises",
            sessions = result.sessions_run,
            exercises = result.exercises_practiced,
        ),
    }
}

fn main() -> Result<()> {
    let args = Args::parse();

    let benchmark = Benchmark {
        library_dir: args.library_dir,
        advanced_course: Ustr::from(&args.advanced_course),
        ..Benchmark::default()
    };
    benchmark.verify()?;

    println!("Running trane benchmarks...");
    let result = benchmark.run_benchmark()?;

    let max = benchmark.max_sessions;
    println!("Results:");
    print_result(
        "Remedial",
        &result.remedial_result,
        max * benchmark.remedial_profile.session_frequency,
    );
    print_result(
        "Below median",
        &result.below_median_result,
        max * benchmark.below_median_profile.session_frequency,
    );
    print_result(
        "Median",
        &result.median_result,
        max * benchmark.median_profile.session_frequency,
    );
    print_result(
        "Above median",
        &result.above_median_result,
        max * benchmark.above_median_profile.session_frequency,
    );
    print_result(
        "Excellent",
        &result.excellent_result,
        max * benchmark.excellent_profile.session_frequency,
    );

    Ok(())
}