Skip to content

Commit 3c53331

Browse files
authored
Improve README clarity
1 parent f2b33c4 commit 3c53331

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ Flowfusion.jl is a Julia package for training and sampling from diffusion and fl
99

1010
![Image](https://github.com/user-attachments/assets/ff7f25e6-441d-4840-ac9c-a849e7b57aa7)
1111

12-
The animated logo shows samples from a model trained to jointly transport a 2D point and an angular hue between two distributions. For the 2D point, the left side uses "Flow matching" with deterministic trajectories, and the right uses a Brownian bridge. For both sides, the angular hue is diffused via an angular Brownian bridge. The hue endpoints are antipodal, and you can see both paths, in opposite angular directions, are sampled.
12+
The animated logo shows samples from a model trained to jointly transport a 2D point and an angular hue between two distributions. For the 2D point, the left side uses Flow matching with deterministic trajectories, and the right uses a Brownian bridge. For both sides, the angular hue is diffused via an angular Brownian bridge. The hue endpoints are antipodal, and you can see both paths, in opposite angular directions, are sampled.
1313

1414
## Features
1515

1616
- Flexible initial $X_0$ distribution
1717
- Conditioning via masking
1818
- States: Continuous, discrete, and a wide variety of manifolds supported (via [Manifolds.jl](https://github.com/JuliaManifolds/Manifolds.jl))
1919
- Compound states supported (e.g. jointly sampling from both continuous and discrete variables)
20-
- Controllable noise (or fully deterministic for flow matching)
20+
- Controllable noise (or fully deterministic paths)
2121
- Time-scaling schedules (see `examples/logo_example.jl`)
2222

2323
### Basic idea:
2424
- Generate `X0` and `X1` states from your favorite distribution, and a random `t` between 0 and 1
2525
- `Xt = bridge(P, X0, X1, t)`: Sample intermediate states conditioned on start and end states
26-
- Train model to predict how to get to `X1` from `Xt`
26+
- Train model to predict how to move towards `X1` from `Xt`
2727
- `gen(P, X0, model, steps)`: Generate sequences using a learned model
2828

2929
## Examples
@@ -146,7 +146,7 @@ scatter!(samples.state[1,:],samples.state[2,:], msw = 0, ms = 1, color = "green"
146146

147147
These can be found in [examples](https://github.com/MurrellGroup/Flowfusion.jl/tree/main/examples).
148148

149-
### Flow matching
149+
### Deterministic Flow matching
150150

151151
with `P = Deterministic()`
152152

@@ -158,7 +158,7 @@ with `P = Deterministic()` and `X0 = ManifoldState(Torus(2), ...)`
158158

159159
![Image](https://github.com/user-attachments/assets/b6a1a27f-f0fc-4bc4-af10-bb8b5e7aa8cf)
160160

161-
### Diffusion on a manifold
161+
### Brownian Bridge Flow Matching on a manifold
162162

163163
with `P = ManifoldProcess(0.2)` and `X0 = ManifoldState(Torus(2), ...)`:
164164

@@ -176,7 +176,7 @@ with `X0 = MaskedState(state, cmask, lmask)`
176176

177177
![Image](https://github.com/user-attachments/assets/e3e84290-2a57-4d2d-8ebc-ad91800e8fea)
178178

179-
### Discrete distributions via diffusion on the probability simplex
179+
### Discrete distributions via Brownian bridge flow matching on the probability simplex
180180

181181
with `P = ManifoldProcess(0.5)` and `X0 = ManifoldState(ProbabilitySimplex(32), ...)`:
182182

0 commit comments

Comments
 (0)