minppo

Name	minppo JSON
Version	0.0.1 JSON
	download
home_page	https://github.com/kscalelabs/minppo
Summary	The minppo project
upload_time	2024-10-16 19:35:55
maintainer	None
docs_url	None
author	Benjamin Bolte
requires_python	>=3.11
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <p align="center">
  <picture>
    <img alt="K-Scale Open Source Robotics" src="https://media.kscale.dev/kscale-open-source-header.png" style="max-width: 100%;">
  </picture>
</p>

<div align="center">

[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/ksim/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/k5mSvCkYQh)
[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)
<br />
[![python](https://img.shields.io/badge/-Python_3.11-blue?logo=python&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![black](https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray)](https://black.readthedocs.io/en/stable/)
[![ruff](https://img.shields.io/badge/Linter-Ruff-red.svg?labelColor=gray)](https://github.com/charliermarsh/ruff)
<br />
[![Python Checks](https://github.com/kscalelabs/humanoid-standup/actions/workflows/test.yml/badge.svg)](https://github.com/kscalelabs/humanoid-standup/actions/workflows/test.yml)

</div>

# MinPPO

This repository implements a minimal version of PPO using Jax.

## Usage

To visualize the environment, run:

```bash
python environment.py configs/stompy_pro.yaml
```

To train the model, run:

```bash
python train.py configs/stompy_pro.yaml
```

To run inference on the trained model, run:

```bash
python infer.py configs/stompy_pro.yaml 'inference.model_path=path/to/trained/model.pkl'
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kscalelabs/minppo",
    "name": "minppo",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Benjamin Bolte",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/b4/23/63bf26f7a84307a09c90c19085829ed4cd7b0130a8966679d5fa979a9db8/minppo-0.0.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <picture>\n    <img alt=\"K-Scale Open Source Robotics\" src=\"https://media.kscale.dev/kscale-open-source-header.png\" style=\"max-width: 100%;\">\n  </picture>\n</p>\n\n<div align=\"center\">\n\n[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/ksim/blob/main/LICENSE)\n[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/k5mSvCkYQh)\n[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)\n<br />\n[![python](https://img.shields.io/badge/-Python_3.11-blue?logo=python&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![black](https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray)](https://black.readthedocs.io/en/stable/)\n[![ruff](https://img.shields.io/badge/Linter-Ruff-red.svg?labelColor=gray)](https://github.com/charliermarsh/ruff)\n<br />\n[![Python Checks](https://github.com/kscalelabs/humanoid-standup/actions/workflows/test.yml/badge.svg)](https://github.com/kscalelabs/humanoid-standup/actions/workflows/test.yml)\n\n</div>\n\n# MinPPO\n\nThis repository implements a minimal version of PPO using Jax.\n\n## Usage\n\nTo visualize the environment, run:\n\n```bash\npython environment.py configs/stompy_pro.yaml\n```\n\nTo train the model, run:\n\n```bash\npython train.py configs/stompy_pro.yaml\n```\n\nTo run inference on the trained model, run:\n\n```bash\npython infer.py configs/stompy_pro.yaml 'inference.model_path=path/to/trained/model.pkl'\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The minppo project",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/kscalelabs/minppo"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4571b82bf4de307540ced35cab2f5c7b3434ae17d23489191bd9ae8b41f01e3b",
                "md5": "cc73d148afe9a69c6ca1c78f6bb1e8f3",
                "sha256": "2e9f82d2db17dc14686e921895737893b2917f225e8ba0ec0bbe351f3dd3f042"
            },
            "downloads": -1,
            "filename": "minppo-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cc73d148afe9a69c6ca1c78f6bb1e8f3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 13171,
            "upload_time": "2024-10-16T19:35:53",
            "upload_time_iso_8601": "2024-10-16T19:35:53.965367Z",
            "url": "https://files.pythonhosted.org/packages/45/71/b82bf4de307540ced35cab2f5c7b3434ae17d23489191bd9ae8b41f01e3b/minppo-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b42363bf26f7a84307a09c90c19085829ed4cd7b0130a8966679d5fa979a9db8",
                "md5": "4db9f211d8dfa5e3f6906a16f6decdf0",
                "sha256": "12626d35b82cc8b256fe8723ab6cd0b22adcd9654437e27f2e98dffee451060d"
            },
            "downloads": -1,
            "filename": "minppo-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4db9f211d8dfa5e3f6906a16f6decdf0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 13261,
            "upload_time": "2024-10-16T19:35:55",
            "upload_time_iso_8601": "2024-10-16T19:35:55.642514Z",
            "url": "https://files.pythonhosted.org/packages/b4/23/63bf26f7a84307a09c90c19085829ed4cd7b0130a8966679d5fa979a9db8/minppo-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-16 19:35:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kscalelabs",
    "github_project": "minppo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "minppo"
}