| Name | tile-match-gym JSON |
| Version |
1.0.5
JSON |
| download |
| home_page | None |
| Summary | A set of reinforcement learning environments for tile matching games, consistent with the OpenAI Gymnasium API. |
| upload_time | 2024-10-21 12:20:23 |
| maintainer | None |
| docs_url | None |
| author | James Elson |
| requires_python | >=3.8 |
| license | Copyright (c) 2023, Akshil Patel Copyright (c) 2023, James Elson All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of tile-match-gym nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
reinforcement-learning
gym
tile-matching
games
rl
openai-gym
gymnasium
rl-environment
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Tile Matching Reinforcement Learning Environments
Welcome to the Reinforcement Learning Environments for Tile Matching Games repository! Here you can find a collection of tile matching game environments (like Bejeweled or Candy Crush), poised to push reinforcement learning research forwards.
This genre of games is characterised by the following features, which we find useful for reinforcement learning research:
- Large action spaces
- Intuitive action hierarchies
- Procedurally generated levels
- Structured complex stochasticity in transition dynamics
## Installation
You can install the package via pip:
```pip install tile-match-gym```
## Example Usage
We follow the the Farama Foundation Gymnasium API:
```
from tile_match_gym.tile_match_env import TileMatchEnv
env = TileMatchEnv(
num_rows=10,
num_cols=10,
num_colours=4,
num_moves=30,
colourless_specials=["cookie"],
colour_specials=["vertical_laser", "horizontal_laser", "bomb"],
seed=2
render_mode="human",
)
obs, _ = env.reset()
while True:
action = env.action_space.sample()
next_obs, reward, done, truncated, info = env.step(action)
env.render()
if done:
break
else:
obs = next_obs
```
## Citation
We'd love it if you use our package for your research! If you do use code from this repository please cite us as below:
```
@software{tile_match_gym,
author = {Patel, Akshil and Elson, James},
title = {{Tile Matching Game Reinforcement Learning Environments}},
url = {https://github.com/akshilpatel/tile-match-gym},
version = {1.0.5},
year = {2023}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tile-match-gym",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "reinforcement-learning, gym, tile-matching, games, rl, openai-gym, gymnasium, rl-environment",
"author": "James Elson",
"author_email": "Akshil Patel <akshilpatel11@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/2e/50/307110a27e8b509ebc5fd5d7dbad7e87f6eb6d0c61af280dd020ccbc3789/tile_match_gym-1.0.5.tar.gz",
"platform": null,
"description": "# Tile Matching Reinforcement Learning Environments\n\nWelcome to the Reinforcement Learning Environments for Tile Matching Games repository! Here you can find a collection of tile matching game environments (like Bejeweled or Candy Crush), poised to push reinforcement learning research forwards.\n\nThis genre of games is characterised by the following features, which we find useful for reinforcement learning research:\n\n- Large action spaces\n- Intuitive action hierarchies\n- Procedurally generated levels\n- Structured complex stochasticity in transition dynamics\n\n## Installation\n\nYou can install the package via pip:\n\n```pip install tile-match-gym```\n\n## Example Usage\n\nWe follow the the Farama Foundation Gymnasium API:\n\n```\nfrom tile_match_gym.tile_match_env import TileMatchEnv\n\nenv = TileMatchEnv(\n num_rows=10, \n num_cols=10, \n num_colours=4, \n num_moves=30, \n colourless_specials=[\"cookie\"], \n colour_specials=[\"vertical_laser\", \"horizontal_laser\", \"bomb\"], \n seed=2\n render_mode=\"human\",\n )\n\nobs, _ = env.reset()\n\nwhile True:\n action = env.action_space.sample()\n next_obs, reward, done, truncated, info = env.step(action)\n env.render()\n if done:\n break\n else:\n obs = next_obs\n```\n\n## Citation\n\nWe'd love it if you use our package for your research! If you do use code from this repository please cite us as below:\n\n```\n@software{tile_match_gym,\n author = {Patel, Akshil and Elson, James},\n title = {{Tile Matching Game Reinforcement Learning Environments}},\n url = {https://github.com/akshilpatel/tile-match-gym},\n version = {1.0.5},\n year = {2023}\n }\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2023, Akshil Patel Copyright (c) 2023, James Elson All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of tile-match-gym nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A set of reinforcement learning environments for tile matching games, consistent with the OpenAI Gymnasium API.",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/akshilpatel/tile-match-gym",
"Issues": "https://github.com/akshilpatel/tile-match-gym/issues"
},
"split_keywords": [
"reinforcement-learning",
" gym",
" tile-matching",
" games",
" rl",
" openai-gym",
" gymnasium",
" rl-environment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b725d7320e25c3db6e2faba925ffaf769906b0480f35b0b588250540206e5484",
"md5": "c0137fc5edf2ba4b087965d7a746b55c",
"sha256": "fb621aee53fc610316c8c2b1ddcfc562745947afac2f44969b1eb936f0b544d4"
},
"downloads": -1,
"filename": "tile_match_gym-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c0137fc5edf2ba4b087965d7a746b55c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 20089,
"upload_time": "2024-10-21T12:20:21",
"upload_time_iso_8601": "2024-10-21T12:20:21.980905Z",
"url": "https://files.pythonhosted.org/packages/b7/25/d7320e25c3db6e2faba925ffaf769906b0480f35b0b588250540206e5484/tile_match_gym-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e50307110a27e8b509ebc5fd5d7dbad7e87f6eb6d0c61af280dd020ccbc3789",
"md5": "8169f5c7e2184c1b21016fe8eb034184",
"sha256": "7b8774290e38a49ad3a1bc38b58dd365e135592d7a7298ef0cf1da694d24cf99"
},
"downloads": -1,
"filename": "tile_match_gym-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "8169f5c7e2184c1b21016fe8eb034184",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20852,
"upload_time": "2024-10-21T12:20:23",
"upload_time_iso_8601": "2024-10-21T12:20:23.589517Z",
"url": "https://files.pythonhosted.org/packages/2e/50/307110a27e8b509ebc5fd5d7dbad7e87f6eb6d0c61af280dd020ccbc3789/tile_match_gym-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 12:20:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "akshilpatel",
"github_project": "tile-match-gym",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tile-match-gym"
}
