_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
Steven Liu's avatar
Steven Liu committed
16
17
18
  - local: tutorials/basic_training
    title: Train a diffusion model
  title: Tutorials
Nathan Lambert's avatar
Nathan Lambert committed
19
20
- sections:
  - sections:
21
22
    - local: using-diffusers/loading_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
23
    - local: using-diffusers/loading
24
      title: Load pipelines, models, and schedulers
25
    - local: using-diffusers/schedulers
26
      title: Load and compare different schedulers
27
    - local: using-diffusers/custom_pipeline_overview
28
      title: Load community pipelines
Steven Liu's avatar
Steven Liu committed
29
30
    - local: using-diffusers/using_safetensors
      title: Load safetensors
31
32
    - local: using-diffusers/other-formats
      title: Load different Stable Diffusion formats
33
    title: Loading & Hub
Nathan Lambert's avatar
Nathan Lambert committed
34
  - sections:
35
36
    - local: using-diffusers/pipeline_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
37
    - local: using-diffusers/unconditional_image_generation
38
      title: Unconditional image generation
Patrick von Platen's avatar
Patrick von Platen committed
39
    - local: using-diffusers/conditional_image_generation
40
      title: Text-to-image generation
Patrick von Platen's avatar
Patrick von Platen committed
41
    - local: using-diffusers/img2img
42
      title: Text-guided image-to-image
Patrick von Platen's avatar
Patrick von Platen committed
43
    - local: using-diffusers/inpaint
44
      title: Text-guided image-inpainting
Patrick von Platen's avatar
Patrick von Platen committed
45
    - local: using-diffusers/depth2img
46
      title: Text-guided depth-to-image
47
48
    - local: using-diffusers/textual_inversion_inference
      title: Textual inversion
49
50
    - local: training/distributed_inference
      title: Distributed inference with multiple GPUs
51
    - local: using-diffusers/reusing_seeds
52
      title: Improve image quality with deterministic generation
Steven Liu's avatar
Steven Liu committed
53
54
    - local: using-diffusers/control_brightness
      title: Control image brightness
55
    - local: using-diffusers/reproducibility
56
      title: Create reproducible pipelines
57
    - local: using-diffusers/custom_pipeline_examples
58
      title: Community pipelines
59
    - local: using-diffusers/contribute_pipeline
60
      title: How to contribute a community pipeline
61
62
    - local: using-diffusers/stable_diffusion_jax_how_to
      title: Stable Diffusion in JAX/Flax
63
64
    - local: using-diffusers/weighted_prompts
      title: Weighting Prompts
65
    title: Pipelines for Inference
66
67
68
  - sections:
    - local: training/overview
      title: Overview
Steven Liu's avatar
Steven Liu committed
69
70
    - local: training/create_dataset
      title: Create a dataset for training
Steven Liu's avatar
Steven Liu committed
71
72
    - local: training/adapt_a_model
      title: Adapt a model to a new task
73
74
75
76
77
78
79
80
81
82
    - 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)
83
84
    - local: training/controlnet
      title: ControlNet
85
86
    - local: training/instructpix2pix
      title: InstructPix2Pix Training
87
88
    - local: training/custom_diffusion
      title: Custom Diffusion
89
    title: Training
90
91
  - sections:
    - local: using-diffusers/rl
92
      title: Reinforcement Learning
93
    - local: using-diffusers/audio
94
      title: Audio
95
    - local: using-diffusers/other-modalities
96
97
98
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
99
- sections:
100
101
  - local: optimization/opt_overview
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
102
  - local: optimization/fp16
103
    title: Memory and Speed
104
105
  - local: optimization/torch2.0
    title: Torch2.0 support
106
  - local: optimization/xformers
107
    title: xFormers
Patrick von Platen's avatar
Patrick von Platen committed
108
  - local: optimization/onnx
109
    title: ONNX
Patrick von Platen's avatar
Patrick von Platen committed
110
  - local: optimization/open_vino
111
    title: OpenVINO
112
113
  - local: optimization/coreml
    title: Core ML
Patrick von Platen's avatar
Patrick von Platen committed
114
  - local: optimization/mps
115
    title: MPS
116
  - local: optimization/habana
117
    title: Habana Gaudi
118
119
  - local: optimization/tome
    title: Token Merging
120
121
  - local: optimization/bentoml
    title: BentoML Integration
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
Steven Liu's avatar
Steven Liu committed
171
172
173
174
175
176
177
178
179
    - 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
180
  - sections:
181
    - local: api/pipelines/overview
182
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
183
    - local: api/pipelines/alt_diffusion
184
      title: AltDiffusion
Steven Liu's avatar
Steven Liu committed
185
186
    - local: api/pipelines/attend_and_excite
      title: Attend and Excite
187
188
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
189
190
    - local: api/pipelines/audioldm
      title: AudioLDM
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
Patrick von Platen's avatar
Patrick von Platen committed
213
    - local: api/pipelines/latent_diffusion
214
      title: Latent Diffusion
Steven Liu's avatar
Steven Liu committed
215
216
    - local: api/pipelines/panorama
      title: MultiDiffusion Panorama
217
    - local: api/pipelines/paint_by_example
218
      title: PaintByExample
219
220
    - local: api/pipelines/paradigms
      title: Parallel Sampling of Diffusion Models
Steven Liu's avatar
Steven Liu committed
221
222
    - local: api/pipelines/pix2pix_zero
      title: Pix2Pix Zero
Patrick von Platen's avatar
Patrick von Platen committed
223
    - local: api/pipelines/pndm
224
225
226
      title: PNDM
    - local: api/pipelines/repaint
      title: RePaint
Patrick von Platen's avatar
Patrick von Platen committed
227
    - local: api/pipelines/score_sde_ve
228
      title: Score SDE VE
Steven Liu's avatar
Steven Liu committed
229
230
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
231
232
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
YiYi Xu's avatar
YiYi Xu committed
233
234
    - local: api/pipelines/shap_e
      title: Shap-E
235
    - local: api/pipelines/spectrogram_diffusion
236
      title: Spectrogram Diffusion
237
238
    - sections:
      - local: api/pipelines/stable_diffusion/overview
239
        title: Overview
240
      - local: api/pipelines/stable_diffusion/text2img
241
        title: Text-to-Image
242
      - local: api/pipelines/stable_diffusion/img2img
243
        title: Image-to-Image
244
      - local: api/pipelines/stable_diffusion/inpaint
245
        title: Inpaint
246
      - local: api/pipelines/stable_diffusion/depth2img
247
        title: Depth-to-Image
248
      - local: api/pipelines/stable_diffusion/image_variation
249
        title: Image-Variation
Steven Liu's avatar
Steven Liu committed
250
251
252
253
      - 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
254
255
      - local: api/pipelines/stable_diffusion/stable_diffusion_xl
        title: Stable Diffusion XL
256
      - local: api/pipelines/stable_diffusion/latent_upscale
257
        title: Stable-Diffusion-Latent-Upscaler
Steven Liu's avatar
Steven Liu committed
258
259
      - local: api/pipelines/stable_diffusion/upscale
        title: Super-Resolution
estelleafl's avatar
estelleafl committed
260
261
      - local: api/pipelines/stable_diffusion/ldm3d_diffusion
        title: LDM3D Text-to-(RGB, Depth)
Will Berman's avatar
Will Berman committed
262
263
      - local: api/pipelines/stable_diffusion/adapter
        title: Stable Diffusion T2I-adapter
264
      title: Stable Diffusion
Will Berman's avatar
Will Berman committed
265
266
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
267
    - local: api/pipelines/stochastic_karras_ve
268
      title: Stochastic Karras VE
Steven Liu's avatar
Steven Liu committed
269
270
    - local: api/pipelines/model_editing
      title: Text-to-Image Model Editing
271
272
    - local: api/pipelines/text_to_video
      title: Text-to-Video
273
274
    - local: api/pipelines/text_to_video_zero
      title: Text-to-Video Zero
Will Berman's avatar
Will Berman committed
275
    - local: api/pipelines/unclip
276
277
278
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
279
280
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
281
    - local: api/pipelines/versatile_diffusion
282
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
283
    - local: api/pipelines/vq_diffusion
284
285
      title: VQ Diffusion
    title: Pipelines
286
287
  - sections:
    - local: api/schedulers/overview
288
      title: Overview
289
290
    - local: api/schedulers/cm_stochastic_iterative
      title: Consistency Model Multistep Scheduler
291
    - local: api/schedulers/ddim
292
      title: DDIM
293
294
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
295
    - local: api/schedulers/ddpm
296
      title: DDPM
297
    - local: api/schedulers/deis
298
      title: DEIS
299
    - local: api/schedulers/dpm_discrete
300
      title: DPM Discrete Scheduler
301
    - local: api/schedulers/dpm_discrete_ancestral
302
      title: DPM Discrete Scheduler with ancestral sampling
303
304
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
305
306
307
308
309
310
    - local: api/schedulers/euler_ancestral
      title: Euler Ancestral Scheduler
    - local: api/schedulers/euler
      title: Euler scheduler
    - local: api/schedulers/heun
      title: Heun Scheduler
311
312
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: Inverse Multistep DPM-Solver
313
314
    - local: api/schedulers/ipndm
      title: IPNDM
315
    - local: api/schedulers/lms_discrete
316
317
318
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
319
    - local: api/schedulers/pndm
320
321
322
323
324
325
326
      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
327
328
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
329
    - local: api/schedulers/score_sde_ve
330
      title: VE-SDE
331
    - local: api/schedulers/score_sde_vp
332
      title: VP-SDE
333
    - local: api/schedulers/vq_diffusion
334
335
      title: VQDiffusionScheduler
    title: Schedulers
336
337
  - sections:
    - local: api/experimental/rl
338
339
340
      title: RL Planning
    title: Experimental Features
  title: API