rlmesh 0.1.0

Internal RLMesh crate (unstable Rust API): Rust bindings for model-environment evaluation; build on the rlmesh Python package.
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

use crate::spaces;

pub use spaces::{CloseRequest, RenderRequest, RenderResult};

/// Summary of one finished episode, reported on step completion and on close.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct EpisodeMetadata {
    /// Unique identifier for the episode.
    pub episode_id: String,
    /// Seed the episode was reset with, or `None` when the episode was reset
    /// without an explicit seed (the environment seeded itself from entropy).
    pub seed: Option<i64>,
    /// Index of the sub-environment that produced the episode.
    pub env_index: i32,
    /// Number of steps the episode ran.
    pub step_count: i64,
    /// Sum of rewards over the episode.
    pub cumulative_reward: f64,
    /// Whether the episode ended in a terminal state.
    pub terminated: bool,
    /// Whether the episode was truncated (e.g. by a time limit).
    pub truncated: bool,
    /// Episode start time, nanoseconds since the Unix epoch.
    pub start_timestamp_ns: i64,
    /// Episode end time, nanoseconds since the Unix epoch.
    pub end_timestamp_ns: i64,
    /// Wall-clock duration in milliseconds.
    pub duration_ms: i64,
    /// Final `info` map emitted by the environment, if any.
    pub final_info: Option<spaces::MetaMap>,
}

/// The result of closing an environment or env session.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct CloseResult {
    /// Metadata for episodes that were still in flight at close time.
    pub final_episodes: Vec<EpisodeMetadata>,
}

/// A vectorized reset request: one seed per sub-environment.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ResetRequest {
    /// One seed per sub-environment (empty leaves seeding to the env).
    pub seeds: Vec<i64>,
    /// Optional reset options forwarded to the environment.
    pub options: Option<spaces::MetaMap>,
    /// Per-call deadline in milliseconds; `0` means no deadline.
    pub timeout_ms: i64,
    /// Sub-environment indices to reset. Empty means reset the whole vector —
    /// the only mode most envs support. A non-empty list requests a partial
    /// (per-lane) reset of just those sub-envs and is only honored by an env
    /// that overrides [`VectorEnv::reset_subset`](crate::VectorEnv::reset_subset); any other
    /// env rejects it rather than silently resetting every lane. When present,
    /// `seeds` (if any) is positionally aligned to this list.
    pub env_indices: Vec<i32>,
}

/// A vectorized step request: one action per sub-environment.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StepRequest {
    /// One action per sub-environment, in env-index order.
    pub actions: Vec<spaces::SpaceValue>,
    /// Per-call deadline in milliseconds; `0` means no deadline.
    pub timeout_ms: i64,
}

/// The result of a vectorized [`ResetRequest`].
#[derive(Debug, Clone, PartialEq, Default)]
pub struct ResetResult {
    /// One initial observation per sub-environment.
    pub observations: Vec<spaces::SpaceValue>,
    /// Optional batched `info` map from the environment.
    pub info: Option<spaces::MetaMap>,
    /// The episode id assigned to each sub-environment.
    pub episode_ids: Vec<String>,
}

/// The result of a vectorized [`StepRequest`].
#[derive(Debug, Clone, PartialEq, Default)]
pub struct StepResult {
    /// One observation per sub-environment.
    pub observations: Vec<spaces::SpaceValue>,
    /// One reward per sub-environment.
    pub rewards: Vec<f64>,
    /// Per-sub-environment terminal flags.
    pub terminated: Vec<bool>,
    /// Per-sub-environment truncation flags.
    pub truncated: Vec<bool>,
    /// Optional batched `info` map from the environment.
    pub info: Option<spaces::MetaMap>,
    /// Metadata for episodes that finished on this step (auto-reset).
    pub completed_episodes: Vec<EpisodeMetadata>,
    /// The current episode id for each sub-environment.
    pub episode_ids: Vec<String>,
}