Skip to content

Commit b54d86b

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

2 files changed

Lines changed: 67 additions & 0 deletions

File tree

docs/reference/arenas/cyborg.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,38 @@ 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 local run with the checked-in dummy agents produced:
94+
95+
```json
96+
"scores": {
97+
"beta": -34.5,
98+
"alpha": -26.0
99+
}
100+
```
101+
102+
The exact tournament directory name includes a timestamp, so inspect the metadata with:
103+
104+
```bash
105+
find /tmp/codeclash-cyborg-smoke -maxdepth 3 -name metadata.json -print
106+
```
107+
74108
--8<-- "docs/_footer.md"

docs/reference/arenas/scml.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,37 @@ 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 local run with the checked-in dummy agents produced:
88+
89+
```json
90+
"scores": {
91+
"alpha": 1.0447501220885806,
92+
"beta": 0.9783875910335903
93+
}
94+
```
95+
96+
The exact tournament directory name includes a timestamp, so inspect the metadata with:
97+
98+
```bash
99+
find /tmp/codeclash-scml-smoke -maxdepth 3 -name metadata.json -print
100+
```
101+
69102
--8<-- "docs/_footer.md"

0 commit comments

Comments
 (0)