Skip to main content

Bootstrap a new Reinforcement Learning project

Project description

create-rl-app

Python Version Jaxnasium Version Ruff

A CLI application to bootstrap reinforcement learning applications within the Jaxnasium ecosystem. Quickly scaffold new RL projects for either developing environments with baseline algorithms or for altering existing baselines.

What it does

create-rl-app is a command-line tool that helps you quickly set up new reinforcement learning projects using the Jaxnasium framework. It creates a well-structured project template with:

  • 🚀 Quick Setup: Get a new RL project running in seconds
  • 🏗️ Helpful Templates: Templates for environments and algorithms for you to start with.
  • Performance Optimized: Sets you up with PureJaxRL compatible agents and environments for performance and GPU scalability.

Useage

uvx (Recommended)

uvx create-rl-app <project_name>
cd <project_name>
uv run train_example.py

pipx

pipx run create-rl-app <project_name>
cd <project_name>
# Create a new environment (e.g. conda, venv, etc.)
# source .../bin/activate
python train_example.py

Or Install Globally

uv tool install create-rl-app
pip install create-rl-app

Dependencies

None.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

create_rl_app-0.0.8.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

create_rl_app-0.0.8-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file create_rl_app-0.0.8.tar.gz.

File metadata

  • Download URL: create_rl_app-0.0.8.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for create_rl_app-0.0.8.tar.gz
Algorithm Hash digest
SHA256 f43c3adeb1b7f6ab3d62c8368e470f8cc0de2bfe8ec77f6cd667ee5d98ea5e97
MD5 d76367d1d739a334fa471cbbd690ffa4
BLAKE2b-256 26fbbe3d3a2f0ca23c80a7347bd8b50671dae976de21b5281158c2ea79fcec89

See more details on using hashes here.

File details

Details for the file create_rl_app-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: create_rl_app-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for create_rl_app-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 7ca892b74b63118c5171d2f9236c0380c474c97c00ac68551dbc4e97890742d7
MD5 b7d964620747aed2b216ca9b303b3984
BLAKE2b-256 8749d8711880cd413e1adba85425838fc6f451064db6318f63158fb5aa400fcb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page