[Docs] Improve docs #1870
Merged
[Docs] Improve docs #1870
Conversation
This file contains 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
| @@ -30,11 +30,6 @@ Any pipeline object can be saved locally with [`~DiffusionPipeline.save_pretrain | |||
|
|
|||
| ## DiffusionPipeline | |||
| [[autodoc]] DiffusionPipeline | |||
| - from_pretrained | |||
There was a problem hiding this comment.
@yiyixuxu @williamberman @patil-suraj @pcuenca @anton-l Let's make sure to never add any methods here actually because it means that only those methods are shown. If we don't add any methods, we simply show all public methods by default which is much better IMO.
|
The documentation is not available anymore as the PR was closed or merged. |
| ## StableDiffusionImg2ImgPipeline | ||
| [[autodoc]] StableDiffusionImg2ImgPipeline | ||
| - all | ||
| - __call__ | ||
| - enable_attention_slicing |
There was a problem hiding this comment.
exceptionally I'm duplicating all those enable_attention_slicing from DiffusionPipeline here since this doc page is viewed a lot.
yiyixuxu
pushed a commit
to yiyixuxu/diffusers
that referenced
this pull request
Jan 2, 2023
yiyixuxu
added a commit
that referenced
this pull request
Jan 2, 2023
* add a doc page for each pipeline under api/pipelines/stable_diffusion * add pipeline examples to docstrings * updated stable_diffusion_2 page * updated default markdown syntax to list methods based on #1870 * add function decorator Co-authored-by: yiyixuxu <yixu@Yis-MacBook-Pro.lan> Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
yoonseokjin
pushed a commit
to yoonseokjin/diffusers
that referenced
this pull request
Dec 25, 2023
* add a doc page for each pipeline under api/pipelines/stable_diffusion * add pipeline examples to docstrings * updated stable_diffusion_2 page * updated default markdown syntax to list methods based on huggingface#1870 * add function decorator Co-authored-by: yiyixuxu <yixu@Yis-MacBook-Pro.lan> Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com>
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.
Make sure docs always show all methods.
Here some very nice documentation of how the
doc-builderbehaves: https://github.com/huggingface/doc-builder#writing-api-documentationSee differences between:
Using:
is important to not "suppress" other methods. So by default, we should just always use: