Skip to content

Commit b23b686

Browse files
authored
Harden runtime episode traces (#183)
1 parent a184b7a commit b23b686

4 files changed

Lines changed: 325 additions & 13 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,27 @@ await episode.close()
295295
Products such as eval harnesses can project this generic episode trace into their
296296
own action, observation, reward, and report schemas outside WP Codebox.
297297

298+
The episode trace is a versioned machine-verifiable contract with schema
299+
`wp-codebox/runtime-episode-trace/v1`. `@chubes4/wp-codebox-core` exports
300+
`RUNTIME_EPISODE_TRACE_JSON_SCHEMA` for schema-aware consumers and
301+
`validateRuntimeEpisodeTrace()` for lightweight runtime checks. The trace stays
302+
generic: it carries runtime, reset, step, action, execution, observation,
303+
snapshot, and artifact references only. Domain fields such as reward, grader,
304+
scenario, benchmark, task-set, and model-eval belong in consumers that project
305+
the trace into their own schemas.
306+
307+
Episode steps include stable ids and refs for the step, requested action,
308+
runtime execution, optional observation, and collected artifact bundle. Action
309+
and execution refs include SHA-256 digests over the canonical trace v1 JSON
310+
payload so callers can compare command/result records without depending on
311+
presentation logs.
312+
313+
Runtime snapshots are explicit about their semantics. The current Playground
314+
backend returns `semantics: "metadata-only"`, which records runtime and mount
315+
metadata for audit context but is not a full replayable WordPress state image.
316+
Call `collectArtifacts()` when the caller needs replay inputs, changed files,
317+
patches, logs, observations, and artifact bundle refs.
318+
298319
## CLI Commands
299320

300321
### `commands`

0 commit comments

Comments
 (0)