Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

abcdRL (Implement a RL algorithm in four simple steps)

English | 简体中文

license pytest pre-commit pypi docker autobuild docs Gitpod ready-to-code benchmark mirror repo Checked with mypy Code style: black Imports: isort python versions

abcdRL is a Modular Single-file Reinforcement Learning Algorithms Library that provides modular design without strict and clean single-file implementation.

When reading the code, understand the full implementation details of the algorithm in the single file quickly; When modifying the algorithm, benefiting from a lightweight modular design, only need to focus on a small number of modules.

abcdRL mainly references the single-file design philosophy of vwxyzjn/cleanrl and the module design of PaddlePaddle/PARL.

Documentation ➡️ docs.abcdrl.xyz

Roadmap🗺️ #57

🚀 Quickstart

Open the project in Gitpod🌐 and start coding immediately.

Open in Gitpod

Using Docker📦:

# 0. Prerequisites: Docker & Nvidia Drive & NVIDIA Container Toolkit
# 1. Run DQN algorithm
docker run --rm --gpus all sdpkjc/abcdrl python abcdrl/dqn.py

For detailed installation instructions 👀

🐼 Features

  • 👨‍👩‍👧‍👦 Unified code structure
  • 📄 Single-file implementation
  • 🐷 Low code reuse
  • 📐 Minimizing code differences
  • 📈 Tensorboard & Wandb support
  • 🛤 PEP8(code style) & PEP526(type hint) compliant

🗽 Design Philosophy

  • "Copy📋", not "Inheritance🧬"
  • "Single-file📜", not "Multi-file📚"
  • "Features reuse🛠", not "Algorithms reuse🖨"
  • "Unified logic🤖", not "Unified interface🔌"

✅ Implemented Algorithms

Weights & Biases Benchmark Report ➡️ report.abcdrl.xyz


Citing abcdRL

@misc{zhao_abcdrl_2022,
    author = {Yanxiao, Zhao},
    month = {12},
    title = {{abcdRL: Modular Single-file Reinforcement Learning Algorithms Library}},
    url = {https://github.com/sdpkjc/abcdrl},
    year = {2022}
}

Metadata

Release files for abcdrl 0.2.0a4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for abcdrl 0.2.0a4
File Size Uploaded Provenance Actions
abcdrl-0.2.0a4.tar.gz 24.3 kB Without provenance Details for abcdrl-0.2.0a4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for abcdrl 0.2.0a4
File Interpreter ABI Platform Actions
abcdrl-0.2.0a4-py3-none-any.whl Python 3 none any Details for abcdrl-0.2.0a4-py3-none-any.whl

Total release size: 69.8 kB

Release files / abcdrl-0.2.0a4.tar.gz

Download URL abcdrl-0.2.0a4.tar.gz
Size 24.3 kB
Tags Source
SHA-256 checksum
How to use checksums
4c52cbfc2cd0a294278fbcbfaf6faaa26d10c375f5471f4e36c5e0e6fa059878
BLAKE2b-256 checksum
How to use checksums
a3237c2dd2dd33e5a9c14c657f461db7b2cfaa81e633bccfe90571575fd276e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.1 CPython/3.9.15 Linux/5.15.0-1024-azure

Release files / abcdrl-0.2.0a4-py3-none-any.whl

Download URL abcdrl-0.2.0a4-py3-none-any.whl
Size 45.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ed0274b4ac92c20fc85c81258fe1a69afcf085f55917f2063cb5349de1762968
BLAKE2b-256 checksum
How to use checksums
1094b819c3d72a88e8a12f57a97982eef0b308a91c0fcedd5580aed5435099a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.1 CPython/3.9.15 Linux/5.15.0-1024-azure

Security for abcdrl 0.2.0a4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page