Initial commit

.flake8

@@ -0,0 +1,26 @@
+[flake8]
+extend-ignore =
+    B006
+    B007
+    B008
+    B010
+    B023
+    B028
+    B601
+    C403
+    C405
+    C408
+    C416
+    C417
+    C419
+    E203
+    E402
+    E501
+    E731
+    W391
+    W605
+exclude=build,notebooks,protobuf
+
+# ignore unused imports in __init__.py files
+per-file-ignores =
+    __init__.py:F401 

.github/workflows/ci.yaml

@@ -0,0 +1,59 @@
+name: CI
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: mamba-org/[email protected]
+        with:
+          environment-file: environment.yml
+          cache-environment: true
+
+      - name: Check formatting
+        shell: bash -l {0}
+        run: |
+          ufmt check flow_matching/ examples/
+
+      - name: flake8 lint
+        shell: bash -l {0}
+        run: |
+          flake8 flow_matching
+
+      - name: Run tests
+        shell: bash -l {0}
+        run: |
+          coverage run --include='flow_matching/**/*.py' -m unittest discover tests -v
+
+      - name: Docstring Lint
+        shell: bash -l {0}
+        run: |
+          pydoclint --style=google flow_matching
+
+      - name: Build doc pages
+        shell: bash -l {0}
+        working-directory: docs
+        run: |
+          micromamba env update --file deps.yml
+          PYTHONPATH=../:. make html
+
+      - name: coverage
+        shell: bash -l {0}
+        run: |
+          pip install coverage-badge
+          coverage html --include='flow_matching/**/*.py' -d docs/build/html/coverage
+          coverage-badge -o docs/build/html/coverage/coverage-badge.svg
+          rm docs/build/html/coverage/.gitignore
+
+      - name: Deploy docs to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/coverage'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html

.gitignore

@@ -0,0 +1,73 @@
+# 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
+
+# VSCode
+*.vscode
+
+# Others
+examples/image_generation/data
+examples/*/output_dir*
+examples/image/scripts
+examples/image/outputs
+examples/image/data
+examples/image/output_dir
+examples/images/*
+examples/imagenet/*
+examples/image_generation/*
+examples/*.ignore
+examples/*/snapshots*
+examples/*/outputs
+
+examples/imagenet/scripts
+*.ipynb_checkpoints*
+
+make.bat
+docs/output
+docs/source/generated
+docs/source/notebooks
+docs/source/images
+**/*.ipynb_checkpoints/
+
+projects/image_latent/cache
+projects/image_latent/vqvae_training/cache
+projects/image_latent/outputs
+*/assets/
+
+outputs/
+output_dir/
+
+*logs/
+*mixture_uniform_step=320001/
+*.out
+*.err

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/omnilib/ufmt
+    rev: v2.3.0
+    hooks:
+      - id: ufmt
+        additional_dependencies:
+          - black == 22.6.0
+          - usort == 1.0.4
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.0.0
+    hooks:
+    - id: flake8
+  - repo: https://github.com/jsh9/pydoclint
+    rev: 0.5.9
+    hooks:
+      - id: pydoclint
+        args: [--style=google, flow_matching]

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change log
+
+## [0.1] - 2024-12-01
+
+- Initial release.

CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+This Code of Conduct also applies outside the project spaces when there is a
+reasonable belief that an individual's behavior may have a negative impact on
+the project or its community.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <[email protected]>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to flow_matching
+We want to make contributing to this project as easy and transparent as
+possible.
+
+
+## Pull Requests
+We actively welcome your pull requests.
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. If you haven't already, complete the Contributor License Agreement ("CLA").
+
+## Contributor License Agreement ("CLA")
+In order to accept your pull request, we need you to submit a CLA. You only need
+to do this once to work on any of Meta's open source projects.
+
+Complete your CLA here: <https://code.facebook.com/cla>
+
+## Issues
+We use GitHub issues to track public bugs. Please ensure your description is
+clear and has sufficient instructions to be able to reproduce the issue.
+
+## License
+By contributing to flow_matching, you agree that your contributions will be licensed
+under the LICENSE file in the root directory of this source tree.