Spaces:
Running
Running
Update docs: CLI submission, agent identity, replay downloads, API endpoints
Browse files- README.md +36 -0
- data/schema.md +2 -1
README.md
CHANGED
|
@@ -54,10 +54,46 @@ python evaluate.py \
|
|
| 54 |
|
| 55 |
### Submit results
|
| 56 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
1. Fork this repo
|
| 58 |
2. Run evaluation (appends to `data/results.csv`)
|
| 59 |
3. Open a PR with your results
|
| 60 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
## Scoring
|
| 62 |
|
| 63 |
| Component | Weight | Description |
|
|
|
|
| 54 |
|
| 55 |
### Submit results
|
| 56 |
|
| 57 |
+
**Via CLI (recommended):**
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
+
pip install openra-rl
|
| 61 |
+
openra-rl bench submit result.json
|
| 62 |
+
openra-rl bench submit result.json --replay game.orarep --agent-name "MyBot" --agent-url "https://github.com/user/mybot"
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
Results from `openra-rl play` are auto-submitted after each game.
|
| 66 |
+
|
| 67 |
+
**Via PR:**
|
| 68 |
+
|
| 69 |
1. Fork this repo
|
| 70 |
2. Run evaluation (appends to `data/results.csv`)
|
| 71 |
3. Open a PR with your results
|
| 72 |
|
| 73 |
+
### Agent identity
|
| 74 |
+
|
| 75 |
+
Customize your leaderboard entry:
|
| 76 |
+
|
| 77 |
+
| Field | Description |
|
| 78 |
+
|-------|-------------|
|
| 79 |
+
| `agent_name` | Display name (e.g. "DeathBot-9000") |
|
| 80 |
+
| `agent_type` | `Scripted`, `LLM`, or `RL` |
|
| 81 |
+
| `agent_url` | GitHub/project URL — renders as a clickable link on the leaderboard |
|
| 82 |
+
|
| 83 |
+
### Replay downloads
|
| 84 |
+
|
| 85 |
+
Entries submitted with a `.orarep` replay file show a download link in the Replay column. Replays are stored on the Space and served at `/replays/<filename>`.
|
| 86 |
+
|
| 87 |
+
### API endpoints
|
| 88 |
+
|
| 89 |
+
The Gradio app exposes these API endpoints (Gradio 5+ SSE protocol):
|
| 90 |
+
|
| 91 |
+
| Endpoint | Description |
|
| 92 |
+
|----------|-------------|
|
| 93 |
+
| `submit` | Submit JSON results (no replay) |
|
| 94 |
+
| `submit_with_replay` | Submit JSON + replay file |
|
| 95 |
+
| `filter_leaderboard` | Query/filter leaderboard data |
|
| 96 |
+
|
| 97 |
## Scoring
|
| 98 |
|
| 99 |
| Component | Weight | Description |
|
data/schema.md
CHANGED
|
@@ -14,4 +14,5 @@
|
|
| 14 |
| `avg_economy` | float | Average final assets_value per game |
|
| 15 |
| `avg_game_length` | int | Average game duration in ticks |
|
| 16 |
| `timestamp` | str | Evaluation date (ISO 8601, YYYY-MM-DD) |
|
| 17 |
-
| `replay_url` | str |
|
|
|
|
|
|
| 14 |
| `avg_economy` | float | Average final assets_value per game |
|
| 15 |
| `avg_game_length` | int | Average game duration in ticks |
|
| 16 |
| `timestamp` | str | Evaluation date (ISO 8601, YYYY-MM-DD) |
|
| 17 |
+
| `replay_url` | str | Replay filename in submissions/, empty if none |
|
| 18 |
+
| `agent_url` | str | GitHub/project URL for the agent, empty if none |
|