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