diffusers icon indicating copy to clipboard operation
diffusers copied to clipboard

Fix wrong param types, docs, and handles noise=None in scale_noise of FlowMatching schedulers

Open Promisery opened this issue 8 months ago • 1 comments

What does this PR do?

In the scale_noise functions of all flow matching schedulers, the definitions and docs are wrong:

  • timestep should be a torch.FloatTensor, not a float or int
  • noise is not included in the document

Also, noise should be a required arg

Before submitting

  • [x] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • [x] Did you read the contributor guideline?
  • [x] Did you read our philosophy doc (important for complex PRs)?
  • [ ] Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
  • [x] Did you make sure to update the documentation with your changes? Here are the documentation guidelines, and here are tips on formatting docstrings.
  • [ ] Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag members/contributors who may be interested in your PR.

@yiyixuxu

Promisery avatar Jun 06 '25 03:06 Promisery

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.