v2.0.0

API v2

Pgx has been updated from API v1 to v2 as of November 8, 2023 (release v2.0.0). As a result, the signature for Env.step has changed as follows:

• v1: step(state: State, action: Array)
• v2: step(state: State, action: Array, key: Optional[PRNGKey] = None)

Also, pgx.experimental.auto_reset are changed to specify key as the third argument.

Purpose of the update: In API v1, even in environments with stochastic state transitions, the state transitions were deterministic, determined by the _rng_key inside the state. This was intentional, with the aim of increasing reproducibility. However, when using planning algorithms in this environment, there is a risk that information about the underlying true randomness could "leak." To make it easier for users to conduct correct experiments, Env.step has been changed to explicitly specify a key.

Impact of the update: Since the key is optional, it is still possible to execute as env.step(state, action) like API v1 in deterministic environments like Go and chess, so there is no impact on these games. As of v2.0.0, only 2048, backgammon, and MinAtar suite are affected by this change.

What's Changed

• [Docs] Update 2048 version by @sotetsuk in #1036
• [Mahjong] Imprement ryuukyoku by @OkanoShinri in #1038
• [Mahjong] Imprement ron by @OkanoShinri in #1040
• Update leduc_holdem.md by @bleu48 in #1042
• [Mahjong] Imprement tsumo by @OkanoShinri in #1041
• [Mahjong] Convert to json format by @OkanoShinri in #1048
• [Backgammon] Add description to the playable_dice_count_vec by @nissymori in #1047
• [CI] Comment out some expensive tests as hotfix by @sotetsuk in #1052
• [Mahjong] Implement Menzen by @OkanoShinri in #1045
• [Mahjong] Determine current_player after pass by @OkanoShinri in #1053
• [Docs] Add license doc by @sotetsuk in #1057
• [Mahjong] Implement kandora by @OkanoShinri in #1054
• [Docs] Update citation by @sotetsuk in #1063
• [Docs] Add arXiv link by @sotetsuk in #1064
• [Mahjong] Dora-score calculation by @OkanoShinri in #1061
• [Test] Run CI with python3.10 only by @OkanoShinri in #1066
• [Colab] Update chess check by @sotetsuk in #1068
• [Mahjong] Add mahjong to Env by @OkanoShinri in #1069
• [Example] Add wandb link by @sotetsuk in #1072
• [Example] Use default Gumbel AlphaZero hyperparameters by @sotetsuk in #1055
• [API] Use int32 instead of int8/16 by @sotetsuk in #1074
• [Test] Remove redundant random play tests by @sotetsuk in #1076
• [Chess] Fix wrong zobrist hash by @sotetsuk in #1078
• [Experimental] Fix act_randomly API by @sotetsuk in #1077
• [2048] Fix bug in legal action mask by @sotetsuk in #1049
• [Mahjong] Remove old files by @sotetsuk in #1075
• [Backgammon] Update document by @sotetsuk in #1046
• [dataclass] Fix dataclass mutable defaults error by @carlosgmartin in #1067
• [dataclass] Suppress C901 by @sotetsuk in #1080
• [Mahjong] Add type annotations by @sotetsuk in #1081
• Add Python 3.11 CI by @sotetsuk in #997
• [CI] Add Python 3.12 to CI by @sotetsuk in #1082
• v2 API by @sotetsuk in #1058
• [Docs] Fix API document by @sotetsuk in #1083
• [Dependency] Update JAX version by @sotetsuk in #1084
• [Typing] Add types.py by @sotetsuk in #1085
• [dataclass] Trace Flax dataclass updates by @sotetsuk in #1086
• [Tidy] Add requirements.txt by @sotetsuk in #1087
• [experimental] Adjust auto_reset to v2 API by @sotetsuk in #1088
• [Mahjong] Add assets in release by @sotetsuk in #1089
• [MinAtar] Fix minatar usage by @sotetsuk in #1090
• [Backgammon, 2048] Update versions by @sotetsuk in #1092
• [Docs] v2 API description by @sotetsuk in #1091
• [Chess] Update version by @sotetsuk in #1093
• [2048] Update documents by @sotetsuk in #1094
• [Mahjong] Unregister mahjong due to large file size by @sotetsuk in #1095

New Contributors

• @bleu48 made their first contribution in #1042
• @carlosgmartin made their first contribution in #1067

Full Changelog: v1.4.0...v2.0.0

v1.4.0

What's Changed

• [2048] Fix reward overflow by @sotetsuk in #1034

Full Changelog: v1.3.3...v1.4.0

v.1.3.3

What's Changed

• [Docs] Add document about baseline models by @sotetsuk in #1029
• [Mahjong] Visualize game information by @OkanoShinri in #1027
• [Baseline] Update model ids by @sotetsuk in #1030
• [Docs] Add link to training example and baseline models by @sotetsuk in #1031
• [Docs] Add link to training examples in README by @sotetsuk in #1032

Full Changelog: v1.3.2...v1.3.3

v1.3.2

What's Changed

• [Experimental] Fix fmt by @sotetsuk in #1019
• [Examples] Add MinAtar PPO training example by @sotetsuk in #1020
• [Experimental] Fix flake8 errors by @sotetsuk in #1021
• [Docs] Add README for MinAtar PPO example by @sotetsuk in #1022
• [Example] Add AlphaZero example by @sotetsuk in #1024
• [Example] Track frames by @sotetsuk in #1025
• [Example] Validate wrong arguments by @sotetsuk in #1026
• [Mahjong] Make hai transparent by @OkanoShinri in #1016
• [MinAtar] Add baseline models by @sotetsuk in #1023

Full Changelog: v1.3.1...v1.3.2

v1.3.1

What's Changed

• [Docs] Fix Hex document by @sotetsuk in #1012
• [CI] Fix GitHub pages deployment by @sotetsuk in #1013
• [Mahjong] Imprement riichi by @OkanoShinri in #1003
• [Experimental] Add func based auto_reset by @sotetsuk in #1017

Full Changelog: v1.3.0...v1.3.1

v1.3.0

What's Changed

• [Docs] Update game descriptions by @sotetsuk in #1009
• [SparrowMahjong] Transpose observation (15 x 11 to 11 x 15) by @sotetsuk in #1010

Full Changelog: v1.2.0...v1.3.0

v1.2.0

What's Changed

• [Go] Add sgf loader by @youyou-ku in #970
• [Backgammon] Fix background visualization by @sotetsuk in #988
• [ipynb] Add colab to test chess by random play by @sotetsuk in #989
• [Docs] Add link to chess test colab by @sotetsuk in #990
• [Docs] Fix bridge fig by @sotetsuk in #981
• [Docs] Update index.md by @sotetsuk in #991
• [Docs] Add supported python version by @sotetsuk in #998
• [Docs] Add some badges by @sotetsuk in #999
• [CI] Add codecov by @sotetsuk in #1000
• [CI] Run CI on main branch by @sotetsuk in #1001
• [Docs] Add Sparrow Mahjong doc by @sotetsuk in #993
• [Backgammon] Fix the number of legal_action_mask dimension. by @nissymori in #1004
• [Docs] Translate Japanese comments into English by @sotetsuk in #1005
• [Colab] Reduce svg images by @sotetsuk in #1006
• [Docs] Update backgammon doc by @sotetsuk in #1002
• [Backgammon] Update version to v1 by @sotetsuk in #1007

Full Changelog: v1.1.0...v1.2.0

v1.1.0

What's Changed

• [Mahjong] chi/pon/kan in Mahjong by @OkanoShinri in #921
• [Docs] Enhance docs by @sotetsuk in #966
• [Docs] Add API usage by @sotetsuk in #973
• [Docs] Enhance API usage examples by @sotetsuk in #974
• [Docs] Fix citation by @sotetsuk in #975
• [Docs] Enhance shogi and kuhn poker docs by @sotetsuk in #978
• [Mahjong] Add visualizer by @OkanoShinri in #976
• [Docs] Update Leduc holdem document by @sotetsuk in #979
• [Chess] Fix _possible_piece_positions when castling by @HongruiTang in #983
• [Chess] Add test assets by @sotetsuk in #984
• [Docs] Update chess version by @sotetsuk in #985

New Contributors

• @HongruiTang made their first contribution in #983

Full Changelog: v1.0.0...v1.1.0

v1.0.0

What's Changed

• [Wrappers] Add some wrappers by @sotetsuk in #958
• [Experimental] Remove unused by @sotetsuk in #959
• [Docs] Update README by @sotetsuk in #960
• [Wrapper] Add SpecifyFirstPlayer wrapper by @sotetsuk in #962
• [BridgeBidding] Remove unused by @sotetsuk in #964
• [BridgeBidding] Update to v0 by @sotetsuk in #967

Full Changelog: v0.10.1...v1.0.0

v0.10.1

What's Changed

• [Colab] Update colab for v0.10.0 by @sotetsuk in #952
• [Baseline] Add download dir to arg by @sotetsuk in #953
• [BridgeBidding] Download DDS results by @sotetsuk in #954
• [Docs] Add bridge bidding to README by @sotetsuk in #955
• [Refactor] Rename download to _download by @sotetsuk in #956

Full Changelog: v0.10.0...v0.10.1