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.6.tar.gz (22.9 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.6-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: create_rl_app-0.0.6.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for create_rl_app-0.0.6.tar.gz
Algorithm Hash digest
SHA256 412c1d5edbc90aaf4db2b32fb115c892a4a7b38df97de41e425ceb8f4d7d48c9
MD5 853f4be37a63368fa08871dbfe47f7a5
BLAKE2b-256 f3552fb6e8d415bdb45e8660da55c316a67a44b71e6866e835313451cc089110

See more details on using hashes here.

File details

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

File metadata

  • Download URL: create_rl_app-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for create_rl_app-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 defe81b56b6aa43e18d07c625d0cce94801d7b2ffc4ce6043426dcd553b8f0f8
MD5 8cfe5ea3b193ab3b9a9f9a7e51f009ba
BLAKE2b-256 9a06f31342f8f7059dc21863039153feb016d93fb41e2683c5aae2906f7701fd

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