_toctree.yml 14.9 KB
Newer Older
Nathan Lambert's avatar
Nathan Lambert committed
1
2
- sections:
  - local: index
3
    title: 🧨 Diffusers
Nathan Lambert's avatar
Nathan Lambert committed
4
  - local: quicktour
5
    title: Quicktour
Patrick von Platen's avatar
Patrick von Platen committed
6
  - local: stable_diffusion
7
    title: Effective and efficient diffusion
Patrick von Platen's avatar
Patrick von Platen committed
8
  - local: installation
9
10
    title: Installation
  title: Get started
Steven Liu's avatar
Steven Liu committed
11
- sections:
12
13
  - local: tutorials/tutorial_overview
    title: Overview
14
  - local: using-diffusers/write_own_pipeline
15
    title: Understanding pipelines, models and schedulers
16
17
  - local: tutorials/autopipeline
    title: AutoPipeline
Steven Liu's avatar
Steven Liu committed
18
19
  - local: tutorials/basic_training
    title: Train a diffusion model
20
  - local: tutorials/using_peft_for_inference
Steven Liu's avatar
Steven Liu committed
21
    title: Load LoRAs for inference
22
23
  - local: tutorials/fast_diffusion
    title: Accelerate inference of text-to-image diffusion models
Steven Liu's avatar
Steven Liu committed
24
  title: Tutorials
Nathan Lambert's avatar
Nathan Lambert committed
25
26
- sections:
  - sections:
27
28
    - local: using-diffusers/loading_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
29
    - local: using-diffusers/loading
30
      title: Load pipelines, models, and schedulers
31
    - local: using-diffusers/schedulers
32
      title: Load and compare different schedulers
33
    - local: using-diffusers/custom_pipeline_overview
34
      title: Load community pipelines and components
Steven Liu's avatar
Steven Liu committed
35
36
    - local: using-diffusers/using_safetensors
      title: Load safetensors
37
38
    - local: using-diffusers/other-formats
      title: Load different Stable Diffusion formats
Steven Liu's avatar
Steven Liu committed
39
40
    - local: using-diffusers/loading_adapters
      title: Load adapters
Steven Liu's avatar
Steven Liu committed
41
42
    - local: using-diffusers/push_to_hub
      title: Push files to the Hub
43
    title: Loading & Hub
Nathan Lambert's avatar
Nathan Lambert committed
44
  - sections:
Steven Liu's avatar
Steven Liu committed
45
46
    - local: using-diffusers/pipeline_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
47
    - local: using-diffusers/unconditional_image_generation
48
      title: Unconditional image generation
Patrick von Platen's avatar
Patrick von Platen committed
49
    - local: using-diffusers/conditional_image_generation
Steven Liu's avatar
Steven Liu committed
50
      title: Text-to-image
Patrick von Platen's avatar
Patrick von Platen committed
51
    - local: using-diffusers/img2img
Steven Liu's avatar
Steven Liu committed
52
      title: Image-to-image
Patrick von Platen's avatar
Patrick von Platen committed
53
    - local: using-diffusers/inpaint
Steven Liu's avatar
Steven Liu committed
54
      title: Inpainting
Steven Liu's avatar
Steven Liu committed
55
56
    - local: using-diffusers/text-img2vid
      title: Text or image-to-video
Patrick von Platen's avatar
Patrick von Platen committed
57
    - local: using-diffusers/depth2img
Steven Liu's avatar
Steven Liu committed
58
59
60
      title: Depth-to-image
    title: Tasks
  - sections:
61
62
    - local: using-diffusers/textual_inversion_inference
      title: Textual inversion
Steven Liu's avatar
Steven Liu committed
63
64
    - local: using-diffusers/ip_adapter
      title: IP-Adapter
Steven Liu's avatar
Steven Liu committed
65
66
    - local: using-diffusers/merge_loras
      title: Merge LoRAs
67
68
    - local: training/distributed_inference
      title: Distributed inference with multiple GPUs
69
    - local: using-diffusers/reusing_seeds
70
      title: Improve image quality with deterministic generation
Steven Liu's avatar
Steven Liu committed
71
72
    - local: using-diffusers/control_brightness
      title: Control image brightness
Steven Liu's avatar
Steven Liu committed
73
74
    - local: using-diffusers/weighted_prompts
      title: Prompt weighting
75
76
    - local: using-diffusers/freeu
      title: Improve generation quality with FreeU
Steven Liu's avatar
Steven Liu committed
77
78
79
80
81
82
    title: Techniques
  - sections:
    - local: using-diffusers/pipeline_overview
      title: Overview
    - local: using-diffusers/sdxl
      title: Stable Diffusion XL
83
84
    - local: using-diffusers/sdxl_turbo
      title: SDXL Turbo
Steven Liu's avatar
Steven Liu committed
85
86
    - local: using-diffusers/kandinsky
      title: Kandinsky
Steven Liu's avatar
Steven Liu committed
87
88
    - local: using-diffusers/controlnet
      title: ControlNet
Steven Liu's avatar
Steven Liu committed
89
90
    - local: using-diffusers/shap-e
      title: Shap-E
Steven Liu's avatar
Steven Liu committed
91
92
    - local: using-diffusers/diffedit
      title: DiffEdit
Steven Liu's avatar
Steven Liu committed
93
94
    - local: using-diffusers/distilled_sd
      title: Distilled Stable Diffusion inference
Steven Liu's avatar
Steven Liu committed
95
96
    - local: using-diffusers/callback
      title: Pipeline callbacks
97
    - local: using-diffusers/reproducibility
98
      title: Create reproducible pipelines
99
    - local: using-diffusers/custom_pipeline_examples
100
      title: Community pipelines
101
    - local: using-diffusers/contribute_pipeline
Steven Liu's avatar
Steven Liu committed
102
      title: Contribute a community pipeline
Suraj Patil's avatar
Suraj Patil committed
103
104
105
106
    - local: using-diffusers/inference_with_lcm_lora
      title: Latent Consistency Model-LoRA
    - local: using-diffusers/inference_with_lcm
      title: Latent Consistency Model
Suraj Patil's avatar
Suraj Patil committed
107
108
    - local: using-diffusers/svd
      title: Stable Video Diffusion
Steven Liu's avatar
Steven Liu committed
109
    title: Specific pipeline examples
110
111
112
  - sections:
    - local: training/overview
      title: Overview
Steven Liu's avatar
Steven Liu committed
113
114
    - local: training/create_dataset
      title: Create a dataset for training
Steven Liu's avatar
Steven Liu committed
115
116
    - local: training/adapt_a_model
      title: Adapt a model to a new task
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    - sections:
      - local: training/unconditional_training
        title: Unconditional image generation
      - local: training/text2image
        title: Text-to-image
      - local: training/sdxl
        title: Stable Diffusion XL
      - local: training/kandinsky
        title: Kandinsky 2.2
      - local: training/wuerstchen
        title: Wuerstchen
      - local: training/controlnet
        title: ControlNet
      - local: training/t2i_adapters
        title: T2I-Adapters
      - local: training/instructpix2pix
        title: InstructPix2Pix
      title: Models
    - sections:
      - local: training/text_inversion
        title: Textual Inversion
      - local: training/dreambooth
        title: DreamBooth
      - local: training/lora
        title: LoRA
      - local: training/custom_diffusion
        title: Custom Diffusion
Steven Liu's avatar
Steven Liu committed
144
145
      - local: training/lcm_distill
        title: Latent Consistency Distillation
146
147
148
      - local: training/ddpo
        title: Reinforcement learning training with DDPO
      title: Methods
149
    title: Training
150
151
  - sections:
    - local: using-diffusers/other-modalities
152
153
154
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
155
- sections:
156
157
  - local: optimization/opt_overview
    title: Overview
158
159
160
161
162
163
  - sections:
    - local: optimization/fp16
      title: Speed up inference
    - local: optimization/memory
      title: Reduce memory usage
    - local: optimization/torch2.0
164
      title: PyTorch 2.0
165
166
167
168
    - local: optimization/xformers
      title: xFormers
    - local: optimization/tome
      title: Token merging
169
170
    - local: optimization/deepcache
      title: DeepCache
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
    title: General optimizations
  - sections:
    - local: using-diffusers/stable_diffusion_jax_how_to
      title: JAX/Flax
    - local: optimization/onnx
      title: ONNX
    - local: optimization/open_vino
      title: OpenVINO
    - local: optimization/coreml
      title: Core ML
    title: Optimized model types
  - sections:
    - local: optimization/mps
      title: Metal Performance Shaders (MPS)
    - local: optimization/habana
      title: Habana Gaudi
    title: Optimized hardware
  title: Optimization
Patrick von Platen's avatar
Patrick von Platen committed
189
190
- sections:
  - local: conceptual/philosophy
191
    title: Philosophy
192
193
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
194
  - local: conceptual/contribution
195
    title: How to contribute?
196
197
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
198
199
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
200
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
201
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
202
  - sections:
Patrick von Platen's avatar
Patrick von Platen committed
203
    - local: api/configuration
204
      title: Configuration
205
206
207
208
    - local: api/logging
      title: Logging
    - local: api/outputs
      title: Outputs
209
    title: Main Classes
Steven Liu's avatar
Steven Liu committed
210
  - sections:
Steven Liu's avatar
Steven Liu committed
211
212
    - local: api/loaders/ip_adapter
      title: IP-Adapter
Steven Liu's avatar
Steven Liu committed
213
214
215
216
217
218
219
220
    - local: api/loaders/lora
      title: LoRA
    - local: api/loaders/single_file
      title: Single files
    - local: api/loaders/textual_inversion
      title: Textual Inversion
    - local: api/loaders/unet
      title: UNet
221
222
    - local: api/loaders/peft
      title: PEFT
Steven Liu's avatar
Steven Liu committed
223
    title: Loaders
Steven Liu's avatar
Steven Liu committed
224
225
226
227
228
229
230
231
232
233
234
  - sections:
    - local: api/models/overview
      title: Overview
    - local: api/models/unet
      title: UNet1DModel
    - local: api/models/unet2d
      title: UNet2DModel
    - local: api/models/unet2d-cond
      title: UNet2DConditionModel
    - local: api/models/unet3d-cond
      title: UNet3DConditionModel
Dhruv Nair's avatar
Dhruv Nair committed
235
236
    - local: api/models/unet-motion
      title: UNetMotionModel
Steven Liu's avatar
Steven Liu committed
237
238
    - local: api/models/uvit2d
      title: UViT2DModel
Steven Liu's avatar
Steven Liu committed
239
240
241
242
    - local: api/models/vq
      title: VQModel
    - local: api/models/autoencoderkl
      title: AutoencoderKL
Ruslan Vorovchenko's avatar
Ruslan Vorovchenko committed
243
244
    - local: api/models/asymmetricautoencoderkl
      title: AsymmetricAutoencoderKL
245
246
    - local: api/models/autoencoder_tiny
      title: Tiny AutoEncoder
Will Berman's avatar
Will Berman committed
247
248
    - local: api/models/consistency_decoder_vae
      title: ConsistencyDecoderVAE
Steven Liu's avatar
Steven Liu committed
249
250
251
252
253
254
255
256
257
    - local: api/models/transformer2d
      title: Transformer2D
    - local: api/models/transformer_temporal
      title: Transformer Temporal
    - local: api/models/prior_transformer
      title: Prior Transformer
    - local: api/models/controlnet
      title: ControlNet
    title: Models
Nathan Lambert's avatar
Nathan Lambert committed
258
  - sections:
259
    - local: api/pipelines/overview
260
      title: Overview
Will Berman's avatar
Will Berman committed
261
262
    - local: api/pipelines/amused
      title: aMUSEd
Dhruv Nair's avatar
Dhruv Nair committed
263
264
    - local: api/pipelines/animatediff
      title: AnimateDiff
Steven Liu's avatar
Steven Liu committed
265
    - local: api/pipelines/attend_and_excite
266
      title: Attend-and-Excite
Sanchit Gandhi's avatar
Sanchit Gandhi committed
267
268
    - local: api/pipelines/audioldm
      title: AudioLDM
Sanchit Gandhi's avatar
Sanchit Gandhi committed
269
270
    - local: api/pipelines/audioldm2
      title: AudioLDM 2
YiYi Xu's avatar
YiYi Xu committed
271
272
    - local: api/pipelines/auto_pipeline
      title: AutoPipeline
Ayush Mangal's avatar
Ayush Mangal committed
273
    - local: api/pipelines/blip_diffusion
274
      title: BLIP-Diffusion
275
276
    - local: api/pipelines/consistency_models
      title: Consistency Models
277
278
    - local: api/pipelines/controlnet
      title: ControlNet
279
280
    - local: api/pipelines/controlnet_sdxl
      title: ControlNet with Stable Diffusion XL
281
282
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
283
    - local: api/pipelines/ddim
284
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
285
    - local: api/pipelines/ddpm
286
      title: DDPM
Will Berman's avatar
Will Berman committed
287
288
    - local: api/pipelines/deepfloyd_if
      title: DeepFloyd IF
Steven Liu's avatar
Steven Liu committed
289
290
    - local: api/pipelines/diffedit
      title: DiffEdit
Kashif Rasul's avatar
Kashif Rasul committed
291
292
    - local: api/pipelines/dit
      title: DiT
293
294
    - local: api/pipelines/i2vgenxl
      title: I2VGen-XL
Steven Liu's avatar
Steven Liu committed
295
296
    - local: api/pipelines/pix2pix
      title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
297
    - local: api/pipelines/kandinsky
Steven Liu's avatar
Steven Liu committed
298
      title: Kandinsky 2.1
299
300
    - local: api/pipelines/kandinsky_v22
      title: Kandinsky 2.2
301
302
    - local: api/pipelines/kandinsky3
      title: Kandinsky 3
303
304
    - local: api/pipelines/latent_consistency_models
      title: Latent Consistency Models
Patrick von Platen's avatar
Patrick von Platen committed
305
    - local: api/pipelines/latent_diffusion
306
      title: Latent Diffusion
307
308
    - local: api/pipelines/ledits_pp
      title: LEDITS++
Steven Liu's avatar
Steven Liu committed
309
    - local: api/pipelines/panorama
310
      title: MultiDiffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
311
312
    - local: api/pipelines/musicldm
      title: MusicLDM
313
    - local: api/pipelines/paint_by_example
314
      title: Paint by Example
Dhruv Nair's avatar
Dhruv Nair committed
315
316
    - local: api/pipelines/pia
      title: Personalized Image Animator (PIA)
Sayak Paul's avatar
Sayak Paul committed
317
    - local: api/pipelines/pixart
318
      title: PixArt-α
Steven Liu's avatar
Steven Liu committed
319
320
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
321
322
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
YiYi Xu's avatar
YiYi Xu committed
323
324
    - local: api/pipelines/shap_e
      title: Shap-E
325
326
    - local: api/pipelines/stable_cascade
      title: Stable Cascade
327
328
    - sections:
      - local: api/pipelines/stable_diffusion/overview
329
        title: Overview
330
      - local: api/pipelines/stable_diffusion/text2img
331
        title: Text-to-image
332
      - local: api/pipelines/stable_diffusion/img2img
333
        title: Image-to-image
Steven Liu's avatar
Steven Liu committed
334
335
      - local: api/pipelines/stable_diffusion/svd
        title: Image-to-video
336
      - local: api/pipelines/stable_diffusion/inpaint
337
        title: Inpainting
338
      - local: api/pipelines/stable_diffusion/depth2img
339
        title: Depth-to-image
340
      - local: api/pipelines/stable_diffusion/image_variation
341
        title: Image variation
Steven Liu's avatar
Steven Liu committed
342
343
344
345
      - local: api/pipelines/stable_diffusion/stable_diffusion_safe
        title: Safe Stable Diffusion
      - local: api/pipelines/stable_diffusion/stable_diffusion_2
        title: Stable Diffusion 2
Patrick von Platen's avatar
Patrick von Platen committed
346
347
      - local: api/pipelines/stable_diffusion/stable_diffusion_xl
        title: Stable Diffusion XL
348
349
      - local: api/pipelines/stable_diffusion/sdxl_turbo
        title: SDXL Turbo
350
      - local: api/pipelines/stable_diffusion/latent_upscale
351
        title: Latent upscaler
Steven Liu's avatar
Steven Liu committed
352
      - local: api/pipelines/stable_diffusion/upscale
353
        title: Super-resolution
354
355
      - local: api/pipelines/stable_diffusion/k_diffusion
        title: K-Diffusion
estelleafl's avatar
estelleafl committed
356
      - local: api/pipelines/stable_diffusion/ldm3d_diffusion
357
        title: LDM3D Text-to-(RGB, Depth), Text-to-(RGB-pano, Depth-pano), LDM3D Upscaler
Will Berman's avatar
Will Berman committed
358
      - local: api/pipelines/stable_diffusion/adapter
359
        title: Stable Diffusion T2I-Adapter
360
361
      - local: api/pipelines/stable_diffusion/gligen
        title: GLIGEN (Grounded Language-to-Image Generation)
362
      title: Stable Diffusion
Will Berman's avatar
Will Berman committed
363
364
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
365
    - local: api/pipelines/text_to_video
366
      title: Text-to-video
367
    - local: api/pipelines/text_to_video_zero
368
      title: Text2Video-Zero
Will Berman's avatar
Will Berman committed
369
    - local: api/pipelines/unclip
370
      title: unCLIP
371
372
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
Steven Liu's avatar
Steven Liu committed
373
374
    - local: api/pipelines/value_guided_sampling
      title: Value-guided sampling
Kashif Rasul's avatar
Kashif Rasul committed
375
376
    - local: api/pipelines/wuerstchen
      title: Wuerstchen
377
    title: Pipelines
378
379
  - sections:
    - local: api/schedulers/overview
380
      title: Overview
381
    - local: api/schedulers/cm_stochastic_iterative
382
      title: CMStochasticIterativeScheduler
Will Berman's avatar
Will Berman committed
383
384
    - local: api/schedulers/consistency_decoder
      title: ConsistencyDecoderScheduler
385
    - local: api/schedulers/ddim_inverse
386
387
388
      title: DDIMInverseScheduler
    - local: api/schedulers/ddim
      title: DDIMScheduler
389
    - local: api/schedulers/ddpm
390
      title: DDPMScheduler
391
    - local: api/schedulers/deis
392
393
394
395
396
      title: DEISMultistepScheduler
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: DPMSolverMultistepInverse
    - local: api/schedulers/multistep_dpm_solver
      title: DPMSolverMultistepScheduler
397
398
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
399
400
    - local: api/schedulers/singlestep_dpm_solver
      title: DPMSolverSinglestepScheduler
401
    - local: api/schedulers/euler_ancestral
402
      title: EulerAncestralDiscreteScheduler
403
    - local: api/schedulers/euler
404
      title: EulerDiscreteScheduler
405
    - local: api/schedulers/heun
406
      title: HeunDiscreteScheduler
407
    - local: api/schedulers/ipndm
408
409
410
411
412
413
414
      title: IPNDMScheduler
    - local: api/schedulers/stochastic_karras_ve
      title: KarrasVeScheduler
    - local: api/schedulers/dpm_discrete_ancestral
      title: KDPM2AncestralDiscreteScheduler
    - local: api/schedulers/dpm_discrete
      title: KDPM2DiscreteScheduler
415
416
    - local: api/schedulers/lcm
      title: LCMScheduler
417
    - local: api/schedulers/lms_discrete
418
      title: LMSDiscreteScheduler
419
    - local: api/schedulers/pndm
420
      title: PNDMScheduler
421
    - local: api/schedulers/repaint
422
      title: RePaintScheduler
423
    - local: api/schedulers/score_sde_ve
424
      title: ScoreSdeVeScheduler
425
    - local: api/schedulers/score_sde_vp
426
      title: ScoreSdeVpScheduler
Michael's avatar
Michael committed
427
428
    - local: api/schedulers/tcd
      title: TCDScheduler
429
430
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
431
    - local: api/schedulers/vq_diffusion
432
433
      title: VQDiffusionScheduler
    title: Schedulers
434
435
436
437
438
439
440
441
442
443
444
445
446
  - sections:
    - local: api/internal_classes_overview
      title: Overview
    - local: api/attnprocessor
      title: Attention Processor
    - local: api/activations
      title: Custom activation functions
    - local: api/normalization
      title: Custom normalization layers
    - local: api/utilities
      title: Utilities
    - local: api/image_processor
      title: VAE Image Processor
Dhruv Nair's avatar
Dhruv Nair committed
447
    title: Internal classes
448
  title: API