_toctree.yml 12.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
15
  - local: using-diffusers/write_own_pipeline
    title: Understanding models and schedulers
16
17
  - local: tutorials/autopipeline
    title: AutoPipeline
Steven Liu's avatar
Steven Liu committed
18
19
20
  - local: tutorials/basic_training
    title: Train a diffusion model
  title: Tutorials
Nathan Lambert's avatar
Nathan Lambert committed
21
22
- sections:
  - sections:
23
24
    - local: using-diffusers/loading_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
25
    - local: using-diffusers/loading
26
      title: Load pipelines, models, and schedulers
27
    - local: using-diffusers/schedulers
28
      title: Load and compare different schedulers
29
    - local: using-diffusers/custom_pipeline_overview
30
      title: Load community pipelines
Steven Liu's avatar
Steven Liu committed
31
32
    - local: using-diffusers/using_safetensors
      title: Load safetensors
33
34
    - local: using-diffusers/other-formats
      title: Load different Stable Diffusion formats
Steven Liu's avatar
Steven Liu committed
35
36
    - local: using-diffusers/push_to_hub
      title: Push files to the Hub
37
    title: Loading & Hub
Nathan Lambert's avatar
Nathan Lambert committed
38
  - sections:
Patrick von Platen's avatar
Patrick von Platen committed
39
    - local: using-diffusers/unconditional_image_generation
40
      title: Unconditional image generation
Patrick von Platen's avatar
Patrick von Platen committed
41
    - local: using-diffusers/conditional_image_generation
Steven Liu's avatar
Steven Liu committed
42
      title: Text-to-image
Patrick von Platen's avatar
Patrick von Platen committed
43
    - local: using-diffusers/img2img
Steven Liu's avatar
Steven Liu committed
44
      title: Image-to-image
Patrick von Platen's avatar
Patrick von Platen committed
45
    - local: using-diffusers/inpaint
Steven Liu's avatar
Steven Liu committed
46
      title: Inpainting
Patrick von Platen's avatar
Patrick von Platen committed
47
    - local: using-diffusers/depth2img
Steven Liu's avatar
Steven Liu committed
48
49
50
      title: Depth-to-image
    title: Tasks
  - sections:
51
52
    - local: using-diffusers/textual_inversion_inference
      title: Textual inversion
53
54
    - local: training/distributed_inference
      title: Distributed inference with multiple GPUs
55
    - local: using-diffusers/reusing_seeds
56
      title: Improve image quality with deterministic generation
Steven Liu's avatar
Steven Liu committed
57
58
    - local: using-diffusers/control_brightness
      title: Control image brightness
Steven Liu's avatar
Steven Liu committed
59
60
61
62
63
64
65
66
    - local: using-diffusers/weighted_prompts
      title: Prompt weighting
    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
67
68
    - local: using-diffusers/controlnet
      title: ControlNet
Steven Liu's avatar
Steven Liu committed
69
70
    - local: using-diffusers/shap-e
      title: Shap-E
Steven Liu's avatar
Steven Liu committed
71
72
    - local: using-diffusers/diffedit
      title: DiffEdit
Steven Liu's avatar
Steven Liu committed
73
74
    - local: using-diffusers/distilled_sd
      title: Distilled Stable Diffusion inference
75
    - local: using-diffusers/reproducibility
76
      title: Create reproducible pipelines
77
    - local: using-diffusers/custom_pipeline_examples
78
      title: Community pipelines
79
    - local: using-diffusers/contribute_pipeline
80
      title: How to contribute a community pipeline
81
    title: Pipelines for Inference
82
83
84
  - sections:
    - local: training/overview
      title: Overview
Steven Liu's avatar
Steven Liu committed
85
86
    - local: training/create_dataset
      title: Create a dataset for training
Steven Liu's avatar
Steven Liu committed
87
88
    - local: training/adapt_a_model
      title: Adapt a model to a new task
89
90
91
92
93
94
95
96
97
98
    - 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)
99
100
    - local: training/controlnet
      title: ControlNet
101
102
    - local: training/instructpix2pix
      title: InstructPix2Pix Training
103
104
    - local: training/custom_diffusion
      title: Custom Diffusion
105
106
    - local: training/t2i_adapters
      title: T2I-Adapters
107
    title: Training
108
109
  - sections:
    - local: using-diffusers/other-modalities
110
111
112
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
113
- sections:
114
115
  - local: optimization/opt_overview
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
116
  - local: optimization/fp16
117
    title: Memory and Speed
118
119
  - local: optimization/torch2.0
    title: Torch2.0 support
Steven Liu's avatar
Steven Liu committed
120
121
  - local: using-diffusers/stable_diffusion_jax_how_to
    title: Stable Diffusion in JAX/Flax
122
  - local: optimization/xformers
123
    title: xFormers
Patrick von Platen's avatar
Patrick von Platen committed
124
  - local: optimization/onnx
125
    title: ONNX
Patrick von Platen's avatar
Patrick von Platen committed
126
  - local: optimization/open_vino
127
    title: OpenVINO
128
129
  - local: optimization/coreml
    title: Core ML
Patrick von Platen's avatar
Patrick von Platen committed
130
  - local: optimization/mps
131
    title: MPS
132
  - local: optimization/habana
133
    title: Habana Gaudi
134
135
  - local: optimization/tome
    title: Token Merging
136
  title: Optimization/Special Hardware
Patrick von Platen's avatar
Patrick von Platen committed
137
138
- sections:
  - local: conceptual/philosophy
139
    title: Philosophy
140
141
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
142
  - local: conceptual/contribution
143
    title: How to contribute?
144
145
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
146
147
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
148
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
149
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
150
  - sections:
151
152
    - local: api/attnprocessor
      title: Attention Processor
Patrick von Platen's avatar
Patrick von Platen committed
153
    - local: api/diffusion_pipeline
154
      title: Diffusion Pipeline
Patrick von Platen's avatar
Patrick von Platen committed
155
    - local: api/logging
156
      title: Logging
Patrick von Platen's avatar
Patrick von Platen committed
157
    - local: api/configuration
158
      title: Configuration
Patrick von Platen's avatar
Patrick von Platen committed
159
    - local: api/outputs
160
      title: Outputs
161
162
    - local: api/loaders
      title: Loaders
Steven Liu's avatar
Steven Liu committed
163
164
    - local: api/utilities
      title: Utilities
165
    - local: api/image_processor
Steven Liu's avatar
Steven Liu committed
166
      title: VAE Image Processor
167
    title: Main Classes
Steven Liu's avatar
Steven Liu committed
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
  - 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
183
184
    - local: api/models/asymmetricautoencoderkl
      title: AsymmetricAutoencoderKL
185
186
    - local: api/models/autoencoder_tiny
      title: Tiny AutoEncoder
Steven Liu's avatar
Steven Liu committed
187
188
189
190
191
192
193
194
195
    - 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
196
  - sections:
197
    - local: api/pipelines/overview
198
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
199
    - local: api/pipelines/alt_diffusion
200
      title: AltDiffusion
Steven Liu's avatar
Steven Liu committed
201
    - local: api/pipelines/attend_and_excite
202
      title: Attend-and-Excite
203
204
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
205
206
    - local: api/pipelines/audioldm
      title: AudioLDM
Sanchit Gandhi's avatar
Sanchit Gandhi committed
207
208
    - local: api/pipelines/audioldm2
      title: AudioLDM 2
YiYi Xu's avatar
YiYi Xu committed
209
210
    - local: api/pipelines/auto_pipeline
      title: AutoPipeline
211
212
    - local: api/pipelines/consistency_models
      title: Consistency Models
213
214
    - local: api/pipelines/controlnet
      title: ControlNet
215
216
    - local: api/pipelines/controlnet_sdxl
      title: ControlNet with Stable Diffusion XL
217
    - local: api/pipelines/cycle_diffusion
218
219
220
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
221
    - local: api/pipelines/ddim
222
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
223
    - local: api/pipelines/ddpm
224
      title: DDPM
Will Berman's avatar
Will Berman committed
225
226
    - local: api/pipelines/deepfloyd_if
      title: DeepFloyd IF
Steven Liu's avatar
Steven Liu committed
227
228
    - local: api/pipelines/diffedit
      title: DiffEdit
Kashif Rasul's avatar
Kashif Rasul committed
229
230
    - local: api/pipelines/dit
      title: DiT
Steven Liu's avatar
Steven Liu committed
231
232
    - local: api/pipelines/pix2pix
      title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
233
234
    - local: api/pipelines/kandinsky
      title: Kandinsky
235
236
    - local: api/pipelines/kandinsky_v22
      title: Kandinsky 2.2
Patrick von Platen's avatar
Patrick von Platen committed
237
    - local: api/pipelines/latent_diffusion
238
      title: Latent Diffusion
Steven Liu's avatar
Steven Liu committed
239
    - local: api/pipelines/panorama
240
      title: MultiDiffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
241
242
    - local: api/pipelines/musicldm
      title: MusicLDM
243
    - local: api/pipelines/paint_by_example
244
      title: PaintByExample
245
246
    - local: api/pipelines/paradigms
      title: Parallel Sampling of Diffusion Models
Steven Liu's avatar
Steven Liu committed
247
248
    - local: api/pipelines/pix2pix_zero
      title: Pix2Pix Zero
Patrick von Platen's avatar
Patrick von Platen committed
249
    - local: api/pipelines/pndm
250
251
252
      title: PNDM
    - local: api/pipelines/repaint
      title: RePaint
Patrick von Platen's avatar
Patrick von Platen committed
253
    - local: api/pipelines/score_sde_ve
254
      title: Score SDE VE
Steven Liu's avatar
Steven Liu committed
255
256
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
257
258
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
YiYi Xu's avatar
YiYi Xu committed
259
260
    - local: api/pipelines/shap_e
      title: Shap-E
261
    - local: api/pipelines/spectrogram_diffusion
262
      title: Spectrogram Diffusion
263
264
    - sections:
      - local: api/pipelines/stable_diffusion/overview
265
        title: Overview
266
      - local: api/pipelines/stable_diffusion/text2img
267
        title: Text-to-image
268
      - local: api/pipelines/stable_diffusion/img2img
269
        title: Image-to-image
270
      - local: api/pipelines/stable_diffusion/inpaint
271
        title: Inpainting
272
      - local: api/pipelines/stable_diffusion/depth2img
273
        title: Depth-to-image
274
      - local: api/pipelines/stable_diffusion/image_variation
275
        title: Image variation
Steven Liu's avatar
Steven Liu committed
276
277
278
279
      - 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
280
281
      - local: api/pipelines/stable_diffusion/stable_diffusion_xl
        title: Stable Diffusion XL
282
      - local: api/pipelines/stable_diffusion/latent_upscale
283
        title: Latent upscaler
Steven Liu's avatar
Steven Liu committed
284
      - local: api/pipelines/stable_diffusion/upscale
285
        title: Super-resolution
estelleafl's avatar
estelleafl committed
286
287
      - local: api/pipelines/stable_diffusion/ldm3d_diffusion
        title: LDM3D Text-to-(RGB, Depth)
Will Berman's avatar
Will Berman committed
288
289
      - local: api/pipelines/stable_diffusion/adapter
        title: Stable Diffusion T2I-adapter
290
291
      - local: api/pipelines/stable_diffusion/gligen
        title: GLIGEN (Grounded Language-to-Image Generation)
292
      title: Stable Diffusion
Will Berman's avatar
Will Berman committed
293
294
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
295
    - local: api/pipelines/stochastic_karras_ve
296
      title: Stochastic Karras VE
Steven Liu's avatar
Steven Liu committed
297
    - local: api/pipelines/model_editing
298
      title: Text-to-image model editing
299
    - local: api/pipelines/text_to_video
300
      title: Text-to-video
301
    - local: api/pipelines/text_to_video_zero
302
      title: Text2Video-Zero
Will Berman's avatar
Will Berman committed
303
    - local: api/pipelines/unclip
304
305
306
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
307
308
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
Steven Liu's avatar
Steven Liu committed
309
310
    - local: api/pipelines/value_guided_sampling
      title: Value-guided sampling
311
    - local: api/pipelines/versatile_diffusion
312
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
313
    - local: api/pipelines/vq_diffusion
314
      title: VQ Diffusion
Kashif Rasul's avatar
Kashif Rasul committed
315
316
    - local: api/pipelines/wuerstchen
      title: Wuerstchen
317
    title: Pipelines
318
319
  - sections:
    - local: api/schedulers/overview
320
      title: Overview
321
    - local: api/schedulers/cm_stochastic_iterative
322
      title: CMStochasticIterativeScheduler
323
    - local: api/schedulers/ddim_inverse
324
325
326
      title: DDIMInverseScheduler
    - local: api/schedulers/ddim
      title: DDIMScheduler
327
    - local: api/schedulers/ddpm
328
      title: DDPMScheduler
329
    - local: api/schedulers/deis
330
331
332
333
334
      title: DEISMultistepScheduler
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: DPMSolverMultistepInverse
    - local: api/schedulers/multistep_dpm_solver
      title: DPMSolverMultistepScheduler
335
336
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
337
338
    - local: api/schedulers/singlestep_dpm_solver
      title: DPMSolverSinglestepScheduler
339
    - local: api/schedulers/euler_ancestral
340
      title: EulerAncestralDiscreteScheduler
341
    - local: api/schedulers/euler
342
      title: EulerDiscreteScheduler
343
    - local: api/schedulers/heun
344
      title: HeunDiscreteScheduler
345
    - local: api/schedulers/ipndm
346
347
348
349
350
351
352
      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
353
    - local: api/schedulers/lms_discrete
354
      title: LMSDiscreteScheduler
355
    - local: api/schedulers/pndm
356
      title: PNDMScheduler
357
    - local: api/schedulers/repaint
358
      title: RePaintScheduler
359
    - local: api/schedulers/score_sde_ve
360
      title: ScoreSdeVeScheduler
361
    - local: api/schedulers/score_sde_vp
362
363
364
      title: ScoreSdeVpScheduler
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
365
    - local: api/schedulers/vq_diffusion
366
367
368
      title: VQDiffusionScheduler
    title: Schedulers
  title: API