Skip to content

Commit

Permalink
[BridgeBidding] Update version (#1206)
Browse files Browse the repository at this point in the history
  • Loading branch information
sotetsuk committed Jul 25, 2024
1 parent dc9e754 commit 259dc40
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Use `pgx.available_envs() -> Tuple[EnvId]` to see the list of currently availabl
|<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/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">| `v0` | *Partners exchange information via bids.* |
|<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.* |
|<a href="https://en.wikipedia.org/wiki/Connect_Four">Connect Four</a><br>`"connect_four"` |<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/connect_four_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/connect_four_light.gif" width="60px">| `v0` | *Connect discs, win with four.* |
|<a href="https://en.wikipedia.org/wiki/Minichess">Gardner Chess</a><br>`"gardner_chess"`|<img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/gardner_chess_dark.gif" width="60px"><img src="https://raw.githubusercontent.com/sotetsuk/pgx/main/docs/assets/gardner_chess_light.gif" width="60px">| `v0` | *5x5 chess variant, excluding castling.* |
Expand Down
7 changes: 4 additions & 3 deletions docs/bridge_bidding.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ env = BridgeBidding()

In Pgx, we follow `[Tian+20]` and use pre-computed Double Dummy Solver (DDS) dataset for each hand.
So, `BrdigeBidding` environment requires to load pre-computed DDS dataset by `env = BridgeBidding("<path_to_dataset>")`.
Please run the following command to download the DDS results provided by Pgx.
Please run the following command to download the DDS results provided by Pgx from [huggingface](https://huggingface.co/datasets/sotetsuk/dds_dataset).

```py
from pgx.bridge_bidding import download_dds_results
Expand Down Expand Up @@ -56,7 +56,7 @@ Therefore, we approximate the playing phase of bridge by using the results of DD

| Name | Value |
|:---|:----:|
| Version | `v0` |
| Version | `v1` |
| Number of players | `4` |
| Number of actions | `38` |
| Observation shape | `(480,)` |
Expand Down Expand Up @@ -96,6 +96,7 @@ Terminates by three consecutive passes after the last bid.
## Version History

- `v0` : Initial release (v1.0.0)
- `v1` : Provide larger DDS dataset and improve the efficienct in [#1191](https://github.com/sotetsuk/pgx/pull/1191/files) (v2.1.2)

## Reference

Expand All @@ -105,4 +106,4 @@ Terminates by three consecutive passes after the last bid.
- `[Lockhart+20]` "Human-agent cooperation in bridge bidding"
- `Double Dummy Solver` http://privat.bahnhof.se/wb758135/
- `PBN format` https://www.tistis.nl/pbn/
- `IMP` https://en.wikipedia.org/wiki/International_Match_Points
- `IMP` https://en.wikipedia.org/wiki/International_Match_Points
2 changes: 1 addition & 1 deletion pgx/bridge_bidding.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def id(self) -> core.EnvId:

@property
def version(self) -> str:
return "v0"
return "v1"

@property
def num_players(self) -> int:
Expand Down

0 comments on commit 259dc40

Please sign in to comment.