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