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 .

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]
BDPO flowrl/agent/bdpo/bdpo.py [Performance] [Full Log]

📝 Citing Flow RL

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

@software{flow_rl,
  author       = {Chen-Xiao Gao and Mingjun Cao},
  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.0.2.tar.gz (16.1 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for flowrl-0.0.2.tar.gz
Algorithm Hash digest
SHA256 73d13d362105bcf98ba527fd88c582adc02e60a0db3c64e81c3c4223e7cd54bf
MD5 fd9c45db1a1f0b93f91a4d3c7c235b71
BLAKE2b-256 5b86bc0fd109b5a08f7b33e47c346c57bf39c5fd580db4d461da909785ee3eda

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