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

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_rl_app-0.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 517a90c58a2463214c561aeeda521e06c75fb1c0de24a773156604be294baf4b
MD5 d84bb6521f125aa7804b77c08fa1e6fd
BLAKE2b-256 0fceb060bf4d9cce139a659c8a562523a9211bcb2c6600e533605b78f0152298

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_rl_app-0.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4fd56f90647f54aae202514ee97bdfa49c29dc09bfc4b2cd4c553ea07bd9af6a
MD5 faa3eea6001ef049398e4c2344ed655d
BLAKE2b-256 95e385231ad1cabac6c2ffbd6b873327ac60bef32f05468659f5d42e377b2354

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