Skip to content

Commit

Permalink
docs: Add pickle warning to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
strakam authored Oct 3, 2024
1 parent 0e98e1f commit 822092f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,10 @@ replay.play()
- `spacebar` — toggle play/pause
- `mouse` click on the player's row — toggle the FoV (Field of View) of the given player

> [!WARNING]
> We are using the [pickle](https://docs.python.org/3/library/pickle.html) module which is not safe!
> Only open replays you trust.
## 🌍 Environment
### 🔭 Observation
An observation for one agent is a dictionary `{"observation": observation, "action_mask": action_mask}`.
Expand Down

0 comments on commit 822092f

Please sign in to comment.