Gym Janggi
Gym Janggi provides an reinforcement learning environment for Korean chess called Janggi. As an OpenAI Gym environment, this package can be used for reinforcement learning algorithms, such as AlphaZero.
Documentation
Check out the GitHub Page for Gym environment documentation.
Getting Started
Using the Gym Enviornment in Your Package
-
Install package via pip:
pip install gym-janggi -
Import in your Python module:
import gymimport gym_janggi -
Make a Gym environment instance:
gym.make("gym_janggi/Janggi-v0")Check out the Documentation section for more details.
Testing Functionality
Gym Janggi is originally designed to be imported by other packages and provide a Gym environemnt for Janggi, but if you want to check if the package itself is working, you can follow these steps:
-
Clone the repository:
git clone https://github.com/sungho-cho/gym-janggi.git -
Install the module:
pip install -e . -
Run
play.py, which generates a game with a series of random moves:python gym_janggi/play.pyIf you see the UI window and moves being played, the package is working!
Releases
Check out the PyPi Package for releases.
License
This package is licensed under the GNU General Public License v3.0.
Metadata
Release files for gym-janggi 0.9.24
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gym_janggi-0.9.24.tar.gz | 16.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gym_janggi-0.9.24-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 35.0 kB
Release files / gym_janggi-0.9.24.tar.gz
| Download URL | gym_janggi-0.9.24.tar.gz |
|---|---|
| Size | 16.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a3f1bd2eb046135dd9cdfacb329400efcf81d54f0e9d78e82ddeb9ced54716c2
|
|
BLAKE2b-256 checksum How to use checksums |
373425b1071d7caa072e9533408bccfe3da70b0d5ec13b3a400e342743f6fe53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.7
|
Release files / gym_janggi-0.9.24-py3-none-any.whl
| Download URL | gym_janggi-0.9.24-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0bc378a2a67039e2953f8a40223b304281542ade409658e183f4d892358108f2
|
|
BLAKE2b-256 checksum How to use checksums |
10448283a41f00b8b2f4b9188ed0b022d9a685b3102eeca8c20d9d32584c2272
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.7
|