Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
chenpangpang
diffusers
Commits
ac373846
Unverified
Commit
ac373846
authored
Dec 30, 2022
by
Patrick von Platen
Committed by
GitHub
Dec 30, 2022
Browse files
[Docs] Improve docs (#1870)
* [Docs] Improve docs * up
parent
a6e2c1fe
Changes
19
Show whitespace changes
Inline
Side-by-side
Showing
19 changed files
with
65 additions
and
49 deletions
+65
-49
docs/source/api/diffusion_pipeline.mdx
docs/source/api/diffusion_pipeline.mdx
+8
-4
docs/source/api/pipelines/alt_diffusion.mdx
docs/source/api/pipelines/alt_diffusion.mdx
+4
-4
docs/source/api/pipelines/audio_diffusion.mdx
docs/source/api/pipelines/audio_diffusion.mdx
+2
-6
docs/source/api/pipelines/cycle_diffusion.mdx
docs/source/api/pipelines/cycle_diffusion.mdx
+1
-0
docs/source/api/pipelines/dance_diffusion.mdx
docs/source/api/pipelines/dance_diffusion.mdx
+2
-1
docs/source/api/pipelines/ddim.mdx
docs/source/api/pipelines/ddim.mdx
+2
-1
docs/source/api/pipelines/ddpm.mdx
docs/source/api/pipelines/ddpm.mdx
+2
-1
docs/source/api/pipelines/latent_diffusion.mdx
docs/source/api/pipelines/latent_diffusion.mdx
+4
-2
docs/source/api/pipelines/latent_diffusion_uncond.mdx
docs/source/api/pipelines/latent_diffusion_uncond.mdx
+2
-1
docs/source/api/pipelines/paint_by_example.mdx
docs/source/api/pipelines/paint_by_example.mdx
+3
-2
docs/source/api/pipelines/pndm.mdx
docs/source/api/pipelines/pndm.mdx
+3
-3
docs/source/api/pipelines/repaint.mdx
docs/source/api/pipelines/repaint.mdx
+3
-3
docs/source/api/pipelines/score_sde_ve.mdx
docs/source/api/pipelines/score_sde_ve.mdx
+2
-2
docs/source/api/pipelines/stable_diffusion.mdx
docs/source/api/pipelines/stable_diffusion.mdx
+8
-3
docs/source/api/pipelines/stable_diffusion_safe.mdx
docs/source/api/pipelines/stable_diffusion_safe.mdx
+3
-3
docs/source/api/pipelines/stochastic_karras_ve.mdx
docs/source/api/pipelines/stochastic_karras_ve.mdx
+2
-1
docs/source/api/pipelines/unclip.mdx
docs/source/api/pipelines/unclip.mdx
+8
-4
docs/source/api/pipelines/versatile_diffusion.mdx
docs/source/api/pipelines/versatile_diffusion.mdx
+3
-6
docs/source/api/pipelines/vq_diffusion.mdx
docs/source/api/pipelines/vq_diffusion.mdx
+3
-2
No files found.
docs/source/api/diffusion_pipeline.mdx
View file @
ac373846
...
@@ -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
docs/source/api/pipelines/alt_diffusion.mdx
View file @
ac373846
...
@@ -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
docs/source/api/pipelines/audio_diffusion.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
- encode
- slerp
## Mel
## Mel
[[autodoc]] Mel
[[autodoc]] Mel
- audio_slice_to_image
- image_to_audio
docs/source/api/pipelines/cycle_diffusion.mdx
View file @
ac373846
...
@@ -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__
docs/source/api/pipelines/dance_diffusion.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/ddim.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/ddpm.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/latent_diffusion.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
## LDMSuperResolutionPipeline
## LDMSuperResolutionPipeline
[[autodoc]] LDMSuperResolutionPipeline
[[autodoc]] LDMSuperResolutionPipeline
- all
- __call__
- __call__
docs/source/api/pipelines/latent_diffusion_uncond.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/paint_by_example.mdx
View file @
ac373846
...
@@ -69,5 +69,6 @@ image
...
@@ -69,5 +69,6 @@ image
```
```
## PaintByExamplePipeline
## PaintByExamplePipeline
[[autodoc]] pipelines.paint_by_example.pipeline_paint_by_example.PaintByExamplePipeline
[[autodoc]] PaintByExamplePipeline
- all
- __call__
- __call__
docs/source/api/pipelines/pndm.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/repaint.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/score_sde_ve.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/stable_diffusion.mdx
View file @
ac373846
...
@@ -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
...
...
docs/source/api/pipelines/stable_diffusion_safe.mdx
View file @
ac373846
...
@@ -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
docs/source/api/pipelines/stochastic_karras_ve.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
docs/source/api/pipelines/unclip.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
[[autodoc]] pipelines.unclip.pipeline_unclip_image_variation.UnCLIPImageVariationPipeline
[[autodoc]] UnCLIPImageVariationPipeline
- all
- __call__
- __call__
docs/source/api/pipelines/versatile_diffusion.mdx
View file @
ac373846
...
@@ -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
docs/source/api/pipelines/vq_diffusion.mdx
View file @
ac373846
...
@@ -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
- all
- __call__
- __call__
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment