Skip to main content

A library desgined for flow-based RL algorithms

Project description

Flow RL

PyPI version License: MIT Python 3.11+ Python 3.8+

Flow RL is a high-performance reinforcement learning library, combining modern deep RL algorithms with flow and diffusion models for advanced policy parameterization, planning ability or dynamics modeling. It features:

  • State-of-the-Art Algorithms and Efficiency: We provide JAX implementations of SOTA algorithms, such FQL, BDPO, DAC and etc;
  • Flexible Flow Architectures: We provide built-in support various types of flow and diffusion models, such as CNFs and DDPM;
  • Comprehensive Evaluations: We test the algorithms on commonly adopted benchmark and provide the results.

🚀 Installation & Usage

Currently FlowRL is hosted on PyPI and therefore can be installed via pip install flowrl. However, we recommend to clone and install the library using the following commands:

git clone https://github.com/typoverflow/flow-rl.git
cd flow-rl
pip install -e .

Alternatively, you can use our Docker image:

docker pull typoverflow/flow-rl
docker run --gpus all -it typoverflow/flow-rl bash

The entry files are presented in examples/. Please refer to the scripts in scripts/ for how to execute the algorithms.

📊 Supported Algorithms

Offline RL:

Algorithm Location WandB Report
IQL flowrl/agent/iql.py [Performance] [Full Log]
IVR flowrl/agent/ivr.py [Performance] [Full Log]
FQL flowrl/agent/fql/fql.py [Performance] [Full Log]
DAC flowrl/agent/dac.py [Performance] [Full Log]
BDPO flowrl/agent/bdpo/bdpo.py [Performance] [Full Log]

Online RL

Algorithm Location WandB Report
SAC flowrl/agent/online/sac.py Gym-MuJoCo Results
TD3 flowrl/agent/online/td3.py
TD7 flowrl/agent/online/td7.py
SDAC flowrl/agent/online/sdac.py
QSMAgent flowrl/agent/online/qsm.py
DACERAgent flowrl/agent/online/dacer.py
QVPOAgent flowrl/agent/online/qvpo.py

📝 Citing Flow RL

If you use Flow RL in your research, please cite:

@software{flow_rl,
  author       = {Chen-Xiao Gao and Mingjun Cao and Edward Chen},
  title        = {Flow RL: Flow-based Reinforcement Learning Algorithms},
  year         = 2025,
  version      = {v0.0.1},
  url          = {https://github.com/typoverflow/flow-rl}
}

💎 Acknowledgements

Inspired by foundational work from

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

flowrl-0.2.0.tar.gz (38.3 kB view details)

Uploaded Source

File details

Details for the file flowrl-0.2.0.tar.gz.

File metadata

  • Download URL: flowrl-0.2.0.tar.gz
  • Upload date:
  • Size: 38.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flowrl-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fce1d3da4594d9bf6c45aa3ef5039d2f56e98535007e073413c025a7e6893696
MD5 6d38eaca5d8502eb4246b7077b87b550
BLAKE2b-256 8082a28d6d00edbc1a7b5a2fad1e174d6b08217c35fcd033f9314bad9964ef6c

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