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