Skip to content

[Docs] Improve docs #1870

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.

Sign up for GitHub

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

Merged
patrickvonplaten merged 2 commits into from
Dec 30, 2022
Merged

[Docs] Improve docs #1870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b0b10d
[Docs] Improve docs
patrickvonplaten Dec 30, 2022
685bfa8
up
patrickvonplaten Dec 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/source/api/diffusion_pipeline.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,17 @@ Any pipeline object can be saved locally with [`~DiffusionPipeline.save_pretrain

## DiffusionPipeline
[[autodoc]] DiffusionPipeline
- from_pretrained
Copy link
Contributor Author

@patrickvonplaten patrickvonplaten Dec 30, 2022

Choose a reason for hiding this comment

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

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

- save_pretrained
- to
- all
- __call__
- device
- components
- to

## ImagePipelineOutput
By default diffusion pipelines return an object of class

[[autodoc]] pipelines.ImagePipelineOutput

## AudioPipelineOutput
By default diffusion pipelines return an object of class

[[autodoc]] pipelines.AudioPipelineOutput
8 changes: 4 additions & 4 deletions docs/source/api/pipelines/alt_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,15 @@ If you want to use all possible use cases in a single `DiffusionPipeline` we rec

## AltDiffusionPipelineOutput
[[autodoc]] pipelines.alt_diffusion.AltDiffusionPipelineOutput
- all
- __call__

## AltDiffusionPipeline
[[autodoc]] AltDiffusionPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing

## AltDiffusionImg2ImgPipeline
[[autodoc]] AltDiffusionImg2ImgPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
8 changes: 2 additions & 6 deletions docs/source/api/pipelines/audio_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,8 @@ display(Audio(output.audios[0], rate=pipe.mel.get_sample_rate()))

## AudioDiffusionPipeline
[[autodoc]] AudioDiffusionPipeline
- __call__
- encode
- slerp

- all
- __call__

## Mel
[[autodoc]] Mel
- audio_slice_to_image
- image_to_audio
1 change: 1 addition & 0 deletions docs/source/api/pipelines/cycle_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,5 @@ image.save("black_to_blue.png")

## CycleDiffusionPipeline
[[autodoc]] CycleDiffusionPipeline
- all
- __call__
3 changes: 2 additions & 1 deletion docs/source/api/pipelines/dance_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,5 @@ The original codebase of this implementation can be found [here](https://github.

## DanceDiffusionPipeline
[[autodoc]] DanceDiffusionPipeline
- __call__
- all
- __call__
3 changes: 2 additions & 1 deletion docs/source/api/pipelines/ddim.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ For questions, feel free to contact the author on [tsong.me](https://tsong.me/).

## DDIMPipeline
[[autodoc]] DDIMPipeline
- __call__
- all
- __call__
3 changes: 2 additions & 1 deletion docs/source/api/pipelines/ddpm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ The original codebase of this paper can be found [here](https://github.com/hojon

# DDPMPipeline
[[autodoc]] DDPMPipeline
- __call__
- all
- __call__
6 changes: 4 additions & 2 deletions docs/source/api/pipelines/latent_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,10 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff

## LDMTextToImagePipeline
[[autodoc]] LDMTextToImagePipeline
- __call__
- all
- __call__

## LDMSuperResolutionPipeline
[[autodoc]] LDMSuperResolutionPipeline
- __call__
- all
- __call__
3 changes: 2 additions & 1 deletion docs/source/api/pipelines/latent_diffusion_uncond.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff

## LDMPipeline
[[autodoc]] LDMPipeline
- __call__
- all
- __call__
5 changes: 3 additions & 2 deletions docs/source/api/pipelines/paint_by_example.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,6 @@ image
```

## PaintByExamplePipeline
[[autodoc]] pipelines.paint_by_example.pipeline_paint_by_example.PaintByExamplePipeline
- __call__
[[autodoc]] PaintByExamplePipeline
- all
- __call__
6 changes: 3 additions & 3 deletions docs/source/api/pipelines/pndm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ The original codebase can be found [here](https://github.com/luping-liu/PNDM).


## PNDMPipeline
[[autodoc]] pipelines.pndm.pipeline_pndm.PNDMPipeline
- __call__

[[autodoc]] PNDMPipeline
- all
- __call__
6 changes: 3 additions & 3 deletions docs/source/api/pipelines/repaint.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ inpainted_image = output.images[0]
```

## RePaintPipeline
[[autodoc]] pipelines.repaint.pipeline_repaint.RePaintPipeline
- __call__

[[autodoc]] RePaintPipeline
- all
- __call__
4 changes: 2 additions & 2 deletions docs/source/api/pipelines/score_sde_ve.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ This pipeline implements the Variance Expanding (VE) variant of the method.

## ScoreSdeVePipeline
[[autodoc]] ScoreSdeVePipeline
- __call__

- all
- __call__
11 changes: 8 additions & 3 deletions docs/source/api/pipelines/stable_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,18 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca

## StableDiffusionPipeline
[[autodoc]] StableDiffusionPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
- enable_vae_slicing
- disable_vae_slicing
- enable_xformers_memory_efficient_attention
- disable_xformers_memory_efficient_attention



## StableDiffusionImg2ImgPipeline
[[autodoc]] StableDiffusionImg2ImgPipeline
- all
- __call__
- enable_attention_slicing
Copy link
Contributor Author

@patrickvonplaten patrickvonplaten Dec 30, 2022

Choose a reason for hiding this comment

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

exceptionally I'm duplicating all those enable_attention_slicing from DiffusionPipeline here since this doc page is viewed a lot.

- disable_attention_slicing
Expand All @@ -91,6 +93,7 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca

## StableDiffusionInpaintPipeline
[[autodoc]] StableDiffusionInpaintPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
Expand All @@ -99,6 +102,7 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca

## StableDiffusionDepth2ImgPipeline
[[autodoc]] StableDiffusionDepth2ImgPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
Expand All @@ -107,15 +111,16 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca

## StableDiffusionImageVariationPipeline
[[autodoc]] StableDiffusionImageVariationPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
- enable_xformers_memory_efficient_attention
- disable_xformers_memory_efficient_attention


## StableDiffusionUpscalePipeline
[[autodoc]] StableDiffusionUpscalePipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
Expand Down
6 changes: 3 additions & 3 deletions docs/source/api/pipelines/stable_diffusion_safe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ To use a different scheduler, you can either change it via the [`ConfigMixin.fro

## StableDiffusionSafePipelineOutput
[[autodoc]] pipelines.stable_diffusion_safe.StableDiffusionSafePipelineOutput
- all
- __call__

## StableDiffusionPipelineSafe
[[autodoc]] StableDiffusionPipelineSafe
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing

3 changes: 2 additions & 1 deletion docs/source/api/pipelines/stochastic_karras_ve.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,5 @@ This pipeline implements the Stochastic sampling tailored to the Variance-Expand

## KarrasVePipeline
[[autodoc]] KarrasVePipeline
- __call__
- all
- __call__
12 changes: 8 additions & 4 deletions docs/source/api/pipelines/unclip.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,14 @@ The unCLIP model in diffusers comes from kakaobrain's karlo and the original cod
| Pipeline | Tasks | Colab
|---|---|:---:|
| [pipeline_unclip.py](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/unclip/pipeline_unclip.py) | *Text-to-Image Generation* | - |
| [pipeline_unclip_image_variation.py](https://github.com/huggingface/diffusers/blob/main/src/diffusers/pipelines/unclip/pipeline_unclip_image_variation.py) | *Image-Guided Image Generation* | - |


## UnCLIPPipeline
[[autodoc]] pipelines.unclip.pipeline_unclip.UnCLIPPipeline
- __call__
[[autodoc]] pipelines.unclip.pipeline_unclip_image_variation.UnCLIPImageVariationPipeline
- __call__
[[autodoc]] UnCLIPPipeline
- all
- __call__

[[autodoc]] UnCLIPImageVariationPipeline
- all
- __call__
9 changes: 3 additions & 6 deletions docs/source/api/pipelines/versatile_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,15 @@ To use a different scheduler, you can either change it via the [`ConfigMixin.fro

## VersatileDiffusionTextToImagePipeline
[[autodoc]] VersatileDiffusionTextToImagePipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing

## VersatileDiffusionImageVariationPipeline
[[autodoc]] VersatileDiffusionImageVariationPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing

## VersatileDiffusionDualGuidedPipeline
[[autodoc]] VersatileDiffusionDualGuidedPipeline
- all
- __call__
- enable_attention_slicing
- disable_attention_slicing
5 changes: 3 additions & 2 deletions docs/source/api/pipelines/vq_diffusion.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ The original codebase can be found [here](https://github.com/microsoft/VQ-Diffus


## VQDiffusionPipeline
[[autodoc]] pipelines.vq_diffusion.pipeline_vq_diffusion.VQDiffusionPipeline
- __call__
[[autodoc]] VQDiffusionPipeline
- all
- __call__