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] General updates #5378

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Conversation

stevhliu
Copy link
Member

Implements some of the easier improvements that we discussed:

  • updates the supported pipelines table and move it from the index to the pipelines overview
  • removes the duplicate DiffusionPipeline API page here because it is already documented in the pipelines overview
  • adds a brief section about caching and how to use if offline
  • updates the community pipelines doc with some more interesting examples that work (open to showcasing other community pipelines here)

@@ -1,36 +0,0 @@
<!--Copyright 2023 The HuggingFace Team. All rights reserved.
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm where is the diffusion pipeline now shown instead? The DiffusionPipeline is a very important object no?

Copy link
Member Author

Choose a reason for hiding this comment

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

The diffusion pipeline is shown here with the pipeline overview similar to how we show the base scheduler/model classes on their overview pages.

| [DiffEdit](diffedit) | inpainting |
| [DiT](dit) | text2image |
| [GLIGEN](gligen) | text2image |
| [InstructPix2Pix](pix2pix) | image editing |
Copy link
Member

Choose a reason for hiding this comment

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

Seems like we're missing DeepFloyd's IF.

Copy link
Member Author

Choose a reason for hiding this comment

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

DeepFloyd IF should be on line 42 :)


| Example | Description | Code Example | Colab | Author |
Copy link
Member

Choose a reason for hiding this comment

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

Does it make sense to have the table? Gives a nice overview no?

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 more lightweight to let the table here provide the overview, and we can keep a link to it from the docs.

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.

Thanks for changes!


<Tip>

You shouldn't use the [`DiffusionPipeline`] class for training or finetuning a diffusion model. Individual
Copy link
Contributor

Choose a reason for hiding this comment

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

Could it make sense to move this Tip over or the other Diffusion Pipeline doc? It's a bit different from what is there already, but might be useful!

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 24, 2023

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

@stevhliu stevhliu merged commit 7c3a75a into huggingface:main Oct 24, 2023
11 checks passed
@stevhliu stevhliu deleted the docs-improvements branch October 24, 2023 18:52
kashif pushed a commit to kashif/diffusers that referenced this pull request Nov 11, 2023
* first draft

* feedback

* feedback
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
* first draft

* feedback

* feedback
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.

4 participants