_toctree.yml 14.6 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
21
  - local: tutorials/using_peft_for_inference
    title: Inference with PEFT
Steven Liu's avatar
Steven Liu committed
22
  title: Tutorials
Nathan Lambert's avatar
Nathan Lambert committed
23
24
- sections:
  - sections:
25
26
    - local: using-diffusers/loading_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
27
    - local: using-diffusers/loading
28
      title: Load pipelines, models, and schedulers
29
    - local: using-diffusers/schedulers
30
      title: Load and compare different schedulers
31
    - local: using-diffusers/custom_pipeline_overview
32
      title: Load community pipelines and components
Steven Liu's avatar
Steven Liu committed
33
34
    - local: using-diffusers/using_safetensors
      title: Load safetensors
35
36
    - local: using-diffusers/other-formats
      title: Load different Stable Diffusion formats
Steven Liu's avatar
Steven Liu committed
37
38
    - local: using-diffusers/loading_adapters
      title: Load adapters
Steven Liu's avatar
Steven Liu committed
39
40
    - local: using-diffusers/push_to_hub
      title: Push files to the Hub
41
    title: Loading & Hub
Nathan Lambert's avatar
Nathan Lambert committed
42
  - sections:
Steven Liu's avatar
Steven Liu committed
43
44
    - local: using-diffusers/pipeline_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
45
    - local: using-diffusers/unconditional_image_generation
46
      title: Unconditional image generation
Patrick von Platen's avatar
Patrick von Platen committed
47
    - local: using-diffusers/conditional_image_generation
Steven Liu's avatar
Steven Liu committed
48
      title: Text-to-image
Patrick von Platen's avatar
Patrick von Platen committed
49
    - local: using-diffusers/img2img
Steven Liu's avatar
Steven Liu committed
50
      title: Image-to-image
Patrick von Platen's avatar
Patrick von Platen committed
51
    - local: using-diffusers/inpaint
Steven Liu's avatar
Steven Liu committed
52
      title: Inpainting
Patrick von Platen's avatar
Patrick von Platen committed
53
    - local: using-diffusers/depth2img
Steven Liu's avatar
Steven Liu committed
54
55
56
      title: Depth-to-image
    title: Tasks
  - sections:
57
58
    - local: using-diffusers/textual_inversion_inference
      title: Textual inversion
59
60
    - local: training/distributed_inference
      title: Distributed inference with multiple GPUs
61
    - local: using-diffusers/reusing_seeds
62
      title: Improve image quality with deterministic generation
Steven Liu's avatar
Steven Liu committed
63
64
    - local: using-diffusers/control_brightness
      title: Control image brightness
Steven Liu's avatar
Steven Liu committed
65
66
    - local: using-diffusers/weighted_prompts
      title: Prompt weighting
67
68
    - local: using-diffusers/freeu
      title: Improve generation quality with FreeU
Steven Liu's avatar
Steven Liu committed
69
70
71
72
73
74
    title: Techniques
  - sections:
    - local: using-diffusers/pipeline_overview
      title: Overview
    - local: using-diffusers/sdxl
      title: Stable Diffusion XL
Steven Liu's avatar
Steven Liu committed
75
76
    - local: using-diffusers/kandinsky
      title: Kandinsky
Steven Liu's avatar
Steven Liu committed
77
78
    - local: using-diffusers/controlnet
      title: ControlNet
Steven Liu's avatar
Steven Liu committed
79
80
    - local: using-diffusers/shap-e
      title: Shap-E
Steven Liu's avatar
Steven Liu committed
81
82
    - local: using-diffusers/diffedit
      title: DiffEdit
Steven Liu's avatar
Steven Liu committed
83
84
    - local: using-diffusers/distilled_sd
      title: Distilled Stable Diffusion inference
Steven Liu's avatar
Steven Liu committed
85
86
    - local: using-diffusers/callback
      title: Pipeline callbacks
87
    - local: using-diffusers/reproducibility
88
      title: Create reproducible pipelines
89
    - local: using-diffusers/custom_pipeline_examples
90
      title: Community pipelines
91
    - local: using-diffusers/contribute_pipeline
Steven Liu's avatar
Steven Liu committed
92
      title: Contribute a community pipeline
Suraj Patil's avatar
Suraj Patil committed
93
94
95
96
    - local: using-diffusers/inference_with_lcm_lora
      title: Latent Consistency Model-LoRA
    - local: using-diffusers/inference_with_lcm
      title: Latent Consistency Model
Steven Liu's avatar
Steven Liu committed
97
    title: Specific pipeline examples
98
99
100
  - sections:
    - local: training/overview
      title: Overview
Steven Liu's avatar
Steven Liu committed
101
102
    - local: training/create_dataset
      title: Create a dataset for training
Steven Liu's avatar
Steven Liu committed
103
104
    - local: training/adapt_a_model
      title: Adapt a model to a new task
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
    - 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
      - local: training/ddpo
        title: Reinforcement learning training with DDPO
      title: Methods
135
    title: Training
136
137
  - sections:
    - local: using-diffusers/other-modalities
138
139
140
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
141
- sections:
142
143
  - local: optimization/opt_overview
    title: Overview
144
145
146
147
148
149
  - sections:
    - local: optimization/fp16
      title: Speed up inference
    - local: optimization/memory
      title: Reduce memory usage
    - local: optimization/torch2.0
150
      title: PyTorch 2.0
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
    - local: optimization/xformers
      title: xFormers
    - local: optimization/tome
      title: Token merging
    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
173
174
- sections:
  - local: conceptual/philosophy
175
    title: Philosophy
176
177
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
178
  - local: conceptual/contribution
179
    title: How to contribute?
180
181
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
182
183
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
184
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
185
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
186
  - sections:
Patrick von Platen's avatar
Patrick von Platen committed
187
    - local: api/configuration
188
      title: Configuration
189
190
191
192
    - local: api/logging
      title: Logging
    - local: api/outputs
      title: Outputs
193
    title: Main Classes
Steven Liu's avatar
Steven Liu committed
194
195
196
197
198
199
200
201
202
203
  - sections:
    - 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
    title: Loaders
Steven Liu's avatar
Steven Liu committed
204
205
206
207
208
209
210
211
212
213
214
  - 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
215
216
    - local: api/models/unet-motion
      title: UNetMotionModel
Steven Liu's avatar
Steven Liu committed
217
218
219
220
    - local: api/models/vq
      title: VQModel
    - local: api/models/autoencoderkl
      title: AutoencoderKL
Ruslan Vorovchenko's avatar
Ruslan Vorovchenko committed
221
222
    - local: api/models/asymmetricautoencoderkl
      title: AsymmetricAutoencoderKL
223
224
    - local: api/models/autoencoder_tiny
      title: Tiny AutoEncoder
Will Berman's avatar
Will Berman committed
225
226
    - local: api/models/consistency_decoder_vae
      title: ConsistencyDecoderVAE
Steven Liu's avatar
Steven Liu committed
227
228
229
230
231
232
233
234
235
    - 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
236
  - sections:
237
    - local: api/pipelines/overview
238
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
239
    - local: api/pipelines/alt_diffusion
240
      title: AltDiffusion
Dhruv Nair's avatar
Dhruv Nair committed
241
242
    - local: api/pipelines/animatediff
      title: AnimateDiff
Steven Liu's avatar
Steven Liu committed
243
    - local: api/pipelines/attend_and_excite
244
      title: Attend-and-Excite
245
246
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
247
248
    - local: api/pipelines/audioldm
      title: AudioLDM
Sanchit Gandhi's avatar
Sanchit Gandhi committed
249
250
    - local: api/pipelines/audioldm2
      title: AudioLDM 2
YiYi Xu's avatar
YiYi Xu committed
251
252
    - local: api/pipelines/auto_pipeline
      title: AutoPipeline
Ayush Mangal's avatar
Ayush Mangal committed
253
    - local: api/pipelines/blip_diffusion
254
      title: BLIP-Diffusion
255
256
    - local: api/pipelines/consistency_models
      title: Consistency Models
257
258
    - local: api/pipelines/controlnet
      title: ControlNet
259
260
    - local: api/pipelines/controlnet_sdxl
      title: ControlNet with Stable Diffusion XL
261
    - local: api/pipelines/cycle_diffusion
262
263
264
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
265
    - local: api/pipelines/ddim
266
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
267
    - local: api/pipelines/ddpm
268
      title: DDPM
Will Berman's avatar
Will Berman committed
269
270
    - local: api/pipelines/deepfloyd_if
      title: DeepFloyd IF
Steven Liu's avatar
Steven Liu committed
271
272
    - local: api/pipelines/diffedit
      title: DiffEdit
Kashif Rasul's avatar
Kashif Rasul committed
273
274
    - local: api/pipelines/dit
      title: DiT
Steven Liu's avatar
Steven Liu committed
275
276
    - local: api/pipelines/pix2pix
      title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
277
    - local: api/pipelines/kandinsky
Steven Liu's avatar
Steven Liu committed
278
      title: Kandinsky 2.1
279
280
    - local: api/pipelines/kandinsky_v22
      title: Kandinsky 2.2
281
282
    - local: api/pipelines/kandinsky3
      title: Kandinsky 3
283
284
    - local: api/pipelines/latent_consistency_models
      title: Latent Consistency Models
Patrick von Platen's avatar
Patrick von Platen committed
285
    - local: api/pipelines/latent_diffusion
286
      title: Latent Diffusion
Steven Liu's avatar
Steven Liu committed
287
    - local: api/pipelines/panorama
288
      title: MultiDiffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
289
290
    - local: api/pipelines/musicldm
      title: MusicLDM
291
    - local: api/pipelines/paint_by_example
292
      title: Paint by Example
293
294
    - local: api/pipelines/paradigms
      title: Parallel Sampling of Diffusion Models
Steven Liu's avatar
Steven Liu committed
295
296
    - local: api/pipelines/pix2pix_zero
      title: Pix2Pix Zero
Sayak Paul's avatar
Sayak Paul committed
297
    - local: api/pipelines/pixart
298
      title: PixArt-α
Patrick von Platen's avatar
Patrick von Platen committed
299
    - local: api/pipelines/pndm
300
301
302
      title: PNDM
    - local: api/pipelines/repaint
      title: RePaint
Patrick von Platen's avatar
Patrick von Platen committed
303
    - local: api/pipelines/score_sde_ve
304
      title: Score SDE VE
Steven Liu's avatar
Steven Liu committed
305
306
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
307
308
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
YiYi Xu's avatar
YiYi Xu committed
309
310
    - local: api/pipelines/shap_e
      title: Shap-E
311
    - local: api/pipelines/spectrogram_diffusion
312
      title: Spectrogram Diffusion
313
314
    - sections:
      - local: api/pipelines/stable_diffusion/overview
315
        title: Overview
316
      - local: api/pipelines/stable_diffusion/text2img
317
        title: Text-to-image
318
      - local: api/pipelines/stable_diffusion/img2img
319
        title: Image-to-image
320
      - local: api/pipelines/stable_diffusion/inpaint
321
        title: Inpainting
322
      - local: api/pipelines/stable_diffusion/depth2img
323
        title: Depth-to-image
324
      - local: api/pipelines/stable_diffusion/image_variation
325
        title: Image variation
Steven Liu's avatar
Steven Liu committed
326
327
328
329
      - 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
330
331
      - local: api/pipelines/stable_diffusion/stable_diffusion_xl
        title: Stable Diffusion XL
332
      - local: api/pipelines/stable_diffusion/latent_upscale
333
        title: Latent upscaler
Steven Liu's avatar
Steven Liu committed
334
      - local: api/pipelines/stable_diffusion/upscale
335
        title: Super-resolution
estelleafl's avatar
estelleafl committed
336
      - local: api/pipelines/stable_diffusion/ldm3d_diffusion
337
        title: LDM3D Text-to-(RGB, Depth), Text-to-(RGB-pano, Depth-pano), LDM3D Upscaler
Will Berman's avatar
Will Berman committed
338
      - local: api/pipelines/stable_diffusion/adapter
339
        title: Stable Diffusion T2I-Adapter
340
341
      - local: api/pipelines/stable_diffusion/gligen
        title: GLIGEN (Grounded Language-to-Image Generation)
342
      title: Stable Diffusion
Will Berman's avatar
Will Berman committed
343
344
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
345
    - local: api/pipelines/stochastic_karras_ve
346
      title: Stochastic Karras VE
Steven Liu's avatar
Steven Liu committed
347
    - local: api/pipelines/model_editing
348
      title: Text-to-image model editing
349
    - local: api/pipelines/text_to_video
350
      title: Text-to-video
351
    - local: api/pipelines/text_to_video_zero
352
      title: Text2Video-Zero
Will Berman's avatar
Will Berman committed
353
    - local: api/pipelines/unclip
354
      title: unCLIP
355
356
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
357
358
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
Steven Liu's avatar
Steven Liu committed
359
360
    - local: api/pipelines/value_guided_sampling
      title: Value-guided sampling
361
    - local: api/pipelines/versatile_diffusion
362
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
363
    - local: api/pipelines/vq_diffusion
364
      title: VQ Diffusion
Kashif Rasul's avatar
Kashif Rasul committed
365
366
    - local: api/pipelines/wuerstchen
      title: Wuerstchen
367
    title: Pipelines
368
369
  - sections:
    - local: api/schedulers/overview
370
      title: Overview
371
    - local: api/schedulers/cm_stochastic_iterative
372
      title: CMStochasticIterativeScheduler
Will Berman's avatar
Will Berman committed
373
374
    - local: api/schedulers/consistency_decoder
      title: ConsistencyDecoderScheduler
375
    - local: api/schedulers/ddim_inverse
376
377
378
      title: DDIMInverseScheduler
    - local: api/schedulers/ddim
      title: DDIMScheduler
379
    - local: api/schedulers/ddpm
380
      title: DDPMScheduler
381
    - local: api/schedulers/deis
382
383
384
385
386
      title: DEISMultistepScheduler
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: DPMSolverMultistepInverse
    - local: api/schedulers/multistep_dpm_solver
      title: DPMSolverMultistepScheduler
387
388
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
389
390
    - local: api/schedulers/singlestep_dpm_solver
      title: DPMSolverSinglestepScheduler
391
    - local: api/schedulers/euler_ancestral
392
      title: EulerAncestralDiscreteScheduler
393
    - local: api/schedulers/euler
394
      title: EulerDiscreteScheduler
395
    - local: api/schedulers/heun
396
      title: HeunDiscreteScheduler
397
    - local: api/schedulers/ipndm
398
399
400
401
402
403
404
      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
405
406
    - local: api/schedulers/lcm
      title: LCMScheduler
407
    - local: api/schedulers/lms_discrete
408
      title: LMSDiscreteScheduler
409
    - local: api/schedulers/pndm
410
      title: PNDMScheduler
411
    - local: api/schedulers/repaint
412
      title: RePaintScheduler
413
    - local: api/schedulers/score_sde_ve
414
      title: ScoreSdeVeScheduler
415
    - local: api/schedulers/score_sde_vp
416
417
418
      title: ScoreSdeVpScheduler
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
419
    - local: api/schedulers/vq_diffusion
420
421
      title: VQDiffusionScheduler
    title: Schedulers
422
423
424
425
426
427
428
429
430
431
432
433
434
  - 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
435
    title: Internal classes
436
  title: API