Skip to content
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

Merged
merged 11 commits into from
Aug 30, 2023
Merged

[docs] SDXL #4428

merged 11 commits into from
Aug 30, 2023

Conversation

stevhliu
Copy link
Member

@stevhliu stevhliu commented Aug 1, 2023

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.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Aug 1, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Member

@sayakpaul sayakpaul left a 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).

Copy link
Contributor

@patrickvonplaten patrickvonplaten left a 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"?

@stevhliu
Copy link
Member Author

stevhliu commented Aug 2, 2023

What if we create a "Tasks and techniques" section and a "Pipeline guides" section like below (we can move Stable Diffusion in JAX/Flax to maybe the "Getting Started" section):

Capture-2023-08-02-101823

@patrickvonplaten
Copy link
Contributor

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

@sayakpaul
Copy link
Member

I wonder whether we can even split "tasks" and "techniques" into seperate sections.

Makes a lot of sense to me. But I also fear if it would make the reader experience difficult to navigate.

@stevhliu
Copy link
Member Author

Updated the toctree to reflect the split between "Tasks" and "Techniques"; I think it looks pretty clean and still easy to navigate!

Copy link
Contributor

@patrickvonplaten patrickvonplaten left a 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

Copy link
Member

@pcuenca pcuenca left a 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.

Comment on lines 6 to 7
- local: using-diffusers/stable_diffusion_jax_how_to
title: Stable Diffusion in JAX/Flax
Copy link
Member

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?)

Copy link
Member Author

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/_toctree.yml 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.
Copy link
Member

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).

Copy link
Member Author

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.

docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
@stevhliu stevhliu marked this pull request as ready for review August 29, 2023 19:25
@stevhliu
Copy link
Member Author

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)! 😄

Copy link
Member

@pcuenca pcuenca left a 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/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
docs/source/en/using-diffusers/sdxl.md Outdated Show resolved Hide resolved
@stevhliu stevhliu merged commit a1fdfca into huggingface:main Aug 30, 2023
9 checks passed
@stevhliu stevhliu deleted the sdxl-docs branch August 30, 2023 15:34
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants