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

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_rl_app-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 e62a79eaeb6c90aacf3decbc31803b730b71a37f01d1aa645e619f9caa43e494
MD5 042d338e28c28ca606f397b639808b54
BLAKE2b-256 96ccc0197804588dfea403901d0da644c6d1281b7c3f1993e3b6d9929d822e76

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_rl_app-0.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 11109b6d6ce4ac53285291fe59818e3999dc4e5b360911c3f48b8334b73b2300
MD5 dce1b65e7bc031da27be466ad44928bb
BLAKE2b-256 fa7e72f4fa855b16fb553458385509fe7f9315d9ad9aa4feeb0f538c998c8b75

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