|
Download README.md from rvstowrn/shape: direct link, hf CLI and curl.
- Browser
- Download file 1.05 kB
-
https://huggingface.co/spaces/rvstowrn/shape/resolve/main/README.md
- Command line
-
hf download hf://spaces/rvstowrn/shape/README.md
-
curl -L -o README.md https://huggingface.co/spaces/rvstowrn/shape/resolve/main/README.md
1.05 kB
| title: Shape | |
| emoji: 📡 | |
| colorFrom: indigo | |
| colorTo: indigo | |
| sdk: docker | |
| pinned: false | |
| # Wordle WebSocket Environment | |
| This Space runs a Docker-based FastAPI service that exposes a Wordle reinforcement-learning environment over WebSocket. | |
| - `GET /` returns health and task metadata | |
| - `GET /ws` accepts JSON messages for `reset`, `step`, and `state` | |
| The Space is available at: | |
| - `https://rvstowrn-shape.hf.space/` | |
| - `wss://rvstowrn-shape.hf.space/ws` | |
| ## Protocol | |
| Reset a new episode: | |
| ```json | |
| {"type":"reset","task_name":"medium","seed":42,"evaluation_mode":false} | |
| ``` | |
| Take a step: | |
| ```json | |
| {"type":"step","guess":"ABOUT"} | |
| ``` | |
| Inspect server-side state: | |
| ```json | |
| {"type":"state"} | |
| ``` | |
| ## Response Shape | |
| - `reset` returns `{ observation, reward, done }` | |
| - `step` returns `{ observation, reward, done, info }` | |
| - `state` returns `{ episode_id, task_name, step_count, remaining_attempts, done, episode_reward_total }` | |
| The `observation` includes guesses, feedback, remaining attempts, discovered letter constraints, and a `valid_action_mask`. | |