Skip to content

Commit cdc0d18

Browse files
committed
Document SCML and CybORG smoke checks
1 parent 7fcc206 commit cdc0d18

2 files changed

Lines changed: 75 additions & 0 deletions

File tree

docs/reference/arenas/cyborg.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,42 @@ The runtime pins CybORG to the upstream `v3.0` code and installs it editable fro
7171
repository because the upstream package expects data files such as `CybORG/version.txt` to be present
7272
next to the source tree.
7373

74+
## Smoke Test
75+
76+
From the repository root, run the dummy-player example:
77+
78+
```bash
79+
rm -rf /tmp/codeclash-cyborg-smoke
80+
uv run python main.py configs/examples/CybORG__dummy__r1__s2.yaml -o /tmp/codeclash-cyborg-smoke
81+
```
82+
83+
Expected shape:
84+
85+
- the command exits with status 0;
86+
- both players pass submission validation;
87+
- stdout includes `In round 0, the winner is ...` and `In round 1, the winner is ...`;
88+
- each round summary contains floating-point average rewards for `alpha` and `beta`;
89+
- per-episode details have `status: "ok"` and `steps_completed: 5`;
90+
- the output directory contains `metadata.json`, `game.log`, `tournament.log`, and
91+
`rounds/round_0.tar.gz` / `rounds/round_1.tar.gz`.
92+
93+
A representative `metadata.json` round contains a `scores` object with one floating-point episode
94+
reward per player:
95+
96+
```json
97+
"scores": {
98+
"alpha": -27.0,
99+
"beta": -33.5
100+
}
101+
```
102+
103+
Exact values can change with simulator randomness and configuration; the smoke check is meant to
104+
verify the Docker/runtime adapter path, player-name mapping, and score/log artifact shape.
105+
106+
The exact tournament directory name includes a timestamp, so inspect the metadata with:
107+
108+
```bash
109+
find /tmp/codeclash-cyborg-smoke -maxdepth 3 -name metadata.json -print
110+
```
111+
74112
--8<-- "docs/_footer.md"

docs/reference/arenas/scml.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,41 @@ across those worlds.
6666
The runner rotates player ordering across simulations to reduce positional bias from factory
6767
assignment.
6868

69+
## Smoke Test
70+
71+
From the repository root, run the dummy-player example:
72+
73+
```bash
74+
rm -rf /tmp/codeclash-scml-smoke
75+
uv run python main.py configs/examples/SCML__dummy__r1__s2.yaml -o /tmp/codeclash-scml-smoke
76+
```
77+
78+
Expected shape:
79+
80+
- the command exits with status 0;
81+
- both players pass submission validation;
82+
- stdout includes `In round 0, the winner is ...` and `In round 1, the winner is ...`;
83+
- each round summary contains floating-point average scores for `alpha` and `beta`;
84+
- the output directory contains `metadata.json`, `game.log`, `tournament.log`, and
85+
`rounds/round_0.tar.gz` / `rounds/round_1.tar.gz`.
86+
87+
A representative `metadata.json` round contains a `scores` object with one floating-point SCML
88+
profit score per player:
89+
90+
```json
91+
"scores": {
92+
"alpha": 1.0447501220885806,
93+
"beta": 0.9783875910335903
94+
}
95+
```
96+
97+
Exact values can change with simulation order and configuration; the smoke check is meant to verify
98+
the Docker/runtime adapter path, player-name mapping, and score/log artifact shape.
99+
100+
The exact tournament directory name includes a timestamp, so inspect the metadata with:
101+
102+
```bash
103+
find /tmp/codeclash-scml-smoke -maxdepth 3 -name metadata.json -print
104+
```
105+
69106
--8<-- "docs/_footer.md"

0 commit comments

Comments
 (0)