rlmesh-runtime 0.1.0-rc.1

Internal RLMesh crate (unstable Rust API): runtime driver for evaluation sessions.
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
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

use std::sync::Arc;

use rlmesh_proto::common::v1::MessageBytes;
use rlmesh_proto::spaces::v1::MetaMap;
use rlmesh_proto::spaces::v1::SpaceSpec;

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct RuntimeRouteContext {
    pub route_id: String,
    pub env_component_id: String,
    pub model_component_id: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EnvConnectedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub env_id: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ModelConnectedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SessionStartedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub env_id: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SessionEndedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub reason: String,
    pub total_steps: i64,
    pub total_episodes: i64,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SessionFailedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub reason: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LogEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub level: LogLevel,
    pub message: String,
    pub source: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LogLevel {
    Debug,
    Info,
    Warn,
    Error,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct EpisodeStartedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub episode_id: String,
    pub episode_record_id: String,
    pub episode_index: i64,
    pub env_index: i32,
    pub started_from_auto_reset: bool,
}

#[derive(Debug, Clone, PartialEq)]
pub struct EpisodeCompletedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub episode_id: String,
    pub episode_record_id: String,
    pub episode_index: i64,
    pub env_index: i32,
    pub step_count: i64,
    pub cumulative_reward: f64,
    pub terminated: bool,
    pub truncated: bool,
    pub duration_ms: i64,
    pub final_info: Option<MetaMap>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct ActionReceivedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub episode_id: String,
    pub episode_record_id: String,
    pub episode_ids: Vec<String>,
    pub episode_record_ids: Vec<String>,
    pub step: i64,
    pub env_index: i32,
    /// Shared so the per-step, per-hook event fan-out clones an `Arc` pointer
    /// rather than deep-copying the action space spec on every step.
    pub action_space: Arc<SpaceSpec>,
    pub action: Option<MessageBytes>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct StepCompletedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub episode_id: String,
    pub episode_record_id: String,
    pub step: i64,
    pub env_index: i32,
    pub rewards: Vec<f64>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct ObservationEmittedEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub episode_id: String,
    pub episode_record_id: String,
    pub episode_ids: Vec<String>,
    pub episode_record_ids: Vec<String>,
    pub step: i64,
    pub env_index: i32,
    pub is_reset: bool,
    pub num_envs: u32,
    /// Shared so the per-step, per-hook event fan-out clones an `Arc` pointer
    /// rather than deep-copying the observation space spec on every step.
    pub observation_space: Arc<SpaceSpec>,
    pub observation: Option<MessageBytes>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct TimingSummary {
    pub operation: String,
    pub component_id: String,
    pub name: String,
    pub sample_count: u64,
    pub avg_ms: Option<f64>,
    pub p50_ms: Option<f64>,
    pub p95_ms: Option<f64>,
    pub p99_ms: Option<f64>,
}

/// Kind of a non-duration metric reported via [`MetricSummary`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MetricKind {
    /// `OperationMetric::ByteCount`: a byte gauge/counter sample.
    ByteCount,
    /// `OperationMetric::Number`: a generic numeric gauge sample.
    Number,
}

/// Aggregated non-duration operation metric (byte counts and generic numbers
/// carried by `OperationTelemetry`). Duration metrics are reported via
/// [`TimingSummary`].
#[derive(Debug, Clone, PartialEq)]
pub struct MetricSummary {
    pub operation: String,
    pub component_id: String,
    pub name: String,
    pub kind: MetricKind,
    pub sample_count: u64,
    pub avg: Option<f64>,
    pub p50: Option<f64>,
    pub p95: Option<f64>,
    pub p99: Option<f64>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct TelemetryWindowEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub window_seconds: u32,
    pub sample_count: u64,
    pub steps_per_second: Option<f64>,
    pub request_bytes_per_second: Option<f64>,
    pub response_bytes_per_second: Option<f64>,
    pub timings: Vec<TimingSummary>,
    pub metrics: Vec<MetricSummary>,
    pub env_latency_ms_avg: Option<f64>,
    pub env_latency_ms_p50: Option<f64>,
    pub env_latency_ms_p95: Option<f64>,
    pub env_latency_ms_p99: Option<f64>,
    pub model_latency_ms_avg: Option<f64>,
    pub model_latency_ms_p50: Option<f64>,
    pub model_latency_ms_p95: Option<f64>,
    pub model_latency_ms_p99: Option<f64>,
    pub round_trip_ms_avg: Option<f64>,
    pub round_trip_ms_p50: Option<f64>,
    pub round_trip_ms_p95: Option<f64>,
    pub round_trip_ms_p99: Option<f64>,
    pub reconnects: u64,
    pub drops: u64,
}

#[derive(Debug, Clone, PartialEq)]
pub struct TelemetrySummaryEvent {
    pub session_id: String,
    pub route: RuntimeRouteContext,
    pub total_seconds: u32,
    pub sample_count: u64,
    pub steps_per_second: Option<f64>,
    pub request_bytes_per_second: Option<f64>,
    pub response_bytes_per_second: Option<f64>,
    pub timings: Vec<TimingSummary>,
    pub metrics: Vec<MetricSummary>,
    pub env_latency_ms_avg: Option<f64>,
    pub env_latency_ms_p50: Option<f64>,
    pub env_latency_ms_p95: Option<f64>,
    pub env_latency_ms_p99: Option<f64>,
    pub model_latency_ms_avg: Option<f64>,
    pub model_latency_ms_p50: Option<f64>,
    pub model_latency_ms_p95: Option<f64>,
    pub model_latency_ms_p99: Option<f64>,
    pub round_trip_ms_avg: Option<f64>,
    pub round_trip_ms_p50: Option<f64>,
    pub round_trip_ms_p95: Option<f64>,
    pub round_trip_ms_p99: Option<f64>,
    pub reconnects: u64,
    pub drops: u64,
}