_toctree.yml 11 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
  title: Optimization/Special Hardware
Patrick von Platen's avatar
Patrick von Platen committed
121
122
- sections:
  - local: conceptual/philosophy
123
    title: Philosophy
124
125
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
126
  - local: conceptual/contribution
127
    title: How to contribute?
128
129
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
130
131
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
132
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
133
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
134
  - sections:
135
136
    - local: api/attnprocessor
      title: Attention Processor
Patrick von Platen's avatar
Patrick von Platen committed
137
    - local: api/diffusion_pipeline
138
      title: Diffusion Pipeline
Patrick von Platen's avatar
Patrick von Platen committed
139
    - local: api/logging
140
      title: Logging
Patrick von Platen's avatar
Patrick von Platen committed
141
    - local: api/configuration
142
      title: Configuration
Patrick von Platen's avatar
Patrick von Platen committed
143
    - local: api/outputs
144
      title: Outputs
145
146
    - local: api/loaders
      title: Loaders
Steven Liu's avatar
Steven Liu committed
147
148
    - local: api/utilities
      title: Utilities
149
    - local: api/image_processor
Steven Liu's avatar
Steven Liu committed
150
      title: VAE Image Processor
151
    title: Main Classes
Steven Liu's avatar
Steven Liu committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  - 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
    - 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
176
  - sections:
177
    - local: api/pipelines/overview
178
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
179
    - local: api/pipelines/alt_diffusion
180
      title: AltDiffusion
Steven Liu's avatar
Steven Liu committed
181
182
    - local: api/pipelines/attend_and_excite
      title: Attend and Excite
183
184
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
185
186
    - local: api/pipelines/audioldm
      title: AudioLDM
187
188
    - local: api/pipelines/consistency_models
      title: Consistency Models
189
190
    - local: api/pipelines/controlnet
      title: ControlNet
191
    - local: api/pipelines/cycle_diffusion
192
193
194
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
195
    - local: api/pipelines/ddim
196
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
197
    - local: api/pipelines/ddpm
198
      title: DDPM
Steven Liu's avatar
Steven Liu committed
199
200
    - local: api/pipelines/diffedit
      title: DiffEdit
Kashif Rasul's avatar
Kashif Rasul committed
201
202
    - local: api/pipelines/dit
      title: DiT
Patrick von Platen's avatar
Patrick von Platen committed
203
204
    - local: api/pipelines/if
      title: IF
Steven Liu's avatar
Steven Liu committed
205
206
    - local: api/pipelines/pix2pix
      title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
207
208
    - local: api/pipelines/kandinsky
      title: Kandinsky
Patrick von Platen's avatar
Patrick von Platen committed
209
    - local: api/pipelines/latent_diffusion
210
      title: Latent Diffusion
Steven Liu's avatar
Steven Liu committed
211
212
    - local: api/pipelines/panorama
      title: MultiDiffusion Panorama
213
    - local: api/pipelines/paint_by_example
214
      title: PaintByExample
215
216
    - local: api/pipelines/paradigms
      title: Parallel Sampling of Diffusion Models
Steven Liu's avatar
Steven Liu committed
217
218
    - local: api/pipelines/pix2pix_zero
      title: Pix2Pix Zero
Patrick von Platen's avatar
Patrick von Platen committed
219
    - local: api/pipelines/pndm
220
221
222
      title: PNDM
    - local: api/pipelines/repaint
      title: RePaint
Patrick von Platen's avatar
Patrick von Platen committed
223
    - local: api/pipelines/score_sde_ve
224
      title: Score SDE VE
Steven Liu's avatar
Steven Liu committed
225
226
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
227
228
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
YiYi Xu's avatar
YiYi Xu committed
229
230
    - local: api/pipelines/shap_e
      title: Shap-E
231
    - local: api/pipelines/spectrogram_diffusion
232
      title: Spectrogram Diffusion
233
234
    - sections:
      - local: api/pipelines/stable_diffusion/overview
235
        title: Overview
236
      - local: api/pipelines/stable_diffusion/text2img
237
        title: Text-to-Image
238
      - local: api/pipelines/stable_diffusion/img2img
239
        title: Image-to-Image
240
      - local: api/pipelines/stable_diffusion/inpaint
241
        title: Inpaint
242
      - local: api/pipelines/stable_diffusion/depth2img
243
        title: Depth-to-Image
244
      - local: api/pipelines/stable_diffusion/image_variation
245
        title: Image-Variation
Steven Liu's avatar
Steven Liu committed
246
247
248
249
      - local: api/pipelines/stable_diffusion/stable_diffusion_safe
        title: Safe Stable Diffusion
      - local: api/pipelines/stable_diffusion/stable_diffusion_2
        title: Stable Diffusion 2
250
      - local: api/pipelines/stable_diffusion/latent_upscale
251
        title: Stable-Diffusion-Latent-Upscaler
Steven Liu's avatar
Steven Liu committed
252
253
      - local: api/pipelines/stable_diffusion/upscale
        title: Super-Resolution
estelleafl's avatar
estelleafl committed
254
255
      - local: api/pipelines/stable_diffusion/ldm3d_diffusion
        title: LDM3D Text-to-(RGB, Depth)
256
      title: Stable Diffusion
Will Berman's avatar
Will Berman committed
257
258
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
259
    - local: api/pipelines/stochastic_karras_ve
260
      title: Stochastic Karras VE
Steven Liu's avatar
Steven Liu committed
261
262
    - local: api/pipelines/model_editing
      title: Text-to-Image Model Editing
263
264
    - local: api/pipelines/text_to_video
      title: Text-to-Video
265
266
    - local: api/pipelines/text_to_video_zero
      title: Text-to-Video Zero
Will Berman's avatar
Will Berman committed
267
    - local: api/pipelines/unclip
268
269
270
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
271
272
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
273
    - local: api/pipelines/versatile_diffusion
274
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
275
    - local: api/pipelines/vq_diffusion
276
277
      title: VQ Diffusion
    title: Pipelines
278
279
  - sections:
    - local: api/schedulers/overview
280
      title: Overview
281
282
    - local: api/schedulers/cm_stochastic_iterative
      title: Consistency Model Multistep Scheduler
283
    - local: api/schedulers/ddim
284
      title: DDIM
285
286
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
287
    - local: api/schedulers/ddpm
288
      title: DDPM
289
    - local: api/schedulers/deis
290
      title: DEIS
291
    - local: api/schedulers/dpm_discrete
292
      title: DPM Discrete Scheduler
293
    - local: api/schedulers/dpm_discrete_ancestral
294
      title: DPM Discrete Scheduler with ancestral sampling
295
296
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
297
298
299
300
301
302
    - local: api/schedulers/euler_ancestral
      title: Euler Ancestral Scheduler
    - local: api/schedulers/euler
      title: Euler scheduler
    - local: api/schedulers/heun
      title: Heun Scheduler
303
304
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: Inverse Multistep DPM-Solver
305
306
    - local: api/schedulers/ipndm
      title: IPNDM
307
    - local: api/schedulers/lms_discrete
308
309
310
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
311
    - local: api/schedulers/pndm
312
313
314
315
316
317
318
      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
319
320
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
321
    - local: api/schedulers/score_sde_ve
322
      title: VE-SDE
323
    - local: api/schedulers/score_sde_vp
324
      title: VP-SDE
325
    - local: api/schedulers/vq_diffusion
326
327
      title: VQDiffusionScheduler
    title: Schedulers
328
329
  - sections:
    - local: api/experimental/rl
330
331
332
      title: RL Planning
    title: Experimental Features
  title: API