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.2.tar.gz (21.7 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.2-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_rl_app-0.0.2.tar.gz
  • Upload date:
  • Size: 21.7 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.2.tar.gz
Algorithm Hash digest
SHA256 dad4cd4950776400f965a0c9e8f92ee1ad8f1df233a1de07d17910b2b8e38c75
MD5 9bb7f29c3e4220ce4fbc6626a0e61ffa
BLAKE2b-256 a672646b127ce0f561bc8f208aa04790cb8454b30cfd18d30b3eef74c4038454

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_rl_app-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 35.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 55412fa7023cfc49580f2a6638b7d2169c1f3b216e85c7ea06158633b41d6303
MD5 287debb4228ab981734133efb0a37c25
BLAKE2b-256 6d562a95c67cfb6e6d7c062328c69fbf352651900babd35b1f2b31acce22ec19

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