_toctree.yml 23.9 KB
Newer Older
Steven Liu's avatar
Steven Liu committed
1
2
- title: Get started
  sections:
Nathan Lambert's avatar
Nathan Lambert committed
3
  - local: index
Steven Liu's avatar
Steven Liu committed
4
5
6
    title: Diffusers
  - local: installation
    title: Installation
Nathan Lambert's avatar
Nathan Lambert committed
7
  - local: quicktour
Steven Liu's avatar
Steven Liu committed
8
    title: Quickstart
Patrick von Platen's avatar
Patrick von Platen committed
9
  - local: stable_diffusion
10
    title: Basic performance
Steven Liu's avatar
Steven Liu committed
11

12
- title: Pipelines
Steven Liu's avatar
Steven Liu committed
13
14
  isExpanded: false
  sections:
Steven Liu's avatar
Steven Liu committed
15
  - local: using-diffusers/loading
16
    title: DiffusionPipeline
Steven Liu's avatar
Steven Liu committed
17
18
  - local: tutorials/autopipeline
    title: AutoPipeline
Steven Liu's avatar
Steven Liu committed
19
  - local: using-diffusers/custom_pipeline_overview
20
    title: Community pipelines and components
Steven Liu's avatar
Steven Liu committed
21
22
23
  - local: using-diffusers/callback
    title: Pipeline callbacks
  - local: using-diffusers/reusing_seeds
Steven Liu's avatar
Steven Liu committed
24
    title: Reproducibility
Steven Liu's avatar
Steven Liu committed
25
26
  - local: using-diffusers/schedulers
    title: Load schedulers and models
Steven Liu's avatar
Steven Liu committed
27
28
  - local: using-diffusers/scheduler_features
    title: Scheduler features
Steven Liu's avatar
Steven Liu committed
29
  - local: using-diffusers/other-formats
Steven Liu's avatar
Steven Liu committed
30
    title: Model files and layouts
Steven Liu's avatar
Steven Liu committed
31
  - local: using-diffusers/push_to_hub
32
    title: Sharing pipelines and models
Steven Liu's avatar
Steven Liu committed
33
34
35
36

- title: Adapters
  isExpanded: false
  sections:
Steven Liu's avatar
Steven Liu committed
37
38
39
40
41
42
43
44
45
46
47
48
  - local: tutorials/using_peft_for_inference
    title: LoRA
  - local: using-diffusers/ip_adapter
    title: IP-Adapter
  - local: using-diffusers/controlnet
    title: ControlNet
  - local: using-diffusers/t2i_adapter
    title: T2I-Adapter
  - local: using-diffusers/dreambooth
    title: DreamBooth
  - local: using-diffusers/textual_inversion_inference
    title: Textual inversion
Steven Liu's avatar
Steven Liu committed
49
50

- title: Inference
Steven Liu's avatar
Steven Liu committed
51
  isExpanded: false
Steven Liu's avatar
Steven Liu committed
52
53
54
  sections:
  - local: using-diffusers/weighted_prompts
    title: Prompt techniques
Grant Sherrick's avatar
Grant Sherrick committed
55
56
  - local: using-diffusers/create_a_server
    title: Create a server
Steven Liu's avatar
Steven Liu committed
57
58
  - local: using-diffusers/batched_inference
    title: Batch inference
Steven Liu's avatar
Steven Liu committed
59
  - local: training/distributed_inference
Steven Liu's avatar
Steven Liu committed
60
    title: Distributed inference
Steven Liu's avatar
Steven Liu committed
61
62
63
64
65
66
67
68
69
70
71

- title: Inference optimization
  isExpanded: false
  sections:
  - local: optimization/fp16
    title: Accelerate inference
  - local: optimization/cache
    title: Caching
  - local: optimization/memory
    title: Reduce memory usage
  - local: optimization/speed-memory-optims
72
    title: Compiling and offloading quantized models
Steven Liu's avatar
Steven Liu committed
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
  - 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
89
90
    - local: using-diffusers/image_quality
      title: FreeU
Steven Liu's avatar
Steven Liu committed
91
92
93
94

- title: Hybrid Inference
  isExpanded: false
  sections:
95
96
97
98
  - local: hybrid_inference/overview
    title: Overview
  - local: hybrid_inference/vae_decode
    title: VAE Decode
99
100
  - local: hybrid_inference/vae_encode
    title: VAE Encode
101
102
  - local: hybrid_inference/api_reference
    title: API Reference
Steven Liu's avatar
Steven Liu committed
103
104
105
106

- title: Modular Diffusers
  isExpanded: false
  sections:
YiYi Xu's avatar
YiYi Xu committed
107
108
  - local: modular_diffusers/overview
    title: Overview
Steven Liu's avatar
Steven Liu committed
109
110
  - local: modular_diffusers/quickstart
    title: Quickstart
YiYi Xu's avatar
YiYi Xu committed
111
  - local: modular_diffusers/modular_diffusers_states
Steven Liu's avatar
Steven Liu committed
112
    title: States
YiYi Xu's avatar
YiYi Xu committed
113
  - local: modular_diffusers/pipeline_block
Steven Liu's avatar
Steven Liu committed
114
    title: ModularPipelineBlocks
YiYi Xu's avatar
YiYi Xu committed
115
  - local: modular_diffusers/sequential_pipeline_blocks
Steven Liu's avatar
Steven Liu committed
116
    title: SequentialPipelineBlocks
YiYi Xu's avatar
YiYi Xu committed
117
  - local: modular_diffusers/loop_sequential_pipeline_blocks
Steven Liu's avatar
Steven Liu committed
118
    title: LoopSequentialPipelineBlocks
YiYi Xu's avatar
YiYi Xu committed
119
  - local: modular_diffusers/auto_pipeline_blocks
Steven Liu's avatar
Steven Liu committed
120
121
122
123
124
125
126
    title: AutoPipelineBlocks
  - local: modular_diffusers/modular_pipeline
    title: ModularPipeline
  - local: modular_diffusers/components_manager
    title: ComponentsManager
  - local: modular_diffusers/guiders
    title: Guiders
Steven Liu's avatar
Steven Liu committed
127
128
129
130

- title: Training
  isExpanded: false
  sections:
Steven Liu's avatar
Steven Liu committed
131
132
133
134
135
136
  - 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
Steven Liu's avatar
Steven Liu committed
137
138
139
  - local: tutorials/basic_training
    title: Train a diffusion model
  - title: Models
Dhruv Nair's avatar
Dhruv Nair committed
140
    sections:
Steven Liu's avatar
Steven Liu committed
141
    - local: training/unconditional_training
142
      title: Unconditional image generation
Steven Liu's avatar
Steven Liu committed
143
    - local: training/text2image
Steven Liu's avatar
Steven Liu committed
144
      title: Text-to-image
Steven Liu's avatar
Steven Liu committed
145
    - local: training/sdxl
Steven Liu's avatar
Steven Liu committed
146
      title: Stable Diffusion XL
Steven Liu's avatar
Steven Liu committed
147
148
149
150
151
    - local: training/kandinsky
      title: Kandinsky 2.2
    - local: training/wuerstchen
      title: Wuerstchen
    - local: training/controlnet
Steven Liu's avatar
Steven Liu committed
152
      title: ControlNet
Steven Liu's avatar
Steven Liu committed
153
154
155
156
    - local: training/t2i_adapters
      title: T2I-Adapters
    - local: training/instructpix2pix
      title: InstructPix2Pix
glide-the's avatar
glide-the committed
157
158
    - local: training/cogvideox
      title: CogVideoX
Steven Liu's avatar
Steven Liu committed
159
  - title: Methods
Dhruv Nair's avatar
Dhruv Nair committed
160
    sections:
Steven Liu's avatar
Steven Liu committed
161
162
163
164
165
166
167
168
169
170
171
172
    - 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
Steven Liu's avatar
Steven Liu committed
173
174
175
176

- title: Quantization
  isExpanded: false
  sections:
177
  - local: quantization/overview
Steven Liu's avatar
Steven Liu committed
178
    title: Getting started
179
180
  - local: quantization/bitsandbytes
    title: bitsandbytes
181
182
  - local: quantization/gguf
    title: gguf
Aryan's avatar
Aryan committed
183
184
  - local: quantization/torchao
    title: torchao
hlky's avatar
hlky committed
185
  - local: quantization/quanto
186
    title: quanto
187
188
  - local: quantization/modelopt
    title: NVIDIA ModelOpt
Steven Liu's avatar
Steven Liu committed
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

- title: Model accelerators and hardware
  isExpanded: false
  sections:
  - local: optimization/onnx
    title: ONNX
  - local: optimization/open_vino
    title: OpenVINO
  - local: optimization/coreml
    title: Core ML
  - local: optimization/mps
    title: Metal Performance Shaders (MPS)
  - local: optimization/habana
    title: Intel Gaudi
  - local: optimization/neuron
    title: AWS Neuron

- title: Specific pipeline examples
  isExpanded: false
  sections:
  - local: using-diffusers/consisid
    title: ConsisID
  - 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: 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
Patrick von Platen's avatar
Patrick von Platen committed
257
  - local: conceptual/philosophy
258
    title: Philosophy
259
260
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
261
  - local: conceptual/contribution
262
    title: How to contribute?
263
264
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
265
266
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
Steven Liu's avatar
Steven Liu committed
267
268
269
270
271

- title: API
  isExpanded: false
  sections:
  - title: Main Classes
Dhruv Nair's avatar
Dhruv Nair committed
272
    sections:
Patrick von Platen's avatar
Patrick von Platen committed
273
    - local: api/configuration
274
      title: Configuration
275
276
277
278
    - local: api/logging
      title: Logging
    - local: api/outputs
      title: Outputs
279
280
    - local: api/quantization
      title: Quantization
Steven Liu's avatar
Steven Liu committed
281
282
283
284
285
286
287
288
289
290
291
292
  - title: Modular
    sections:
    - local: api/modular_diffusers/pipeline
      title: Pipeline
    - local: api/modular_diffusers/pipeline_blocks
      title: Blocks
    - local: api/modular_diffusers/pipeline_states
      title: States
    - local: api/modular_diffusers/pipeline_components
      title: Components and configs
    - local: api/modular_diffusers/guiders
      title: Guiders
Steven Liu's avatar
Steven Liu committed
293
  - title: Loaders
Dhruv Nair's avatar
Dhruv Nair committed
294
    sections:
Steven Liu's avatar
Steven Liu committed
295
296
    - local: api/loaders/ip_adapter
      title: IP-Adapter
Steven Liu's avatar
Steven Liu committed
297
298
299
300
301
302
303
304
    - 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
305
306
    - local: api/loaders/transformer_sd3
      title: SD3Transformer2D
307
308
    - local: api/loaders/peft
      title: PEFT
Steven Liu's avatar
Steven Liu committed
309
  - title: Models
Dhruv Nair's avatar
Dhruv Nair committed
310
    sections:
Steven Liu's avatar
Steven Liu committed
311
312
    - local: api/models/overview
      title: Overview
hlky's avatar
hlky committed
313
314
    - local: api/models/auto_model
      title: AutoModel
Steven Liu's avatar
Steven Liu committed
315
316
    - title: ControlNets
      sections:
317
318
      - local: api/models/controlnet
        title: ControlNetModel
319
320
      - local: api/models/controlnet_union
        title: ControlNetUnionModel
321
322
      - local: api/models/controlnet_flux
        title: FluxControlNetModel
323
324
      - local: api/models/controlnet_hunyuandit
        title: HunyuanDiT2DControlNetModel
325
326
      - local: api/models/controlnet_sana
        title: SanaControlNetModel
327
328
329
330
      - local: api/models/controlnet_sd3
        title: SD3ControlNetModel
      - local: api/models/controlnet_sparsectrl
        title: SparseControlNetModel
Steven Liu's avatar
Steven Liu committed
331
332
    - title: Transformers
      sections:
Aryan's avatar
Aryan committed
333
334
      - local: api/models/allegro_transformer3d
        title: AllegroTransformer3DModel
335
336
      - local: api/models/aura_flow_transformer2d
        title: AuraFlowTransformer2DModel
galbria's avatar
galbria committed
337
338
      - local: api/models/bria_transformer
        title: BriaTransformer2DModel
Edna's avatar
Edna committed
339
340
      - local: api/models/chroma_transformer
        title: ChromaTransformer2DModel
341
342
      - local: api/models/cogvideox_transformer3d
        title: CogVideoXTransformer3DModel
Yuxuan.Zhang's avatar
Yuxuan.Zhang committed
343
344
      - local: api/models/cogview3plus_transformer2d
        title: CogView3PlusTransformer2DModel
345
346
      - local: api/models/cogview4_transformer2d
        title: CogView4Transformer2DModel
347
348
      - local: api/models/consisid_transformer3d
        title: ConsisIDTransformer3DModel
Aryan's avatar
Aryan committed
349
350
      - local: api/models/cosmos_transformer3d
        title: CosmosTransformer3DModel
351
352
      - local: api/models/dit_transformer2d
        title: DiTTransformer2DModel
353
354
      - local: api/models/easyanimate_transformer3d
        title: EasyAnimateTransformer3DModel
355
356
      - local: api/models/flux_transformer
        title: FluxTransformer2DModel
hlky's avatar
hlky committed
357
358
      - local: api/models/hidream_image_transformer
        title: HiDreamImageTransformer2DModel
359
360
      - local: api/models/hunyuan_transformer2d
        title: HunyuanDiT2DModel
Aryan's avatar
Aryan committed
361
362
      - local: api/models/hunyuan_video_transformer_3d
        title: HunyuanVideoTransformer3DModel
363
364
      - local: api/models/latte_transformer3d
        title: LatteTransformer3DModel
Aryan's avatar
Aryan committed
365
366
      - local: api/models/ltx_video_transformer3d
        title: LTXVideoTransformer3DModel
367
368
369
370
      - local: api/models/lumina2_transformer2d
        title: Lumina2Transformer2DModel
      - local: api/models/lumina_nextdit2d
        title: LuminaNextDiT2DModel
Aryan's avatar
Aryan committed
371
372
      - local: api/models/mochi_transformer3d
        title: MochiTransformer3DModel
Shitao Xiao's avatar
Shitao Xiao committed
373
374
      - local: api/models/omnigen_transformer
        title: OmniGenTransformer2DModel
375
376
377
378
      - local: api/models/pixart_transformer2d
        title: PixArtTransformer2DModel
      - local: api/models/prior_transformer
        title: PriorTransformer
379
380
      - local: api/models/qwenimage_transformer2d
        title: QwenImageTransformer2DModel
381
382
      - local: api/models/sana_transformer2d
        title: SanaTransformer2DModel
383
384
      - local: api/models/sd3_transformer2d
        title: SD3Transformer2DModel
385
386
      - local: api/models/skyreels_v2_transformer_3d
        title: SkyReelsV2Transformer3DModel
387
388
389
390
391
392
      - local: api/models/stable_audio_transformer
        title: StableAudioDiTModel
      - local: api/models/transformer2d
        title: Transformer2DModel
      - local: api/models/transformer_temporal
        title: TransformerTemporalModel
393
394
      - local: api/models/wan_transformer_3d
        title: WanTransformer3DModel
Steven Liu's avatar
Steven Liu committed
395
396
    - title: UNets
      sections:
397
398
399
400
401
402
      - local: api/models/stable_cascade_unet
        title: StableCascadeUNet
      - local: api/models/unet
        title: UNet1DModel
      - local: api/models/unet2d-cond
        title: UNet2DConditionModel
403
404
      - local: api/models/unet2d
        title: UNet2DModel
405
406
407
408
409
410
      - local: api/models/unet3d-cond
        title: UNet3DConditionModel
      - local: api/models/unet-motion
        title: UNetMotionModel
      - local: api/models/uvit2d
        title: UViT2DModel
Steven Liu's avatar
Steven Liu committed
411
412
    - title: VAEs
      sections:
413
414
415
416
      - local: api/models/asymmetricautoencoderkl
        title: AsymmetricAutoencoderKL
      - local: api/models/autoencoder_dc
        title: AutoencoderDC
417
418
      - local: api/models/autoencoderkl
        title: AutoencoderKL
Aryan's avatar
Aryan committed
419
420
      - local: api/models/autoencoderkl_allegro
        title: AutoencoderKLAllegro
421
422
      - local: api/models/autoencoderkl_cogvideox
        title: AutoencoderKLCogVideoX
Aryan's avatar
Aryan committed
423
424
      - local: api/models/autoencoderkl_cosmos
        title: AutoencoderKLCosmos
Aryan's avatar
Aryan committed
425
426
      - local: api/models/autoencoder_kl_hunyuan_video
        title: AutoencoderKLHunyuanVideo
Aryan's avatar
Aryan committed
427
428
      - local: api/models/autoencoderkl_ltx_video
        title: AutoencoderKLLTXVideo
429
430
      - local: api/models/autoencoderkl_magvit
        title: AutoencoderKLMagvit
Aryan's avatar
Aryan committed
431
432
      - local: api/models/autoencoderkl_mochi
        title: AutoencoderKLMochi
433
434
      - local: api/models/autoencoderkl_qwenimage
        title: AutoencoderKLQwenImage
435
436
      - local: api/models/autoencoder_kl_wan
        title: AutoencoderKLWan
437
438
439
440
441
442
443
444
      - local: api/models/consistency_decoder_vae
        title: ConsistencyDecoderVAE
      - local: api/models/autoencoder_oobleck
        title: Oobleck AutoEncoder
      - local: api/models/autoencoder_tiny
        title: Tiny AutoEncoder
      - local: api/models/vq
        title: VQModel
Steven Liu's avatar
Steven Liu committed
445
  - title: Pipelines
Dhruv Nair's avatar
Dhruv Nair committed
446
    sections:
447
    - local: api/pipelines/overview
448
      title: Overview
Aryan's avatar
Aryan committed
449
450
    - local: api/pipelines/allegro
      title: Allegro
Will Berman's avatar
Will Berman committed
451
452
    - local: api/pipelines/amused
      title: aMUSEd
Dhruv Nair's avatar
Dhruv Nair committed
453
454
    - local: api/pipelines/animatediff
      title: AnimateDiff
Steven Liu's avatar
Steven Liu committed
455
    - local: api/pipelines/attend_and_excite
456
      title: Attend-and-Excite
Sanchit Gandhi's avatar
Sanchit Gandhi committed
457
458
    - local: api/pipelines/audioldm
      title: AudioLDM
Sanchit Gandhi's avatar
Sanchit Gandhi committed
459
460
    - local: api/pipelines/audioldm2
      title: AudioLDM 2
Sayak Paul's avatar
Sayak Paul committed
461
462
    - local: api/pipelines/aura_flow
      title: AuraFlow
YiYi Xu's avatar
YiYi Xu committed
463
464
    - local: api/pipelines/auto_pipeline
      title: AutoPipeline
Ayush Mangal's avatar
Ayush Mangal committed
465
    - local: api/pipelines/blip_diffusion
466
      title: BLIP-Diffusion
galbria's avatar
galbria committed
467
468
    - local: api/pipelines/bria_3_2
      title: Bria 3.2
Edna's avatar
Edna committed
469
470
    - local: api/pipelines/chroma
      title: Chroma
471
472
    - local: api/pipelines/cogvideox
      title: CogVideoX
Yuxuan.Zhang's avatar
Yuxuan.Zhang committed
473
474
    - local: api/pipelines/cogview3
      title: CogView3
475
476
    - local: api/pipelines/cogview4
      title: CogView4
Shenghai Yuan's avatar
Shenghai Yuan committed
477
478
    - local: api/pipelines/consisid
      title: ConsisID
479
480
    - local: api/pipelines/consistency_models
      title: Consistency Models
481
482
    - local: api/pipelines/controlnet
      title: ControlNet
483
484
    - local: api/pipelines/controlnet_flux
      title: ControlNet with Flux.1
485
486
    - local: api/pipelines/controlnet_hunyuandit
      title: ControlNet with Hunyuan-DiT
487
488
    - local: api/pipelines/controlnet_sd3
      title: ControlNet with Stable Diffusion 3
489
490
    - local: api/pipelines/controlnet_sdxl
      title: ControlNet with Stable Diffusion XL
491
492
    - local: api/pipelines/controlnet_sana
      title: ControlNet-Sana
493
494
495
496
    - local: api/pipelines/controlnetxs
      title: ControlNet-XS
    - local: api/pipelines/controlnetxs_sdxl
      title: ControlNet-XS with Stable Diffusion XL
hlky's avatar
hlky committed
497
498
    - local: api/pipelines/controlnet_union
      title: ControlNetUnion
Aryan's avatar
Aryan committed
499
500
    - local: api/pipelines/cosmos
      title: Cosmos
501
502
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
503
    - local: api/pipelines/ddim
504
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
505
    - local: api/pipelines/ddpm
506
      title: DDPM
Will Berman's avatar
Will Berman committed
507
508
    - local: api/pipelines/deepfloyd_if
      title: DeepFloyd IF
Steven Liu's avatar
Steven Liu committed
509
510
    - local: api/pipelines/diffedit
      title: DiffEdit
Kashif Rasul's avatar
Kashif Rasul committed
511
512
    - local: api/pipelines/dit
      title: DiT
513
514
    - local: api/pipelines/easyanimate
      title: EasyAnimate
Sayak Paul's avatar
Sayak Paul committed
515
516
    - local: api/pipelines/flux
      title: Flux
517
518
    - local: api/pipelines/control_flux_inpaint
      title: FluxControlInpaint
Aryan's avatar
Aryan committed
519
520
    - local: api/pipelines/framepack
      title: Framepack
hlky's avatar
hlky committed
521
522
    - local: api/pipelines/hidream
      title: HiDream-I1
523
524
    - local: api/pipelines/hunyuandit
      title: Hunyuan-DiT
Aryan's avatar
Aryan committed
525
526
    - local: api/pipelines/hunyuan_video
      title: HunyuanVideo
527
528
    - local: api/pipelines/i2vgenxl
      title: I2VGen-XL
Steven Liu's avatar
Steven Liu committed
529
530
    - local: api/pipelines/pix2pix
      title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
531
    - local: api/pipelines/kandinsky
Steven Liu's avatar
Steven Liu committed
532
      title: Kandinsky 2.1
533
534
    - local: api/pipelines/kandinsky_v22
      title: Kandinsky 2.2
535
536
    - local: api/pipelines/kandinsky3
      title: Kandinsky 3
Álvaro Somoza's avatar
Álvaro Somoza committed
537
    - local: api/pipelines/kolors
Sayak Paul's avatar
Sayak Paul committed
538
      title: Kolors
539
540
    - local: api/pipelines/latent_consistency_models
      title: Latent Consistency Models
Patrick von Platen's avatar
Patrick von Platen committed
541
    - local: api/pipelines/latent_diffusion
542
      title: Latent Diffusion
Aryan's avatar
Aryan committed
543
544
    - local: api/pipelines/latte
      title: Latte
545
546
    - local: api/pipelines/ledits_pp
      title: LEDITS++
Aryan's avatar
Aryan committed
547
    - local: api/pipelines/ltx_video
548
      title: LTXVideo
Le Zhuo's avatar
Le Zhuo committed
549
550
    - local: api/pipelines/lumina2
      title: Lumina 2.0
551
552
    - local: api/pipelines/lumina
      title: Lumina-T2X
553
554
    - local: api/pipelines/marigold
      title: Marigold
Aryan's avatar
Aryan committed
555
556
    - local: api/pipelines/mochi
      title: Mochi
Steven Liu's avatar
Steven Liu committed
557
    - local: api/pipelines/panorama
558
      title: MultiDiffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
559
560
    - local: api/pipelines/musicldm
      title: MusicLDM
Shitao Xiao's avatar
Shitao Xiao committed
561
562
    - local: api/pipelines/omnigen
      title: OmniGen
YiYi Xu's avatar
YiYi Xu committed
563
564
    - local: api/pipelines/pag
      title: PAG
565
    - local: api/pipelines/paint_by_example
566
      title: Paint by Example
Dhruv Nair's avatar
Dhruv Nair committed
567
568
    - local: api/pipelines/pia
      title: Personalized Image Animator (PIA)
Sayak Paul's avatar
Sayak Paul committed
569
    - local: api/pipelines/pixart
570
      title: PixArt-α
571
572
    - local: api/pipelines/pixart_sigma
      title: PixArt-Σ
573
574
    - local: api/pipelines/qwenimage
      title: QwenImage
575
576
    - local: api/pipelines/sana
      title: Sana
YiYi Xu's avatar
YiYi Xu committed
577
578
    - local: api/pipelines/sana_sprint
      title: Sana Sprint
Steven Liu's avatar
Steven Liu committed
579
580
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
581
582
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
YiYi Xu's avatar
YiYi Xu committed
583
584
    - local: api/pipelines/shap_e
      title: Shap-E
585
586
    - local: api/pipelines/skyreels_v2
      title: SkyReels-V2
587
588
    - local: api/pipelines/stable_audio
      title: Stable Audio
589
590
    - local: api/pipelines/stable_cascade
      title: Stable Cascade
Steven Liu's avatar
Steven Liu committed
591
592
    - title: Stable Diffusion
      sections:
593
      - local: api/pipelines/stable_diffusion/overview
594
        title: Overview
595
596
597
598
599
600
      - local: api/pipelines/stable_diffusion/depth2img
        title: Depth-to-image
      - local: api/pipelines/stable_diffusion/gligen
        title: GLIGEN (Grounded Language-to-Image Generation)
      - local: api/pipelines/stable_diffusion/image_variation
        title: Image variation
601
      - local: api/pipelines/stable_diffusion/img2img
602
        title: Image-to-image
Steven Liu's avatar
Steven Liu committed
603
604
      - local: api/pipelines/stable_diffusion/svd
        title: Image-to-video
605
      - local: api/pipelines/stable_diffusion/inpaint
606
        title: Inpainting
607
608
609
610
611
612
      - local: api/pipelines/stable_diffusion/k_diffusion
        title: K-Diffusion
      - local: api/pipelines/stable_diffusion/latent_upscale
        title: Latent upscaler
      - local: api/pipelines/stable_diffusion/ldm3d_diffusion
        title: LDM3D Text-to-(RGB, Depth), Text-to-(RGB-pano, Depth-pano), LDM3D Upscaler
Steven Liu's avatar
Steven Liu committed
613
614
      - local: api/pipelines/stable_diffusion/stable_diffusion_safe
        title: Safe Stable Diffusion
615
616
      - local: api/pipelines/stable_diffusion/sdxl_turbo
        title: SDXL Turbo
Steven Liu's avatar
Steven Liu committed
617
618
      - local: api/pipelines/stable_diffusion/stable_diffusion_2
        title: Stable Diffusion 2
Dhruv Nair's avatar
Dhruv Nair committed
619
620
      - local: api/pipelines/stable_diffusion/stable_diffusion_3
        title: Stable Diffusion 3
Patrick von Platen's avatar
Patrick von Platen committed
621
622
      - local: api/pipelines/stable_diffusion/stable_diffusion_xl
        title: Stable Diffusion XL
Steven Liu's avatar
Steven Liu committed
623
      - local: api/pipelines/stable_diffusion/upscale
624
        title: Super-resolution
Will Berman's avatar
Will Berman committed
625
      - local: api/pipelines/stable_diffusion/adapter
Steven Liu's avatar
Steven Liu committed
626
        title: T2I-Adapter
627
628
      - local: api/pipelines/stable_diffusion/text2img
        title: Text-to-image
Will Berman's avatar
Will Berman committed
629
630
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
631
    - local: api/pipelines/text_to_video
632
      title: Text-to-video
633
    - local: api/pipelines/text_to_video_zero
634
      title: Text2Video-Zero
Will Berman's avatar
Will Berman committed
635
    - local: api/pipelines/unclip
636
      title: unCLIP
637
638
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
Steven Liu's avatar
Steven Liu committed
639
640
    - local: api/pipelines/value_guided_sampling
      title: Value-guided sampling
Zhong-Yu Li's avatar
Zhong-Yu Li committed
641
642
    - local: api/pipelines/visualcloze
      title: VisualCloze
643
644
    - local: api/pipelines/wan
      title: Wan
Kashif Rasul's avatar
Kashif Rasul committed
645
646
    - local: api/pipelines/wuerstchen
      title: Wuerstchen
Steven Liu's avatar
Steven Liu committed
647
  - title: Schedulers
Dhruv Nair's avatar
Dhruv Nair committed
648
    sections:
649
    - local: api/schedulers/overview
650
      title: Overview
651
    - local: api/schedulers/cm_stochastic_iterative
652
      title: CMStochasticIterativeScheduler
653
654
655
656
    - local: api/schedulers/ddim_cogvideox
      title: CogVideoXDDIMScheduler
    - local: api/schedulers/multistep_dpm_solver_cogvideox
      title: CogVideoXDPMScheduler
Will Berman's avatar
Will Berman committed
657
658
    - local: api/schedulers/consistency_decoder
      title: ConsistencyDecoderScheduler
659
660
    - local: api/schedulers/cosine_dpm
      title: CosineDPMSolverMultistepScheduler
661
    - local: api/schedulers/ddim_inverse
662
663
664
      title: DDIMInverseScheduler
    - local: api/schedulers/ddim
      title: DDIMScheduler
665
    - local: api/schedulers/ddpm
666
      title: DDPMScheduler
667
    - local: api/schedulers/deis
668
669
670
671
672
      title: DEISMultistepScheduler
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: DPMSolverMultistepInverse
    - local: api/schedulers/multistep_dpm_solver
      title: DPMSolverMultistepScheduler
673
674
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
675
676
    - local: api/schedulers/singlestep_dpm_solver
      title: DPMSolverSinglestepScheduler
Sayak Paul's avatar
Sayak Paul committed
677
678
679
680
    - local: api/schedulers/edm_multistep_dpm_solver
      title: EDMDPMSolverMultistepScheduler
    - local: api/schedulers/edm_euler
      title: EDMEulerScheduler
681
    - local: api/schedulers/euler_ancestral
682
      title: EulerAncestralDiscreteScheduler
683
    - local: api/schedulers/euler
684
      title: EulerDiscreteScheduler
Dhruv Nair's avatar
Dhruv Nair committed
685
686
    - local: api/schedulers/flow_match_euler_discrete
      title: FlowMatchEulerDiscreteScheduler
687
688
    - local: api/schedulers/flow_match_heun_discrete
      title: FlowMatchHeunDiscreteScheduler
689
    - local: api/schedulers/heun
690
      title: HeunDiscreteScheduler
691
    - local: api/schedulers/ipndm
692
693
694
695
696
697
698
      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
699
700
    - local: api/schedulers/lcm
      title: LCMScheduler
701
    - local: api/schedulers/lms_discrete
702
      title: LMSDiscreteScheduler
703
    - local: api/schedulers/pndm
704
      title: PNDMScheduler
705
    - local: api/schedulers/repaint
706
      title: RePaintScheduler
707
    - local: api/schedulers/score_sde_ve
708
      title: ScoreSdeVeScheduler
709
    - local: api/schedulers/score_sde_vp
710
      title: ScoreSdeVpScheduler
Michael's avatar
Michael committed
711
712
    - local: api/schedulers/tcd
      title: TCDScheduler
713
714
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
715
    - local: api/schedulers/vq_diffusion
716
      title: VQDiffusionScheduler
Steven Liu's avatar
Steven Liu committed
717
  - title: Internal classes
Dhruv Nair's avatar
Dhruv Nair committed
718
    sections:
719
720
721
722
723
724
    - local: api/internal_classes_overview
      title: Overview
    - local: api/attnprocessor
      title: Attention Processor
    - local: api/activations
      title: Custom activation functions
725
726
    - local: api/cache
      title: Caching methods
727
728
729
730
731
732
    - local: api/normalization
      title: Custom normalization layers
    - local: api/utilities
      title: Utilities
    - local: api/image_processor
      title: VAE Image Processor
733
734
    - local: api/video_processor
      title: Video Processor