Unverified Commit ac373846 authored by Patrick von Platen's avatar Patrick von Platen Committed by GitHub
Browse files

[Docs] Improve docs (#1870)

* [Docs] Improve docs

* up
parent a6e2c1fe
...@@ -30,13 +30,17 @@ Any pipeline object can be saved locally with [`~DiffusionPipeline.save_pretrain ...@@ -30,13 +30,17 @@ Any pipeline object can be saved locally with [`~DiffusionPipeline.save_pretrain
## DiffusionPipeline ## DiffusionPipeline
[[autodoc]] DiffusionPipeline [[autodoc]] DiffusionPipeline
- from_pretrained - all
- save_pretrained - __call__
- to
- device - device
- components - to
## ImagePipelineOutput ## ImagePipelineOutput
By default diffusion pipelines return an object of class By default diffusion pipelines return an object of class
[[autodoc]] pipelines.ImagePipelineOutput [[autodoc]] pipelines.ImagePipelineOutput
## AudioPipelineOutput
By default diffusion pipelines return an object of class
[[autodoc]] pipelines.AudioPipelineOutput
...@@ -69,15 +69,15 @@ If you want to use all possible use cases in a single `DiffusionPipeline` we rec ...@@ -69,15 +69,15 @@ If you want to use all possible use cases in a single `DiffusionPipeline` we rec
## AltDiffusionPipelineOutput ## AltDiffusionPipelineOutput
[[autodoc]] pipelines.alt_diffusion.AltDiffusionPipelineOutput [[autodoc]] pipelines.alt_diffusion.AltDiffusionPipelineOutput
- all
- __call__
## AltDiffusionPipeline ## AltDiffusionPipeline
[[autodoc]] AltDiffusionPipeline [[autodoc]] AltDiffusionPipeline
- all
- __call__ - __call__
- enable_attention_slicing
- disable_attention_slicing
## AltDiffusionImg2ImgPipeline ## AltDiffusionImg2ImgPipeline
[[autodoc]] AltDiffusionImg2ImgPipeline [[autodoc]] AltDiffusionImg2ImgPipeline
- all
- __call__ - __call__
- enable_attention_slicing
- disable_attention_slicing
...@@ -91,12 +91,8 @@ display(Audio(output.audios[0], rate=pipe.mel.get_sample_rate())) ...@@ -91,12 +91,8 @@ display(Audio(output.audios[0], rate=pipe.mel.get_sample_rate()))
## AudioDiffusionPipeline ## AudioDiffusionPipeline
[[autodoc]] AudioDiffusionPipeline [[autodoc]] AudioDiffusionPipeline
- __call__ - all
- encode - __call__
- slerp
## Mel ## Mel
[[autodoc]] Mel [[autodoc]] Mel
- audio_slice_to_image
- image_to_audio
...@@ -96,4 +96,5 @@ image.save("black_to_blue.png") ...@@ -96,4 +96,5 @@ image.save("black_to_blue.png")
## CycleDiffusionPipeline ## CycleDiffusionPipeline
[[autodoc]] CycleDiffusionPipeline [[autodoc]] CycleDiffusionPipeline
- all
- __call__ - __call__
...@@ -30,4 +30,5 @@ The original codebase of this implementation can be found [here](https://github. ...@@ -30,4 +30,5 @@ The original codebase of this implementation can be found [here](https://github.
## DanceDiffusionPipeline ## DanceDiffusionPipeline
[[autodoc]] DanceDiffusionPipeline [[autodoc]] DanceDiffusionPipeline
- __call__ - all
- __call__
...@@ -32,4 +32,5 @@ For questions, feel free to contact the author on [tsong.me](https://tsong.me/). ...@@ -32,4 +32,5 @@ For questions, feel free to contact the author on [tsong.me](https://tsong.me/).
## DDIMPipeline ## DDIMPipeline
[[autodoc]] DDIMPipeline [[autodoc]] DDIMPipeline
- __call__ - all
- __call__
...@@ -33,4 +33,5 @@ The original codebase of this paper can be found [here](https://github.com/hojon ...@@ -33,4 +33,5 @@ The original codebase of this paper can be found [here](https://github.com/hojon
# DDPMPipeline # DDPMPipeline
[[autodoc]] DDPMPipeline [[autodoc]] DDPMPipeline
- __call__ - all
- __call__
...@@ -40,8 +40,10 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff ...@@ -40,8 +40,10 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff
## LDMTextToImagePipeline ## LDMTextToImagePipeline
[[autodoc]] LDMTextToImagePipeline [[autodoc]] LDMTextToImagePipeline
- __call__ - all
- __call__
## LDMSuperResolutionPipeline ## LDMSuperResolutionPipeline
[[autodoc]] LDMSuperResolutionPipeline [[autodoc]] LDMSuperResolutionPipeline
- __call__ - all
- __call__
...@@ -38,4 +38,5 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff ...@@ -38,4 +38,5 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff
## LDMPipeline ## LDMPipeline
[[autodoc]] LDMPipeline [[autodoc]] LDMPipeline
- __call__ - all
- __call__
...@@ -69,5 +69,6 @@ image ...@@ -69,5 +69,6 @@ image
``` ```
## PaintByExamplePipeline ## PaintByExamplePipeline
[[autodoc]] pipelines.paint_by_example.pipeline_paint_by_example.PaintByExamplePipeline [[autodoc]] PaintByExamplePipeline
- __call__ - all
- __call__
...@@ -30,6 +30,6 @@ The original codebase can be found [here](https://github.com/luping-liu/PNDM). ...@@ -30,6 +30,6 @@ The original codebase can be found [here](https://github.com/luping-liu/PNDM).
## PNDMPipeline ## PNDMPipeline
[[autodoc]] pipelines.pndm.pipeline_pndm.PNDMPipeline [[autodoc]] PNDMPipeline
- __call__ - all
- __call__
...@@ -72,6 +72,6 @@ inpainted_image = output.images[0] ...@@ -72,6 +72,6 @@ inpainted_image = output.images[0]
``` ```
## RePaintPipeline ## RePaintPipeline
[[autodoc]] pipelines.repaint.pipeline_repaint.RePaintPipeline [[autodoc]] RePaintPipeline
- __call__ - all
- __call__
...@@ -32,5 +32,5 @@ This pipeline implements the Variance Expanding (VE) variant of the method. ...@@ -32,5 +32,5 @@ This pipeline implements the Variance Expanding (VE) variant of the method.
## ScoreSdeVePipeline ## ScoreSdeVePipeline
[[autodoc]] ScoreSdeVePipeline [[autodoc]] ScoreSdeVePipeline
- __call__ - all
- __call__
...@@ -73,16 +73,18 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca ...@@ -73,16 +73,18 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca
## StableDiffusionPipeline ## StableDiffusionPipeline
[[autodoc]] StableDiffusionPipeline [[autodoc]] StableDiffusionPipeline
- all
- __call__ - __call__
- enable_attention_slicing - enable_attention_slicing
- disable_attention_slicing - disable_attention_slicing
- enable_vae_slicing
- disable_vae_slicing
- enable_xformers_memory_efficient_attention - enable_xformers_memory_efficient_attention
- disable_xformers_memory_efficient_attention - disable_xformers_memory_efficient_attention
## StableDiffusionImg2ImgPipeline ## StableDiffusionImg2ImgPipeline
[[autodoc]] StableDiffusionImg2ImgPipeline [[autodoc]] StableDiffusionImg2ImgPipeline
- all
- __call__ - __call__
- enable_attention_slicing - enable_attention_slicing
- disable_attention_slicing - disable_attention_slicing
...@@ -91,6 +93,7 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca ...@@ -91,6 +93,7 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca
## StableDiffusionInpaintPipeline ## StableDiffusionInpaintPipeline
[[autodoc]] StableDiffusionInpaintPipeline [[autodoc]] StableDiffusionInpaintPipeline
- all
- __call__ - __call__
- enable_attention_slicing - enable_attention_slicing
- disable_attention_slicing - disable_attention_slicing
...@@ -99,6 +102,7 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca ...@@ -99,6 +102,7 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca
## StableDiffusionDepth2ImgPipeline ## StableDiffusionDepth2ImgPipeline
[[autodoc]] StableDiffusionDepth2ImgPipeline [[autodoc]] StableDiffusionDepth2ImgPipeline
- all
- __call__ - __call__
- enable_attention_slicing - enable_attention_slicing
- disable_attention_slicing - disable_attention_slicing
...@@ -107,15 +111,16 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca ...@@ -107,15 +111,16 @@ If you want to use all possible use cases in a single `DiffusionPipeline` you ca
## StableDiffusionImageVariationPipeline ## StableDiffusionImageVariationPipeline
[[autodoc]] StableDiffusionImageVariationPipeline [[autodoc]] StableDiffusionImageVariationPipeline
- all
- __call__ - __call__
- enable_attention_slicing - enable_attention_slicing
- disable_attention_slicing - disable_attention_slicing
- enable_xformers_memory_efficient_attention - enable_xformers_memory_efficient_attention
- disable_xformers_memory_efficient_attention - disable_xformers_memory_efficient_attention
## StableDiffusionUpscalePipeline ## StableDiffusionUpscalePipeline
[[autodoc]] StableDiffusionUpscalePipeline [[autodoc]] StableDiffusionUpscalePipeline
- all
- __call__ - __call__
- enable_attention_slicing - enable_attention_slicing
- disable_attention_slicing - disable_attention_slicing
......
...@@ -81,10 +81,10 @@ To use a different scheduler, you can either change it via the [`ConfigMixin.fro ...@@ -81,10 +81,10 @@ To use a different scheduler, you can either change it via the [`ConfigMixin.fro
## StableDiffusionSafePipelineOutput ## StableDiffusionSafePipelineOutput
[[autodoc]] pipelines.stable_diffusion_safe.StableDiffusionSafePipelineOutput [[autodoc]] pipelines.stable_diffusion_safe.StableDiffusionSafePipelineOutput
- all
- __call__
## StableDiffusionPipelineSafe ## StableDiffusionPipelineSafe
[[autodoc]] StableDiffusionPipelineSafe [[autodoc]] StableDiffusionPipelineSafe
- all
- __call__ - __call__
- enable_attention_slicing
- disable_attention_slicing
...@@ -32,4 +32,5 @@ This pipeline implements the Stochastic sampling tailored to the Variance-Expand ...@@ -32,4 +32,5 @@ This pipeline implements the Stochastic sampling tailored to the Variance-Expand
## KarrasVePipeline ## KarrasVePipeline
[[autodoc]] KarrasVePipeline [[autodoc]] KarrasVePipeline
- __call__ - all
- __call__
...@@ -24,10 +24,14 @@ The unCLIP model in diffusers comes from kakaobrain's karlo and the original cod ...@@ -24,10 +24,14 @@ The unCLIP model in diffusers comes from kakaobrain's karlo and the original cod
| Pipeline | Tasks | Colab | 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.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 ## UnCLIPPipeline
[[autodoc]] pipelines.unclip.pipeline_unclip.UnCLIPPipeline [[autodoc]] UnCLIPPipeline
- __call__ - all
[[autodoc]] pipelines.unclip.pipeline_unclip_image_variation.UnCLIPImageVariationPipeline - __call__
- __call__
\ No newline at end of file [[autodoc]] UnCLIPImageVariationPipeline
- all
- __call__
...@@ -56,18 +56,15 @@ To use a different scheduler, you can either change it via the [`ConfigMixin.fro ...@@ -56,18 +56,15 @@ To use a different scheduler, you can either change it via the [`ConfigMixin.fro
## VersatileDiffusionTextToImagePipeline ## VersatileDiffusionTextToImagePipeline
[[autodoc]] VersatileDiffusionTextToImagePipeline [[autodoc]] VersatileDiffusionTextToImagePipeline
- all
- __call__ - __call__
- enable_attention_slicing
- disable_attention_slicing
## VersatileDiffusionImageVariationPipeline ## VersatileDiffusionImageVariationPipeline
[[autodoc]] VersatileDiffusionImageVariationPipeline [[autodoc]] VersatileDiffusionImageVariationPipeline
- all
- __call__ - __call__
- enable_attention_slicing
- disable_attention_slicing
## VersatileDiffusionDualGuidedPipeline ## VersatileDiffusionDualGuidedPipeline
[[autodoc]] VersatileDiffusionDualGuidedPipeline [[autodoc]] VersatileDiffusionDualGuidedPipeline
- all
- __call__ - __call__
- enable_attention_slicing
- disable_attention_slicing
...@@ -30,5 +30,6 @@ The original codebase can be found [here](https://github.com/microsoft/VQ-Diffus ...@@ -30,5 +30,6 @@ The original codebase can be found [here](https://github.com/microsoft/VQ-Diffus
## VQDiffusionPipeline ## VQDiffusionPipeline
[[autodoc]] pipelines.vq_diffusion.pipeline_vq_diffusion.VQDiffusionPipeline [[autodoc]] VQDiffusionPipeline
- __call__ - all
- __call__
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment