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