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.5.tar.gz (22.0 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.5-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_rl_app-0.0.5.tar.gz
  • Upload date:
  • Size: 22.0 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.5.tar.gz
Algorithm Hash digest
SHA256 fdbb6eecc61d890212b288ab6d49209304a35c1af6f5eb945cbbfb0be9d853f8
MD5 c23c5d6951d757d1fd714b463dee4a17
BLAKE2b-256 d01b1182acd386546ef3e3183303149a741d3e47d9962419b2f91c9731e629b1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_rl_app-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 36.2 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8b4b23b948e512896c4d6418437c0a0b4afb87c25daa29107fae6a77e0c7a05c
MD5 3ad478bff19552e6afecc1cdfac084da
BLAKE2b-256 e42a7bc5cfd35aa5c68b3b9624584252a01c5faf21a620cd7c893c8ef3d21545

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