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