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