[docs] Add note in UniDiffusers Doc about PyTorch 1.X numerical stability issue #4703
Conversation
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
stevhliu
approved these changes
Aug 21, 2023
Comment on lines
23
to
26
| Tips: | ||
|
|
||
| - There is currently an issue on PyTorch 1.X where the output images are all black or the pixel values become `NaNs`. This issue can be mitigated by switching to PyTorch 2.X. | ||
|
|
There was a problem hiding this comment.
The doc-builder has a warning callout that is suited for a situation like this :)
Suggested change
| Tips: | |
| - There is currently an issue on PyTorch 1.X where the output images are all black or the pixel values become `NaNs`. This issue can be mitigated by switching to PyTorch 2.X. | |
| <Tip warning={true}> | |
| There is currently an issue on PyTorch 1.X where the output images are all black, or the pixel values become `NaNs`. This issue can be temporarily resolved by switching to PyTorch 2.X until a more permanent fix is implemented. | |
| </Tip> |
There was a problem hiding this comment.
Updated the docs to use the warning callout.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
dg845
changed the title
AmericanPresidentJimmyCarter
pushed a commit
to AmericanPresidentJimmyCarter/diffusers
that referenced
this pull request
Apr 26, 2024
…lity issue (huggingface#4703) * Add note regarding UniDiffuser pipeline numerical stability issues on PyTorch 1.X * Use the doc-builder warning tag.
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.
What does this PR do?
This PR modifies the
UniDiffuserPipelinedocs to add a note regarding the fact that the UniDiffuser pipeline currently has numerical stability issues on PyTorch 1.X, which causes the output images to become allNaNs or all black. This issue can be mitigated by switching to PyTorch 2.X.I will try to open a PR to address this issue in the near future, but in the meantime I think it makes sense to note this in the docs until the issue is fixed.
Addresses #3951.
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
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.
@patrickvonplaten
@sayakpaul