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