diff --git a/docs/source/api/diffusion_pipeline.mdx b/docs/source/api/diffusion_pipeline.mdx index ab138e3a8408..b5d56fb315d4 100644 --- a/docs/source/api/diffusion_pipeline.mdx +++ b/docs/source/api/diffusion_pipeline.mdx @@ -30,13 +30,17 @@ Any pipeline object can be saved locally with [`~DiffusionPipeline.save_pretrain ## DiffusionPipeline [[autodoc]] DiffusionPipeline - - from_pretrained - - 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 diff --git a/docs/source/api/pipelines/alt_diffusion.mdx b/docs/source/api/pipelines/alt_diffusion.mdx index 8d7d795d7633..0f497a390a7c 100644 --- a/docs/source/api/pipelines/alt_diffusion.mdx +++ b/docs/source/api/pipelines/alt_diffusion.mdx @@ -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 diff --git a/docs/source/api/pipelines/audio_diffusion.mdx b/docs/source/api/pipelines/audio_diffusion.mdx index bafdbef28140..ec9b1fb2d304 100644 --- a/docs/source/api/pipelines/audio_diffusion.mdx +++ b/docs/source/api/pipelines/audio_diffusion.mdx @@ -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 diff --git a/docs/source/api/pipelines/cycle_diffusion.mdx b/docs/source/api/pipelines/cycle_diffusion.mdx index b5c078ad9466..70986bd39a3d 100644 --- a/docs/source/api/pipelines/cycle_diffusion.mdx +++ b/docs/source/api/pipelines/cycle_diffusion.mdx @@ -96,4 +96,5 @@ image.save("black_to_blue.png") ## CycleDiffusionPipeline [[autodoc]] CycleDiffusionPipeline + - all - __call__ diff --git a/docs/source/api/pipelines/dance_diffusion.mdx b/docs/source/api/pipelines/dance_diffusion.mdx index 4d969bf6f032..8264de7db603 100644 --- a/docs/source/api/pipelines/dance_diffusion.mdx +++ b/docs/source/api/pipelines/dance_diffusion.mdx @@ -30,4 +30,5 @@ The original codebase of this implementation can be found [here](https://github. ## DanceDiffusionPipeline [[autodoc]] DanceDiffusionPipeline - - __call__ + - all + - __call__ diff --git a/docs/source/api/pipelines/ddim.mdx b/docs/source/api/pipelines/ddim.mdx index a7a5421b36fe..b1dfa3b056a8 100644 --- a/docs/source/api/pipelines/ddim.mdx +++ b/docs/source/api/pipelines/ddim.mdx @@ -32,4 +32,5 @@ For questions, feel free to contact the author on [tsong.me](https://tsong.me/). ## DDIMPipeline [[autodoc]] DDIMPipeline - - __call__ + - all + - __call__ diff --git a/docs/source/api/pipelines/ddpm.mdx b/docs/source/api/pipelines/ddpm.mdx index c6d8a6f28660..92cee580d152 100644 --- a/docs/source/api/pipelines/ddpm.mdx +++ b/docs/source/api/pipelines/ddpm.mdx @@ -33,4 +33,5 @@ The original codebase of this paper can be found [here](https://github.com/hojon # DDPMPipeline [[autodoc]] DDPMPipeline - - __call__ + - all + - __call__ diff --git a/docs/source/api/pipelines/latent_diffusion.mdx b/docs/source/api/pipelines/latent_diffusion.mdx index 370d014f5a10..475957d93cd8 100644 --- a/docs/source/api/pipelines/latent_diffusion.mdx +++ b/docs/source/api/pipelines/latent_diffusion.mdx @@ -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__ diff --git a/docs/source/api/pipelines/latent_diffusion_uncond.mdx b/docs/source/api/pipelines/latent_diffusion_uncond.mdx index 0a5b20cd4a1c..03f1f31cee5d 100644 --- a/docs/source/api/pipelines/latent_diffusion_uncond.mdx +++ b/docs/source/api/pipelines/latent_diffusion_uncond.mdx @@ -38,4 +38,5 @@ The original codebase can be found [here](https://github.com/CompVis/latent-diff ## LDMPipeline [[autodoc]] LDMPipeline - - __call__ + - all + - __call__ diff --git a/docs/source/api/pipelines/paint_by_example.mdx b/docs/source/api/pipelines/paint_by_example.mdx index e40b3453edf4..91b936d98ac0 100644 --- a/docs/source/api/pipelines/paint_by_example.mdx +++ b/docs/source/api/pipelines/paint_by_example.mdx @@ -69,5 +69,6 @@ image ``` ## PaintByExamplePipeline -[[autodoc]] pipelines.paint_by_example.pipeline_paint_by_example.PaintByExamplePipeline - - __call__ +[[autodoc]] PaintByExamplePipeline + - all + - __call__ diff --git a/docs/source/api/pipelines/pndm.mdx b/docs/source/api/pipelines/pndm.mdx index 89930f4d4f8f..824a927d8bc3 100644 --- a/docs/source/api/pipelines/pndm.mdx +++ b/docs/source/api/pipelines/pndm.mdx @@ -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__ diff --git a/docs/source/api/pipelines/repaint.mdx b/docs/source/api/pipelines/repaint.mdx index ce262daffaeb..d0a3a6875b24 100644 --- a/docs/source/api/pipelines/repaint.mdx +++ b/docs/source/api/pipelines/repaint.mdx @@ -72,6 +72,6 @@ inpainted_image = output.images[0] ``` ## RePaintPipeline -[[autodoc]] pipelines.repaint.pipeline_repaint.RePaintPipeline - - __call__ - +[[autodoc]] RePaintPipeline + - all + - __call__ diff --git a/docs/source/api/pipelines/score_sde_ve.mdx b/docs/source/api/pipelines/score_sde_ve.mdx index 3d6619c2591f..7a5d7ee83aa5 100644 --- a/docs/source/api/pipelines/score_sde_ve.mdx +++ b/docs/source/api/pipelines/score_sde_ve.mdx @@ -32,5 +32,5 @@ This pipeline implements the Variance Expanding (VE) variant of the method. ## ScoreSdeVePipeline [[autodoc]] ScoreSdeVePipeline - - __call__ - + - all + - __call__ diff --git a/docs/source/api/pipelines/stable_diffusion.mdx b/docs/source/api/pipelines/stable_diffusion.mdx index f16c2cba0274..fe28155600ce 100644 --- a/docs/source/api/pipelines/stable_diffusion.mdx +++ b/docs/source/api/pipelines/stable_diffusion.mdx @@ -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 - disable_attention_slicing @@ -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 @@ -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 @@ -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 diff --git a/docs/source/api/pipelines/stable_diffusion_safe.mdx b/docs/source/api/pipelines/stable_diffusion_safe.mdx index 81fc59d3928c..c700b9c9f69e 100644 --- a/docs/source/api/pipelines/stable_diffusion_safe.mdx +++ b/docs/source/api/pipelines/stable_diffusion_safe.mdx @@ -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 - diff --git a/docs/source/api/pipelines/stochastic_karras_ve.mdx b/docs/source/api/pipelines/stochastic_karras_ve.mdx index de762cbda002..ab185ec20d6c 100644 --- a/docs/source/api/pipelines/stochastic_karras_ve.mdx +++ b/docs/source/api/pipelines/stochastic_karras_ve.mdx @@ -32,4 +32,5 @@ This pipeline implements the Stochastic sampling tailored to the Variance-Expand ## KarrasVePipeline [[autodoc]] KarrasVePipeline - - __call__ + - all + - __call__ diff --git a/docs/source/api/pipelines/unclip.mdx b/docs/source/api/pipelines/unclip.mdx index c744a567b1bc..87d44adc0d76 100644 --- a/docs/source/api/pipelines/unclip.mdx +++ b/docs/source/api/pipelines/unclip.mdx @@ -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__ \ No newline at end of file +[[autodoc]] UnCLIPPipeline + - all + - __call__ + +[[autodoc]] UnCLIPImageVariationPipeline + - all + - __call__ diff --git a/docs/source/api/pipelines/versatile_diffusion.mdx b/docs/source/api/pipelines/versatile_diffusion.mdx index f557c5b0aac8..80da6768bfcf 100644 --- a/docs/source/api/pipelines/versatile_diffusion.mdx +++ b/docs/source/api/pipelines/versatile_diffusion.mdx @@ -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 diff --git a/docs/source/api/pipelines/vq_diffusion.mdx b/docs/source/api/pipelines/vq_diffusion.mdx index 92cc903eee79..459c65293589 100644 --- a/docs/source/api/pipelines/vq_diffusion.mdx +++ b/docs/source/api/pipelines/vq_diffusion.mdx @@ -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__