wickra-gym 0.2.0

Reference command-line rollout runner over wickra-gym-core: load a spec + candle dataset, drive a fixed deterministic policy through the environment, and print the trajectory as an aligned table or golden-format JSON.
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

//! Command-line arguments for the reference rollout runner.

use std::path::PathBuf;

use clap::{Parser, ValueEnum};

/// Drive a fixed deterministic policy through a wickra-gym-core environment.
#[derive(Parser, Debug)]
#[command(name = "wickra-gym", version, about)]
pub struct Args {
    /// Path to the environment spec (`.json` or `.toml`, chosen by extension).
    #[arg(long)]
    pub spec: PathBuf,
    /// Path to the candle dataset CSV.
    #[arg(long)]
    pub data: PathBuf,
    /// The deterministic policy to run.
    #[arg(long, value_enum, default_value_t = Policy::Always0)]
    pub policy: Policy,
    /// Override the spec's `episode.max_steps`.
    #[arg(long)]
    pub steps: Option<u32>,
    /// Episode seed (overrides the spec's default seed).
    #[arg(long)]
    pub seed: Option<u64>,
    /// Output format.
    #[arg(long, value_enum, default_value_t = Format::Text)]
    pub format: Format,
}

/// A fixed, deterministic action policy.
#[derive(Copy, Clone, Debug, ValueEnum)]
pub enum Policy {
    /// Always take action `0`.
    #[value(name = "always-0")]
    Always0,
    /// Always take action `1`.
    #[value(name = "always-1")]
    Always1,
    /// Always take action `2`.
    #[value(name = "always-2")]
    Always2,
    /// Cycle `0, 1, 2, 0, …` by step index.
    Cycle,
}

impl Policy {
    /// The action this policy takes at the given step index.
    #[must_use]
    pub fn action(self, step: u32) -> f64 {
        match self {
            Policy::Always0 => 0.0,
            Policy::Always1 => 1.0,
            Policy::Always2 => 2.0,
            Policy::Cycle => f64::from(step % 3),
        }
    }
}

/// The output rendering.
#[derive(Copy, Clone, Debug, ValueEnum)]
pub enum Format {
    /// A human-readable aligned table.
    Text,
    /// Golden-format JSON (`{reset, trajectory}`).
    Json,
}