rectified-flow-pytorch 0.5.3__tar.gz

rectified_flow_pytorch-0.5.3/.github/workflows/python-publish.yml

@@ -0,0 +1,36 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

rectified_flow_pytorch-0.5.3/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Pytest
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -e .[test]
+    - name: Test with pytest
+      run: |
+        python -m pytest tests/

rectified_flow_pytorch-0.5.3/.gitignore

@@ -0,0 +1,164 @@
+results/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

rectified_flow_pytorch-0.5.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Phil Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rectified_flow_pytorch-0.5.3/PKG-INFO

@@ -0,0 +1,350 @@
+Metadata-Version: 2.4
+Name: rectified-flow-pytorch
+Version: 0.5.3
+Summary: Rectified Flow in Pytorch
+Project-URL: Homepage, https://pypi.org/project/rectified-flow-pytorch/
+Project-URL: Repository, https://github.com/lucidrains/rectified-flow-pytorch
+Author-email: Phil Wang <lucidrains@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Phil Wang
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: artificial intelligence,deep learning,rectified flow
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Requires-Dist: accelerate
+Requires-Dist: einops>=0.8.0
+Requires-Dist: einx>=0.3.0
+Requires-Dist: ema-pytorch>=0.5.2
+Requires-Dist: hyper-connections>=0.1.8
+Requires-Dist: pillow>=9.4.0
+Requires-Dist: scipy
+Requires-Dist: torch>=2.0
+Requires-Dist: torchdiffeq
+Requires-Dist: torchvision
+Provides-Extra: examples
+Requires-Dist: datasets; extra == 'examples'
+Provides-Extra: examples-fpo
+Requires-Dist: adam-atan2-pytorch; extra == 'examples-fpo'
+Requires-Dist: assoc-scan>=0.0.2; extra == 'examples-fpo'
+Requires-Dist: box2d-py; extra == 'examples-fpo'
+Requires-Dist: einops>=0.8.0; extra == 'examples-fpo'
+Requires-Dist: einx>=0.3.0; extra == 'examples-fpo'
+Requires-Dist: ema-pytorch>=0.7.3; extra == 'examples-fpo'
+Requires-Dist: fire; extra == 'examples-fpo'
+Requires-Dist: gymnasium[box2d]>=1.0.0; extra == 'examples-fpo'
+Requires-Dist: hl-gauss-pytorch>=0.1.15; extra == 'examples-fpo'
+Requires-Dist: hyper-connections>=0.2.0; extra == 'examples-fpo'
+Requires-Dist: lion-pytorch; extra == 'examples-fpo'
+Requires-Dist: moviepy>=1.0.3; extra == 'examples-fpo'
+Requires-Dist: numpy>=2.2.5; extra == 'examples-fpo'
+Requires-Dist: torch>=2.4; extra == 'examples-fpo'
+Requires-Dist: tqdm; extra == 'examples-fpo'
+Requires-Dist: x-transformers>=2.3.21; extra == 'examples-fpo'
+Provides-Extra: examples-ql
+Requires-Dist: assoc-scan; extra == 'examples-ql'
+Requires-Dist: box2d-py; extra == 'examples-ql'
+Requires-Dist: fire; extra == 'examples-ql'
+Requires-Dist: gymnasium[box2d]>=1.0.0; extra == 'examples-ql'
+Requires-Dist: moviepy>=1.0.3; extra == 'examples-ql'
+Requires-Dist: numpy>=2.2.5; extra == 'examples-ql'
+Requires-Dist: tqdm; extra == 'examples-ql'
+Requires-Dist: x-mlps-pytorch>=0.0.20; extra == 'examples-ql'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+<img src="./rf.png" width="400px"></img>
+
+## Rectified Flow - Pytorch
+
+Implementation of <a href="https://www.cs.utexas.edu/~lqiang/rectflow/html/intro.html">rectified flow</a> and some of its followup research / improvements in Pytorch
+
+<a href="https://drscotthawley.github.io/blog/posts/FlowModels.html">Tutorial</a> from <a href="https://github.com/drscotthawley">Dr. Scott Hawley</a>
+
+Youtube AI Educators - <a href="https://www.youtube.com/watch?v=7NNxK3CqaDk">Yannic</a> | <a href="https://www.youtube.com/watch?v=7cMzfkWFWhI">Outlier</a>
+
+<img src="./images/oxford-flowers.sample.png" width="350px"></img>
+
+*32 batch size, 11k steps oxford flowers*
+
+## Install
+
+```bash
+$ pip install rectified-flow-pytorch
+```
+
+## Usage
+
+```python
+import torch
+from rectified_flow_pytorch import RectifiedFlow, Unet
+
+model = Unet(dim = 64)
+
+rectified_flow = RectifiedFlow(model)
+
+images = torch.randn(1, 3, 256, 256)
+
+loss = rectified_flow(images)
+loss.backward()
+
+sampled = rectified_flow.sample()
+assert sampled.shape[1:] == images.shape[1:]
+```
+
+For reflow as described in the paper
+
+```python
+import torch
+from rectified_flow_pytorch import RectifiedFlow, Reflow, Unet
+
+model = Unet(dim = 64)
+
+rectified_flow = RectifiedFlow(model)
+
+images = torch.randn(1, 3, 256, 256)
+
+loss = rectified_flow(images)
+loss.backward()
+
+# do the above for many real images
+
+reflow = Reflow(rectified_flow)
+
+reflow_loss = reflow()
+reflow_loss.backward()
+
+# then do the above in a loop many times for reflow - you can reflow multiple times by redefining Reflow(reflow.model) and looping again
+
+sampled = reflow.sample()
+assert sampled.shape[1:] == images.shape[1:]
+```
+
+With a `Trainer` based on `accelerate`
+
+```python
+import torch
+from rectified_flow_pytorch import RectifiedFlow, ImageDataset, Unet, Trainer
+
+model = Unet(dim = 64)
+
+rectified_flow = RectifiedFlow(model)
+
+img_dataset = ImageDataset(
+    folder = './path/to/your/images',
+    image_size = 256
+)
+
+trainer = Trainer(
+    rectified_flow,
+    dataset = img_dataset,
+    num_train_steps = 70_000,
+    results_folder = './results'   # samples will be saved periodically to this folder
+)
+
+trainer()
+```
+
+## Examples
+
+Quick test on oxford flowers
+
+```bash
+$ pip install .[examples]
+```
+
+Then
+
+```bash
+$ python train_oxford.py
+```
+
+## Citations
+
+```bibtex
+@article{Liu2022FlowSA,
+    title   = {Flow Straight and Fast: Learning to Generate and Transfer Data with Rectified Flow},
+    author  = {Xingchao Liu and Chengyue Gong and Qiang Liu},
+    journal = {ArXiv},
+    year    = {2022},
+    volume  = {abs/2209.03003},
+    url     = {https://api.semanticscholar.org/CorpusID:252111177}
+}
+```
+
+```bibtex
+@article{Lee2024ImprovingTT,
+    title   = {Improving the Training of Rectified Flows},
+    author  = {Sangyun Lee and Zinan Lin and Giulia Fanti},
+    journal = {ArXiv},
+    year    = {2024},
+    volume  = {abs/2405.20320},
+    url     = {https://api.semanticscholar.org/CorpusID:270123378}
+}
+```
+
+```bibtex
+@article{Esser2024ScalingRF,
+    title   = {Scaling Rectified Flow Transformers for High-Resolution Image Synthesis},
+    author  = {Patrick Esser and Sumith Kulal and A. Blattmann and Rahim Entezari and Jonas Muller and Harry Saini and Yam Levi and Dominik Lorenz and Axel Sauer and Frederic Boesel and Dustin Podell and Tim Dockhorn and Zion English and Kyle Lacey and Alex Goodwin and Yannik Marek and Robin Rombach},
+    journal = {ArXiv},
+    year    = {2024},
+    volume  = {abs/2403.03206},
+    url     = {https://api.semanticscholar.org/CorpusID:268247980}
+}
+```
+
+```bibtex
+@article{Li2024ImmiscibleDA,
+    title   = {Immiscible Diffusion: Accelerating Diffusion Training with Noise Assignment},
+    author  = {Yiheng Li and Heyang Jiang and Akio Kodaira and Masayoshi Tomizuka and Kurt Keutzer and Chenfeng Xu},
+    journal = {ArXiv},
+    year    = {2024},
+    volume  = {abs/2406.12303},
+    url     = {https://api.semanticscholar.org/CorpusID:270562607}
+}
+```
+
+```bibtex
+@article{Yang2024ConsistencyFM,
+    title   = {Consistency Flow Matching: Defining Straight Flows with Velocity Consistency},
+    author  = {Ling Yang and Zixiang Zhang and Zhilong Zhang and Xingchao Liu and Minkai Xu and Wentao Zhang and Chenlin Meng and Stefano Ermon and Bin Cui},
+    journal = {ArXiv},
+    year    = {2024},
+    volume  = {abs/2407.02398},
+    url     = {https://api.semanticscholar.org/CorpusID:270878436}
+}
+```
+
+```bibtex
+@article{Zhu2024HyperConnections,
+    title   = {Hyper-Connections},
+    author  = {Defa Zhu and Hongzhi Huang and Zihao Huang and Yutao Zeng and Yunyao Mao and Banggu Wu and Qiyang Min and Xun Zhou},
+    journal = {ArXiv},
+    year    = {2024},
+    volume  = {abs/2409.19606},
+    url     = {https://api.semanticscholar.org/CorpusID:272987528}
+}
+```
+
+```bibtex
+@inproceedings{Sun2025F5RTTSIF,
+    title   = {F5R-TTS: Improving Flow-Matching based Text-to-Speech with Group Relative Policy Optimization},
+    author  = {Xiaohui Sun and Ruitong Xiao and Jianye Mo and Bowen Wu and Qun Yu and Baoxun Wang},
+    year    = {2025},
+    url     = {https://api.semanticscholar.org/CorpusID:277510064}
+}
+```
+
+```bibtex
+@inproceedings{Geng2025MeanFF,
+    title   = {Mean Flows for One-step Generative Modeling},
+    author  = {Zhengyang Geng and Mingyang Deng and Xingjian Bai and J. Zico Kolter and Kaiming He},
+    year    = {2025},
+    url     = {https://api.semanticscholar.org/CorpusID:278769814}
+}
+```
+
+```bibtex
+@article{Sun2025IsNC,
+    title   = {Is Noise Conditioning Necessary for Denoising Generative Models?},
+    author  = {Qiao Sun and Zhicheng Jiang and Hanhong Zhao and Kaiming He},
+    journal = {ArXiv},
+    year    = {2025},
+    volume  = {abs/2502.13129},
+    url     = {https://api.semanticscholar.org/CorpusID:276421559}
+}
+```
+
+```bibtex
+@article{Park2025FlowQ,
+    title   = {Flow Q-Learning},
+    author  = {Seohong Park and Qiyang Li and Sergey Levine},
+    journal = {ArXiv},
+    year    = {2025},
+    volume  = {abs/2502.02538},
+    url     = {https://api.semanticscholar.org/CorpusID:276107180}
+}
+```
+
+```bibtex
+@misc{mcallister2025flowmatchingpolicygradients,
+    title   = {Flow Matching Policy Gradients}, 
+    author  = {David McAllister and Songwei Ge and Brent Yi and Chung Min Kim and Ethan Weber and Hongsuk Choi and Haiwen Feng and Angjoo Kanazawa},
+    year    = {2025},
+    eprint  = {2507.21053},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url     = {https://arxiv.org/abs/2507.21053}, 
+}
+```
+
+```bibtex
+@misc{li2025basicsletdenoisinggenerative,
+    title   = {Back to Basics: Let Denoising Generative Models Denoise}, 
+    author  = {Tianhong Li and Kaiming He},
+    year    = {2025},
+    eprint  = {2511.13720},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.CV},
+    url     = {https://arxiv.org/abs/2511.13720}, 
+}
+```
+
+```bibtex
+@misc{clavier2024bootstrappingexpectilesreinforcementlearning,
+    title   = {Bootstrapping Expectiles in Reinforcement Learning}, 
+    author  = {Pierre Clavier and Emmanuel Rachelson and Erwan Le Pennec and Matthieu Geist},
+    year    = {2024},
+    eprint  = {2406.04081},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url     = {https://arxiv.org/abs/2406.04081}, 
+}
+```
+
+```bibtex
+@inproceedings{anonymous2025flow,
+    title   = {Flow Policy Gradients for Legged Robots},
+    author  = {Anonymous},
+    booktitle = {Submitted to The Fourteenth International Conference on Learning Representations},
+    year    = {2025},
+    url     = {https://openreview.net/forum?id=BA6n0nmagi},
+    note    = {under review}
+}
+```
+
+```bibtex
+@misc{luo2025soflowsolutionflowmodels,
+    title   = {SoFlow: Solution Flow Models for One-Step Generative Modeling}, 
+    author  = {Tianze Luo and Haotian Yuan and Zhuang Liu},
+    year    = {2025},
+    eprint  = {2512.15657},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.LG},
+    url     = {https://arxiv.org/abs/2512.15657}, 
+}
+```