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.7.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.7-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_rl_app-0.0.7.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.7.tar.gz
Algorithm Hash digest
SHA256 422c0f86b357dd6cfff160deb4ced3836f7fc7bf18baf6e90a5e053d93174c29
MD5 43dcabe95b04972f9d62f1c6651bddd4
BLAKE2b-256 386a3025b71da6062e4239e2af95ea7780fe97de46d693aa9215d0c58934cc2b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_rl_app-0.0.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 5ef01b2f10c7adf23cde879e79e1b38380ded2f58bbc86a753907ca037972b59
MD5 ecfaf8a0eaf436ca43616568994d7a7c
BLAKE2b-256 75f5674402be192e3deba15e9f3a52996065bb729ccbaecac88cb1972f41df40

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