-
Notifications
You must be signed in to change notification settings - Fork 5.3k
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 and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] SDXL #4428
[docs] SDXL #4428
Conversation
The documentation is not available anymore as the PR was closed or merged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking amazing!
I would maybe give a better title to the doc that shows how to use SDXL (the one that lives under using-diffusers
).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense to make. Just wondering how we should structure using-diffusers
then because lots of pipeline code will go there no? Should we maybe consider creating a new section that is called "Using specific pipelines"?
Like the idea generally, I wonder whether we can even split "tasks" and "techniques" into seperate sections. Would love to get @pcuenca input here as well |
Makes a lot of sense to me. But I also fear if it would make the reader experience difficult to navigate. |
Updated the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of moving out lots of our example code from the API. Happy to start with SDXL and then move towards other models
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do agree with the philosophy to keep the API docs more lightweight and create usage guides. Had some comments/questions about the structure and a few minor suggestions to the guide's contents.
docs/source/en/_toctree.yml
Outdated
- local: using-diffusers/stable_diffusion_jax_how_to | ||
title: Stable Diffusion in JAX/Flax |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a bit too prominent at the top of the sidebar. Maybe move to Optimization/Special Hardware
? (Side note: that section has grown a bit, maybe it's time to rename/reorganize?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good to me, I'll move it to Optimization/Special Hardware
for now and we can reorganize it in a separate PR?
docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.md
Outdated
Show resolved
Hide resolved
docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.md
Outdated
Show resolved
Hide resolved
|
||
<Tip> | ||
|
||
The refiner can also very well be used in an in-painting setting. To do so just make | ||
sure you use the [`StableDiffusionXLInpaintPipeline`] classes as shown below | ||
Check out the [Stability AI](https://huggingface.co/stabilityai) Hub organization for the official base and refiner model checkpoints! To learn how to use [`StableDiffusionXLPipeline`] for various tasks, how to optimize performance, and other usage examples, take a look at the [Stable Diffusion XL](/using-diffusers/sdxl) guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd maybe move the checkpoints link to the guide instead. This way the tip just focuses on a single thing (the usage guide).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's ok for the tip to do both; as a reference page, I think it makes more sense to provide a link here for where you can look up the official checkpoints.
If it's ok for everyone, I'll merge this tomorrow so we can have the standalone SDXL guide and the new docs structure (different sections for tasks, techniques, and pipelines)! 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to make the conditioning explanations clearer, more eyes are welcome to verify I did not suggest anything inaccurate.
docs/source/en/api/pipelines/stable_diffusion/stable_diffusion_xl.md
Outdated
Show resolved
Hide resolved
* first draft * reorg toctree * note about minsdxl * feedback * fix * micro-conditionings * add tip * fix section levels * d'oh fix pipeline names * feedback * remove old section
As discussed internally here, this PR makes the SDXL API docs more lightweight and aligned with its purpose as "reference" material for users to refer to. All the how-to instructions have been moved to a separate standalone guide.