From 392cfd4981369eaa463ae455fdff1118a0d830ae Mon Sep 17 00:00:00 2001
From: Sotetsu KOYAMADA <koyamada-s@sys.i.kyoto-u.ac.jp>
Date: Tue, 27 Aug 2024 17:21:46 +0900
Subject: [PATCH] [Animal Shogi] Update documents (#1212)

---
 README.md            | 2 +-
 docs/animal_shogi.md | 7 +++++--
 pgx/animal_shogi.py  | 2 +-
 3 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c05457c04..98596f451 100644
--- a/README.md
+++ b/README.md
@@ -110,7 +110,7 @@ Use `pgx.available_envs() -> Tuple[EnvId]` to see the list of currently availabl
 | Game/EnvId | Visualization | Version | Five-word description by [ChatGPT](https://chat.openai.com/) |
 |:---:|:---:|:---:|:---:|
 |<a href="https://en.wikipedia.org/wiki/2048_(video_game)">2048</a> <br> `"2048"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/2048_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/2048_light.gif" width="60px">| `v2` | *Merge tiles to create 2048.* |
-|<a href="https://en.wikipedia.org/wiki/D%C5%8Dbutsu_sh%C5%8Dgi">Animal Shogi</a><br>`"animal_shogi"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/animal_shogi_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/animal_shogi_light.gif" width="60px">|  `v0` | *Animal-themed child-friendly shogi.* |
+|<a href="https://en.wikipedia.org/wiki/D%C5%8Dbutsu_sh%C5%8Dgi">Animal Shogi</a><br>`"animal_shogi"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/animal_shogi_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/animal_shogi_light.gif" width="60px">|  `v1` | *Animal-themed child-friendly shogi.* |
 |<a href="https://en.wikipedia.org/wiki/Backgammon">Backgammon</a><br>`"backgammon"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/backgammon_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/backgammon_light.gif" width="60px">| `v2` | *Luck aids bearing off checkers.* |
 |<a href="https://en.wikipedia.org/wiki/Contract_bridge">Bridge bidding</a><br>`"bridge_bidding"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/bridge_bidding_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/bridge_bidding_light.gif" width="60px">| `v1` | *Partners exchange information via bids.* |
 |<a href="https://en.wikipedia.org/wiki/Chess">Chess</a><br>`"chess"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/chess_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/chess_light.gif" width="60px">| `v2` | *Checkmate opponent's king to win.* |
diff --git a/docs/animal_shogi.md b/docs/animal_shogi.md
index 2795bcd57..5e91adb7c 100644
--- a/docs/animal_shogi.md
+++ b/docs/animal_shogi.md
@@ -39,7 +39,7 @@ See also [Wikipedia](https://en.wikipedia.org/wiki/D%C5%8Dbutsu_sh%C5%8Dgi)
 
 | Name | Value |
 |:---|:----:|
-| Version | `v0` |
+| Version | `v1` |
 | Number of players | `2` |
 | Number of actions | `132` |
 | Observation shape | `(4, 3, 194)` |
@@ -92,14 +92,17 @@ In cases 3 and 4, the game is declared a draw.
 
 ## Version History
 
+- `v1` : Fixed visualization [#1208](https://github.com/sotetsuk/pgx/pull/1208) and bug in Gold's move [#1209](https://github.com/sotetsuk/pgx/pull/1209) by [@KazukiOhta](https://github.com/KazukiOhta) (v2.2.0)
 - `v0` : Initial release (v1.0.0)
 
-
 ## Baseline models
 
 Pgx offers a baseline model for Animal Shogi. Users can use it for an anchor opponent in evaluation.
 See [our paper](https://arxiv.org/abs/2303.17503) for more details. See [this colab](https://colab.research.google.com/github/sotetsuk/pgx/blob/main/colab/baselines.ipynb) for how to use it.
 
+> [!WARNING]
+> Curren latest model (`animal_shogi_v0`) is trained with `v0` environment. It may perform significantly worse in `v1` environment.
+
 | Model ID | Description |
 |:---:|:----|
 | `animal_shogi_v0`| See [our paper](https://arxiv.org/abs/2303.17503) for the training details. |
\ No newline at end of file
diff --git a/pgx/animal_shogi.py b/pgx/animal_shogi.py
index eb43230e3..ea0af085c 100644
--- a/pgx/animal_shogi.py
+++ b/pgx/animal_shogi.py
@@ -146,7 +146,7 @@ def id(self) -> core.EnvId:
 
     @property
     def version(self) -> str:
-        return "v0"
+        return "v1"
 
     @property
     def num_players(self) -> int: