Skip to main content

Flow Matching with BDTs

Project description

Docs

Flow-Matching BDT

A small library for training flow-matching models. Its primary focus is using efficient algorithms for tabular learning — e.g. histogram boosted-decision trees — but it works with any scikit-learn compatible regressor.

Installation

pip install flowmatching-bdt

Quick Start

from sklearn.datasets import make_moons
from flowmatching_bdt import FlowMatchingBDT

data, _ = make_moons(n_samples=500, noise=0.1, random_state=0)
model = FlowMatchingBDT()

# train the model
model.fit(data)

# generate new samples
samples = model.predict(num_samples=500)

Conditional Generation

import numpy as np
from sklearn.datasets import make_moons
from flowmatching_bdt import FlowMatchingBDT

data, labels = make_moons(n_samples=500, noise=0.1, random_state=42)
model = FlowMatchingBDT()

model.fit(data, conditions=labels)

conditions = np.ones(500)
samples = model.predict(num_samples=500, conditions=conditions)

How It Works

Flow matching trains a model to predict a velocity field that transports samples from a simple source distribution (e.g. Gaussian noise) to the data distribution. This implementation:

  1. Discretises the flow into n_flow_steps time steps
  2. Trains one regressor per step to predict the velocity field
  3. At inference, integrates the learned field using Euler steps to generate new samples

Gradient-boosted trees can learn this velocity field just as well as neural networks, while being faster to train on tabular data.

Useful Resources

Citation

This repository started as a reproduction of the following paper:

@inproceedings{jolicoeur2024generating,
  title={Generating and Imputing Tabular Data via Diffusion and Flow-based Gradient-Boosted Trees},
  author={Jolicoeur-Martineau, Alexia and Fatras, Kilian and Kachman, Tal},
  booktitle={International Conference on Artificial Intelligence and Statistics},
  pages={1288--1296},
  year={2024},
  organization={PMLR}
}

Acknowledgements

This repository is inspired heavily and borrows parts from lucidrains (project structure) and torch-cfm.

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

flowmatching_bdt-0.3.0.tar.gz (19.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flowmatching_bdt-0.3.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file flowmatching_bdt-0.3.0.tar.gz.

File metadata

  • Download URL: flowmatching_bdt-0.3.0.tar.gz
  • Upload date:
  • Size: 19.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flowmatching_bdt-0.3.0.tar.gz
Algorithm Hash digest
SHA256 422f0540c4c94eb2cbca281aee0c801e885c26496c592819b622d12c2d14a6e7
MD5 fe14f1f519c452c146b79d1547eb37f4
BLAKE2b-256 0ce3df23eea342d5c7c3a1c5125961544c5bb552dc92cbe68f1f2b1fe3e1ed83

See more details on using hashes here.

File details

Details for the file flowmatching_bdt-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flowmatching_bdt-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed66ae95468ae958b4a690c2209ae149d61213e4dac9d3c8cf0a56d8dfd8e090
MD5 746eb54585b934b95a515cefb7827531
BLAKE2b-256 8259f9003d5a07a32d69cb649ce1e6cfd83332f3a5b6d1ed0f85bad9a3677218

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