[SDXL] Improve docs by patrickvonplaten · Pull Request #4196 · huggingface/diffusers (original) (raw)

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation7 Commits7 Checks0 Files changed

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

[ Show hidden characters]({{ revealButtonHref }})

What does this PR do?

Adds missing docs for micro conditioning and corrects inpainting example for SD-XL

Before submitting

This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
Did you read the contributor guideline?
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.
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.

Comment on lines 673 to 674

Part of SDXL's micro-conditioning as explained in section 2.2 of [https://huggingface.co/papers/2307.01952\](https://huggingface.co/papers/2307.01952).
If `original_size` is not the same as `target_size` the image will appear to be down- or upsampled. `original_size` defaults to `(width, height)` if not specified.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about shortening it to like the below so it's a bit shorter/easier to read (big ➕ for linking to hf.co/papers!), and I think it'd be clearer to lead with what the parameter does?

Part of SDXL's micro-conditioning as explained in section 2.2 of [https://huggingface.co/papers/2307.01952\](https://huggingface.co/papers/2307.01952).
If `original_size` is not the same as `target_size` the image will appear to be down- or upsampled. `original_size` defaults to `(width, height)` if not specified.
If `original_size` is not the same as `target_size` the image will appear to be down- or upsampled. `original_size` defaults to `(width, height)` if not specified (see [SDXL micro-conditioning](https://huggingface.co/papers/2307.01952) for more details).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Swapped the two sentences - would like to keep the "section 2.2" part so that people don't have to search the whole paper. Let me know what you think :-)