docs(cfm): fix compute_conditional_flow docstring formula (t -> xt in numerator)#179
Merged
atong01 merged 1 commit intoApr 20, 2026
Conversation
… numerator) The docstring claims ut(x1|x0) = (x1 - (1 - sigma) t)/(1 - (1 - sigma)t), but the implementation at line 394 returns (x1 - (1 - sigma) * xt) / (1 - (1 - sigma) * t) which matches Eq.(21) in Lipman et al. (ICLR 2023). Update the docstring summary and the Returns description so the numerator uses xt. Closes atong01#175
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR corrects the docstring formula for TargetConditionalFlowMatcher.compute_conditional_flow so that it matches the actual implementation and the referenced paper, replacing an incorrect use of t in the numerator with xt in both the summary line and the Returns section. File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Owner
|
Thanks for the PR! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
`TargetConditionalFlowMatcher.compute_conditional_flow` (`torchcfm/conditional_flow_matching.py`, lines 370-394) documents the target conditional flow as:
```
ut(x1|x0) = (x1 - (1 - sigma) t)/(1 - (1 - sigma)t)
```
but the implementation returns:
```python
return (x1 - (1 - self.sigma) * xt) / (1 - (1 - self.sigma) * t)
```
which matches Eq.(21) of Lipman et al., ICLR 2023 — the numerator uses the position `xt`, not the time scalar `t`. Updated the summary (line 372) and the Returns description (line 386) so both say:
```
ut(x1|x0) = (x1 - (1 - sigma) xt)/(1 - (1 - sigma)t)
```
Closes #175
Testing
Docstring-only change; no runtime paths touched.
Summary by Sourcery
Documentation: