Unverified Commit c6fbcf71 authored by Steven Liu's avatar Steven Liu Committed by GitHub
Browse files

[docs] Update toctree (#11936)



* update

* fix

* feedback

---------
Co-authored-by: default avatarSayak Paul <spsayakpaul@gmail.com>
parent b9e99654
- sections: - title: Get started
sections:
- local: index - local: index
title: 🧨 Diffusers title: Diffusers
- local: installation
title: Installation
- local: quicktour - local: quicktour
title: Quicktour title: Quicktour
- local: stable_diffusion - local: stable_diffusion
title: Effective and efficient diffusion title: Effective and efficient diffusion
- local: installation
title: Installation - title: DiffusionPipeline
title: Get started isExpanded: false
- sections: sections:
- local: tutorials/tutorial_overview
title: Overview
- local: using-diffusers/write_own_pipeline
title: Understanding pipelines, models and schedulers
- local: tutorials/autopipeline
title: AutoPipeline
- local: tutorials/basic_training
title: Train a diffusion model
title: Tutorials
- sections:
- local: using-diffusers/loading - local: using-diffusers/loading
title: Load pipelines title: Load pipelines
- local: tutorials/autopipeline
title: AutoPipeline
- local: using-diffusers/custom_pipeline_overview - local: using-diffusers/custom_pipeline_overview
title: Load community pipelines and components title: Load community pipelines and components
- local: using-diffusers/callback
title: Pipeline callbacks
- local: using-diffusers/reusing_seeds
title: Reproducible pipelines
- local: using-diffusers/schedulers - local: using-diffusers/schedulers
title: Load schedulers and models title: Load schedulers and models
- local: using-diffusers/scheduler_features
title: Scheduler features
- local: using-diffusers/other-formats - local: using-diffusers/other-formats
title: Model files and layouts title: Model files and layouts
- local: using-diffusers/push_to_hub - local: using-diffusers/push_to_hub
title: Push files to the Hub title: Push files to the Hub
title: Load pipelines and adapters
- sections: - title: Adapters
isExpanded: false
sections:
- local: tutorials/using_peft_for_inference - local: tutorials/using_peft_for_inference
title: LoRA title: LoRA
- local: using-diffusers/ip_adapter - local: using-diffusers/ip_adapter
...@@ -43,25 +46,12 @@ ...@@ -43,25 +46,12 @@
title: DreamBooth title: DreamBooth
- local: using-diffusers/textual_inversion_inference - local: using-diffusers/textual_inversion_inference
title: Textual inversion title: Textual inversion
title: Adapters
- title: Inference
isExpanded: false isExpanded: false
- sections: sections:
- local: using-diffusers/unconditional_image_generation - local: using-diffusers/weighted_prompts
title: Unconditional image generation title: Prompt techniques
- local: using-diffusers/conditional_image_generation
title: Text-to-image
- local: using-diffusers/img2img
title: Image-to-image
- local: using-diffusers/inpaint
title: Inpainting
- local: using-diffusers/text-img2vid
title: Video generation
- local: using-diffusers/depth2img
title: Depth-to-image
title: Generative tasks
- sections:
- local: using-diffusers/overview_techniques
title: Overview
- local: using-diffusers/create_a_server - local: using-diffusers/create_a_server
title: Create a server title: Create a server
- local: using-diffusers/batched_inference - local: using-diffusers/batched_inference
...@@ -76,14 +66,38 @@ ...@@ -76,14 +66,38 @@
title: Reproducible pipelines title: Reproducible pipelines
- local: using-diffusers/image_quality - local: using-diffusers/image_quality
title: Controlling image quality title: Controlling image quality
- local: using-diffusers/weighted_prompts
title: Prompt techniques - title: Inference optimization
title: Inference techniques isExpanded: false
- sections: sections:
- local: advanced_inference/outpaint - local: optimization/fp16
title: Outpainting title: Accelerate inference
title: Advanced inference - local: optimization/cache
- sections: title: Caching
- local: optimization/memory
title: Reduce memory usage
- local: optimization/speed-memory-optims
title: Compile and offloading quantized models
- title: Community optimizations
sections:
- local: optimization/pruna
title: Pruna
- local: optimization/xformers
title: xFormers
- local: optimization/tome
title: Token merging
- local: optimization/deepcache
title: DeepCache
- local: optimization/tgate
title: TGATE
- local: optimization/xdit
title: xDiT
- local: optimization/para_attn
title: ParaAttention
- title: Hybrid Inference
isExpanded: false
sections:
- local: hybrid_inference/overview - local: hybrid_inference/overview
title: Overview title: Overview
- local: hybrid_inference/vae_decode - local: hybrid_inference/vae_decode
...@@ -92,8 +106,10 @@ ...@@ -92,8 +106,10 @@
title: VAE Encode title: VAE Encode
- local: hybrid_inference/api_reference - local: hybrid_inference/api_reference
title: API Reference title: API Reference
title: Hybrid Inference
- sections: - title: Modular Diffusers
isExpanded: false
sections:
- local: modular_diffusers/overview - local: modular_diffusers/overview
title: Overview title: Overview
- local: modular_diffusers/modular_pipeline - local: modular_diffusers/modular_pipeline
...@@ -112,41 +128,19 @@ ...@@ -112,41 +128,19 @@
title: Auto Pipeline Blocks title: Auto Pipeline Blocks
- local: modular_diffusers/end_to_end_guide - local: modular_diffusers/end_to_end_guide
title: End-to-End Example title: End-to-End Example
title: Modular Diffusers
- sections: - title: Training
- local: using-diffusers/consisid isExpanded: false
title: ConsisID sections:
- local: using-diffusers/sdxl
title: Stable Diffusion XL
- local: using-diffusers/sdxl_turbo
title: SDXL Turbo
- local: using-diffusers/kandinsky
title: Kandinsky
- local: using-diffusers/omnigen
title: OmniGen
- local: using-diffusers/pag
title: PAG
- local: using-diffusers/inference_with_lcm
title: Latent Consistency Model
- local: using-diffusers/shap-e
title: Shap-E
- local: using-diffusers/diffedit
title: DiffEdit
- local: using-diffusers/inference_with_tcd_lora
title: Trajectory Consistency Distillation-LoRA
- local: using-diffusers/svd
title: Stable Video Diffusion
- local: using-diffusers/marigold_usage
title: Marigold Computer Vision
title: Specific pipeline examples
- sections:
- local: training/overview - local: training/overview
title: Overview title: Overview
- local: training/create_dataset - local: training/create_dataset
title: Create a dataset for training title: Create a dataset for training
- local: training/adapt_a_model - local: training/adapt_a_model
title: Adapt a model to a new task title: Adapt a model to a new task
- isExpanded: false - local: tutorials/basic_training
title: Train a diffusion model
- title: Models
sections: sections:
- local: training/unconditional_training - local: training/unconditional_training
title: Unconditional image generation title: Unconditional image generation
...@@ -166,8 +160,7 @@ ...@@ -166,8 +160,7 @@
title: InstructPix2Pix title: InstructPix2Pix
- local: training/cogvideox - local: training/cogvideox
title: CogVideoX title: CogVideoX
title: Models - title: Methods
- isExpanded: false
sections: sections:
- local: training/text_inversion - local: training/text_inversion
title: Textual Inversion title: Textual Inversion
...@@ -181,9 +174,10 @@ ...@@ -181,9 +174,10 @@
title: Latent Consistency Distillation title: Latent Consistency Distillation
- local: training/ddpo - local: training/ddpo
title: Reinforcement learning training with DDPO title: Reinforcement learning training with DDPO
title: Methods
title: Training - title: Quantization
- sections: isExpanded: false
sections:
- local: quantization/overview - local: quantization/overview
title: Getting Started title: Getting Started
- local: quantization/bitsandbytes - local: quantization/bitsandbytes
...@@ -194,50 +188,76 @@ ...@@ -194,50 +188,76 @@
title: torchao title: torchao
- local: quantization/quanto - local: quantization/quanto
title: quanto title: quanto
title: Quantization Methods
- sections: - title: Model accelerators and hardware
- local: optimization/fp16 isExpanded: false
title: Accelerate inference sections:
- local: optimization/cache - local: using-diffusers/stable_diffusion_jax_how_to
title: Caching title: JAX/Flax
- local: optimization/memory - local: optimization/onnx
title: Reduce memory usage title: ONNX
- local: optimization/speed-memory-optims - local: optimization/open_vino
title: Compile and offloading quantized models title: OpenVINO
- local: optimization/pruna - local: optimization/coreml
title: Pruna title: Core ML
- local: optimization/xformers - local: optimization/mps
title: xFormers title: Metal Performance Shaders (MPS)
- local: optimization/tome - local: optimization/habana
title: Token merging title: Intel Gaudi
- local: optimization/deepcache - local: optimization/neuron
title: DeepCache title: AWS Neuron
- local: optimization/tgate
title: TGATE - title: Specific pipeline examples
- local: optimization/xdit isExpanded: false
title: xDiT sections:
- local: optimization/para_attn - local: using-diffusers/consisid
title: ParaAttention title: ConsisID
- sections: - local: using-diffusers/sdxl
- local: using-diffusers/stable_diffusion_jax_how_to title: Stable Diffusion XL
title: JAX/Flax - local: using-diffusers/sdxl_turbo
- local: optimization/onnx title: SDXL Turbo
title: ONNX - local: using-diffusers/kandinsky
- local: optimization/open_vino title: Kandinsky
title: OpenVINO - local: using-diffusers/omnigen
- local: optimization/coreml title: OmniGen
title: Core ML - local: using-diffusers/pag
title: Optimized model formats title: PAG
- sections: - local: using-diffusers/inference_with_lcm
- local: optimization/mps title: Latent Consistency Model
title: Metal Performance Shaders (MPS) - local: using-diffusers/shap-e
- local: optimization/habana title: Shap-E
title: Intel Gaudi - local: using-diffusers/diffedit
- local: optimization/neuron title: DiffEdit
title: AWS Neuron - local: using-diffusers/inference_with_tcd_lora
title: Optimized hardware title: Trajectory Consistency Distillation-LoRA
title: Accelerate inference and reduce memory - local: using-diffusers/svd
- sections: title: Stable Video Diffusion
- local: using-diffusers/marigold_usage
title: Marigold Computer Vision
- title: Resources
isExpanded: false
sections:
- title: Task recipes
sections:
- local: using-diffusers/unconditional_image_generation
title: Unconditional image generation
- local: using-diffusers/conditional_image_generation
title: Text-to-image
- local: using-diffusers/img2img
title: Image-to-image
- local: using-diffusers/inpaint
title: Inpainting
- local: advanced_inference/outpaint
title: Outpainting
- local: using-diffusers/text-img2vid
title: Video generation
- local: using-diffusers/depth2img
title: Depth-to-image
- local: using-diffusers/write_own_pipeline
title: Understanding pipelines, models and schedulers
- local: community_projects
title: Projects built with Diffusers
- local: conceptual/philosophy - local: conceptual/philosophy
title: Philosophy title: Philosophy
- local: using-diffusers/controlling_generation - local: using-diffusers/controlling_generation
...@@ -248,13 +268,11 @@ ...@@ -248,13 +268,11 @@
title: Diffusers' Ethical Guidelines title: Diffusers' Ethical Guidelines
- local: conceptual/evaluation - local: conceptual/evaluation
title: Evaluating Diffusion Models title: Evaluating Diffusion Models
title: Conceptual Guides
- sections: - title: API
- local: community_projects isExpanded: false
title: Projects built with Diffusers sections:
title: Community Projects - title: Main Classes
- sections:
- isExpanded: false
sections: sections:
- local: api/configuration - local: api/configuration
title: Configuration title: Configuration
...@@ -264,8 +282,7 @@ ...@@ -264,8 +282,7 @@
title: Outputs title: Outputs
- local: api/quantization - local: api/quantization
title: Quantization title: Quantization
title: Main Classes - title: Loaders
- isExpanded: false
sections: sections:
- local: api/loaders/ip_adapter - local: api/loaders/ip_adapter
title: IP-Adapter title: IP-Adapter
...@@ -281,14 +298,14 @@ ...@@ -281,14 +298,14 @@
title: SD3Transformer2D title: SD3Transformer2D
- local: api/loaders/peft - local: api/loaders/peft
title: PEFT title: PEFT
title: Loaders - title: Models
- isExpanded: false
sections: sections:
- local: api/models/overview - local: api/models/overview
title: Overview title: Overview
- local: api/models/auto_model - local: api/models/auto_model
title: AutoModel title: AutoModel
- sections: - title: ControlNets
sections:
- local: api/models/controlnet - local: api/models/controlnet
title: ControlNetModel title: ControlNetModel
- local: api/models/controlnet_union - local: api/models/controlnet_union
...@@ -303,8 +320,8 @@ ...@@ -303,8 +320,8 @@
title: SD3ControlNetModel title: SD3ControlNetModel
- local: api/models/controlnet_sparsectrl - local: api/models/controlnet_sparsectrl
title: SparseControlNetModel title: SparseControlNetModel
title: ControlNets - title: Transformers
- sections: sections:
- local: api/models/allegro_transformer3d - local: api/models/allegro_transformer3d
title: AllegroTransformer3DModel title: AllegroTransformer3DModel
- local: api/models/aura_flow_transformer2d - local: api/models/aura_flow_transformer2d
...@@ -363,8 +380,8 @@ ...@@ -363,8 +380,8 @@
title: TransformerTemporalModel title: TransformerTemporalModel
- local: api/models/wan_transformer_3d - local: api/models/wan_transformer_3d
title: WanTransformer3DModel title: WanTransformer3DModel
title: Transformers - title: UNets
- sections: sections:
- local: api/models/stable_cascade_unet - local: api/models/stable_cascade_unet
title: StableCascadeUNet title: StableCascadeUNet
- local: api/models/unet - local: api/models/unet
...@@ -379,8 +396,8 @@ ...@@ -379,8 +396,8 @@
title: UNetMotionModel title: UNetMotionModel
- local: api/models/uvit2d - local: api/models/uvit2d
title: UViT2DModel title: UViT2DModel
title: UNets - title: VAEs
- sections: sections:
- local: api/models/asymmetricautoencoderkl - local: api/models/asymmetricautoencoderkl
title: AsymmetricAutoencoderKL title: AsymmetricAutoencoderKL
- local: api/models/autoencoder_dc - local: api/models/autoencoder_dc
...@@ -411,9 +428,7 @@ ...@@ -411,9 +428,7 @@
title: Tiny AutoEncoder title: Tiny AutoEncoder
- local: api/models/vq - local: api/models/vq
title: VQModel title: VQModel
title: VAEs - title: Pipelines
title: Models
- isExpanded: false
sections: sections:
- local: api/pipelines/overview - local: api/pipelines/overview
title: Overview title: Overview
...@@ -555,7 +570,8 @@ ...@@ -555,7 +570,8 @@
title: Stable Audio title: Stable Audio
- local: api/pipelines/stable_cascade - local: api/pipelines/stable_cascade
title: Stable Cascade title: Stable Cascade
- sections: - title: Stable Diffusion
sections:
- local: api/pipelines/stable_diffusion/overview - local: api/pipelines/stable_diffusion/overview
title: Overview title: Overview
- local: api/pipelines/stable_diffusion/depth2img - local: api/pipelines/stable_diffusion/depth2img
...@@ -592,7 +608,6 @@ ...@@ -592,7 +608,6 @@
title: T2I-Adapter title: T2I-Adapter
- local: api/pipelines/stable_diffusion/text2img - local: api/pipelines/stable_diffusion/text2img
title: Text-to-image title: Text-to-image
title: Stable Diffusion
- local: api/pipelines/stable_unclip - local: api/pipelines/stable_unclip
title: Stable unCLIP title: Stable unCLIP
- local: api/pipelines/text_to_video - local: api/pipelines/text_to_video
...@@ -611,8 +626,7 @@ ...@@ -611,8 +626,7 @@
title: Wan title: Wan
- local: api/pipelines/wuerstchen - local: api/pipelines/wuerstchen
title: Wuerstchen title: Wuerstchen
title: Pipelines - title: Schedulers
- isExpanded: false
sections: sections:
- local: api/schedulers/overview - local: api/schedulers/overview
title: Overview title: Overview
...@@ -682,8 +696,7 @@ ...@@ -682,8 +696,7 @@
title: UniPCMultistepScheduler title: UniPCMultistepScheduler
- local: api/schedulers/vq_diffusion - local: api/schedulers/vq_diffusion
title: VQDiffusionScheduler title: VQDiffusionScheduler
title: Schedulers - title: Internal classes
- isExpanded: false
sections: sections:
- local: api/internal_classes_overview - local: api/internal_classes_overview
title: Overview title: Overview
...@@ -701,5 +714,3 @@ ...@@ -701,5 +714,3 @@
title: VAE Image Processor title: VAE Image Processor
- local: api/video_processor - local: api/video_processor
title: Video Processor title: Video Processor
title: Internal classes
title: API
<!--Copyright 2025 The HuggingFace Team. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->
# Overview
Welcome to 🧨 Diffusers! If you're new to diffusion models and generative AI, and want to learn more, then you've come to the right place. These beginner-friendly tutorials are designed to provide a gentle introduction to diffusion models and help you understand the library fundamentals - the core components and how 🧨 Diffusers is meant to be used.
You'll learn how to use a pipeline for inference to rapidly generate things, and then deconstruct that pipeline to really understand how to use the library as a modular toolbox for building your own diffusion systems. In the next lesson, you'll learn how to train your own diffusion model to generate what you want.
After completing the tutorials, you'll have gained the necessary skills to start exploring the library on your own and see how to use it for your own projects and applications.
Feel free to join our community on [Discord](https://discord.com/invite/JfAtkvEtRb) or the [forums](https://discuss.huggingface.co/c/discussion-related-to-httpsgithubcomhuggingfacediffusers/63) to connect and collaborate with other users and developers!
Let's start diffusing! 🧨
<!--Copyright 2025 The HuggingFace Team. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->
# Overview
The inference pipeline supports and enables a wide range of techniques that are divided into two categories:
* Pipeline functionality: these techniques modify the pipeline or extend it for other applications. For example, pipeline callbacks add new features to a pipeline and a pipeline can also be extended for distributed inference.
* Improve inference quality: these techniques increase the visual quality of the generated images. For example, you can enhance your prompts with GPT2 to create better images with lower effort.
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