boxing-gym

Name	boxing-gym JSON
Version	0.1.10 JSON
	download
home_page	https://github.com/Hal609/BoxingGym
Summary	An Mike Tyson's Punch Out!! Gymnasium Environment
upload_time	2025-01-09 01:46:50
maintainer	None
docs_url	None
author	Hal Kolb
requires_python	None
license	MIT
keywords	nes emulator openai-gym gymnasium punch-out reinforcement-learning-environment
VCS
bugtrack_url
requirements	numpy gymnasium opencv-python
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Boxing Gym

boxing_gym is a Mike Tyson's Punch Out!! Gymnasium environment using [GymNESium](https://github.com/Hal609/GymNESium).

# Installation

The preferred installation of `boxing_gym` is from `pip`:

```shell
pip install boxing_gym
```

# Usage

Import the module
```
from boxing_gym import make_env
```

Create the environment
```
env = make_env()
```

Step the environment
```
env.step_async(action)
observation_, reward, done_, trun_, info = env.step_wait()
```

For a full example see: [MTPO-RL](https://github.com/Hal609/GymNESium)

# Disclaimer

**This project is provided for educational purposes only. It is not
affiliated with and has not been approved by Nintendo.**

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Hal609/BoxingGym",
    "name": "boxing-gym",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "NES Emulator OpenAI-Gym Gymnasium Punch-Out Reinforcement-Learning-Environment",
    "author": "Hal Kolb",
    "author_email": "hal@kolb.co.uk",
    "download_url": null,
    "platform": null,
    "description": "# Boxing Gym\n\nboxing_gym is a Mike Tyson's Punch Out!! Gymnasium environment using [GymNESium](https://github.com/Hal609/GymNESium).\n\n# Installation\n\nThe preferred installation of `boxing_gym` is from `pip`:\n\n```shell\npip install boxing_gym\n```\n\n# Usage\n\nImport the module\n```\nfrom boxing_gym import make_env\n```\n\nCreate the environment\n```\nenv = make_env()\n```\n\nStep the environment\n```\nenv.step_async(action)\nobservation_, reward, done_, trun_, info = env.step_wait()\n```\n\nFor a full example see: [MTPO-RL](https://github.com/Hal609/GymNESium)\n\n# Disclaimer\n\n**This project is provided for educational purposes only. It is not\naffiliated with and has not been approved by Nintendo.**\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An Mike Tyson's Punch Out!! Gymnasium Environment",
    "version": "0.1.10",
    "project_urls": {
        "Homepage": "https://github.com/Hal609/BoxingGym"
    },
    "split_keywords": [
        "nes",
        "emulator",
        "openai-gym",
        "gymnasium",
        "punch-out",
        "reinforcement-learning-environment"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "069e185d208dbf9325c369fec57031fd1b1b46153eac91b913a028e1b6718dc9",
                "md5": "90fff9187fc574b03f700bba142d6267",
                "sha256": "2a915cac83d3e852cad0e92823e72603be645cc4bba12ca16eac1025758df3d5"
            },
            "downloads": -1,
            "filename": "boxing_gym-0.1.10-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "90fff9187fc574b03f700bba142d6267",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 144417,
            "upload_time": "2025-01-09T01:46:50",
            "upload_time_iso_8601": "2025-01-09T01:46:50.146479Z",
            "url": "https://files.pythonhosted.org/packages/06/9e/185d208dbf9325c369fec57031fd1b1b46153eac91b913a028e1b6718dc9/boxing_gym-0.1.10-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-09 01:46:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Hal609",
    "github_project": "BoxingGym",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.18.5"
                ]
            ]
        },
        {
            "name": "gymnasium",
            "specs": [
                [
                    ">=",
                    "1.0.0"
                ]
            ]
        },
        {
            "name": "opencv-python",
            "specs": [
                [
                    ">=",
                    "4.10.0.84"
                ]
            ]
        }
    ],
    "lcname": "boxing-gym"
}