_toctree.yml 9.76 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
53
    - local: using-diffusers/reproducibility
54
      title: Create reproducible pipelines
55
    - local: using-diffusers/custom_pipeline_examples
56
      title: Community pipelines
57
    - local: using-diffusers/contribute_pipeline
58
      title: How to contribute a community pipeline
59
60
    - local: using-diffusers/stable_diffusion_jax_how_to
      title: Stable Diffusion in JAX/Flax
61
62
    - local: using-diffusers/weighted_prompts
      title: Weighting Prompts
63
    title: Pipelines for Inference
64
65
66
  - sections:
    - local: training/overview
      title: Overview
Steven Liu's avatar
Steven Liu committed
67
68
    - local: training/create_dataset
      title: Create a dataset for training
Steven Liu's avatar
Steven Liu committed
69
70
    - local: training/adapt_a_model
      title: Adapt a model to a new task
71
72
73
74
75
76
77
78
79
80
    - 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)
81
82
    - local: training/controlnet
      title: ControlNet
83
84
    - local: training/instructpix2pix
      title: InstructPix2Pix Training
85
86
    - local: training/custom_diffusion
      title: Custom Diffusion
87
    title: Training
88
89
  - sections:
    - local: using-diffusers/rl
90
      title: Reinforcement Learning
91
    - local: using-diffusers/audio
92
      title: Audio
93
    - 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:
Patrick von Platen's avatar
Patrick von Platen committed
133
    - local: api/models
134
      title: Models
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
    title: Main Classes
Nathan Lambert's avatar
Nathan Lambert committed
150
  - sections:
151
    - local: api/pipelines/overview
152
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
153
    - local: api/pipelines/alt_diffusion
154
      title: AltDiffusion
Steven Liu's avatar
Steven Liu committed
155
156
    - local: api/pipelines/attend_and_excite
      title: Attend and Excite
157
158
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
159
160
    - local: api/pipelines/audioldm
      title: AudioLDM
161
162
    - local: api/pipelines/controlnet
      title: ControlNet
163
    - local: api/pipelines/cycle_diffusion
164
165
166
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
167
    - local: api/pipelines/ddim
168
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
169
    - local: api/pipelines/ddpm
170
      title: DDPM
Steven Liu's avatar
Steven Liu committed
171
172
    - local: api/pipelines/diffedit
      title: DiffEdit
Kashif Rasul's avatar
Kashif Rasul committed
173
174
    - local: api/pipelines/dit
      title: DiT
Patrick von Platen's avatar
Patrick von Platen committed
175
176
    - local: api/pipelines/if
      title: IF
Steven Liu's avatar
Steven Liu committed
177
178
    - local: api/pipelines/pix2pix
      title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
179
180
    - local: api/pipelines/kandinsky
      title: Kandinsky
Patrick von Platen's avatar
Patrick von Platen committed
181
    - local: api/pipelines/latent_diffusion
182
      title: Latent Diffusion
Steven Liu's avatar
Steven Liu committed
183
184
    - local: api/pipelines/panorama
      title: MultiDiffusion Panorama
185
    - local: api/pipelines/paint_by_example
186
      title: PaintByExample
Steven Liu's avatar
Steven Liu committed
187
188
    - local: api/pipelines/pix2pix_zero
      title: Pix2Pix Zero
Patrick von Platen's avatar
Patrick von Platen committed
189
    - local: api/pipelines/pndm
190
191
192
      title: PNDM
    - local: api/pipelines/repaint
      title: RePaint
Patrick von Platen's avatar
Patrick von Platen committed
193
    - local: api/pipelines/score_sde_ve
194
      title: Score SDE VE
Steven Liu's avatar
Steven Liu committed
195
196
    - local: api/pipelines/self_attention_guidance
      title: Self-Attention Guidance
197
198
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
199
    - local: api/pipelines/spectrogram_diffusion
200
      title: Spectrogram Diffusion
201
202
    - sections:
      - local: api/pipelines/stable_diffusion/overview
203
        title: Overview
204
      - local: api/pipelines/stable_diffusion/text2img
205
        title: Text-to-Image
206
      - local: api/pipelines/stable_diffusion/img2img
207
        title: Image-to-Image
208
      - local: api/pipelines/stable_diffusion/inpaint
209
        title: Inpaint
210
      - local: api/pipelines/stable_diffusion/depth2img
211
        title: Depth-to-Image
212
      - local: api/pipelines/stable_diffusion/image_variation
213
        title: Image-Variation
Steven Liu's avatar
Steven Liu committed
214
215
216
217
      - local: api/pipelines/stable_diffusion/stable_diffusion_safe
        title: Safe Stable Diffusion
      - local: api/pipelines/stable_diffusion/stable_diffusion_2
        title: Stable Diffusion 2
218
      - local: api/pipelines/stable_diffusion/latent_upscale
219
        title: Stable-Diffusion-Latent-Upscaler
Steven Liu's avatar
Steven Liu committed
220
221
      - local: api/pipelines/stable_diffusion/upscale
        title: Super-Resolution
222
      title: Stable Diffusion
Will Berman's avatar
Will Berman committed
223
224
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
225
    - local: api/pipelines/stochastic_karras_ve
226
      title: Stochastic Karras VE
Steven Liu's avatar
Steven Liu committed
227
228
    - local: api/pipelines/model_editing
      title: Text-to-Image Model Editing
229
230
    - local: api/pipelines/text_to_video
      title: Text-to-Video
231
232
    - local: api/pipelines/text_to_video_zero
      title: Text-to-Video Zero
Will Berman's avatar
Will Berman committed
233
    - local: api/pipelines/unclip
234
235
236
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
237
238
    - local: api/pipelines/unidiffuser
      title: UniDiffuser
239
    - local: api/pipelines/versatile_diffusion
240
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
241
    - local: api/pipelines/vq_diffusion
242
243
      title: VQ Diffusion
    title: Pipelines
244
245
  - sections:
    - local: api/schedulers/overview
246
      title: Overview
247
    - local: api/schedulers/ddim
248
      title: DDIM
249
250
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
251
    - local: api/schedulers/ddpm
252
      title: DDPM
253
    - local: api/schedulers/deis
254
      title: DEIS
255
    - local: api/schedulers/dpm_discrete
256
      title: DPM Discrete Scheduler
257
    - local: api/schedulers/dpm_discrete_ancestral
258
      title: DPM Discrete Scheduler with ancestral sampling
259
260
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
261
262
263
264
265
266
    - local: api/schedulers/euler_ancestral
      title: Euler Ancestral Scheduler
    - local: api/schedulers/euler
      title: Euler scheduler
    - local: api/schedulers/heun
      title: Heun Scheduler
267
268
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: Inverse Multistep DPM-Solver
269
270
    - local: api/schedulers/ipndm
      title: IPNDM
271
    - local: api/schedulers/lms_discrete
272
273
274
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
275
    - local: api/schedulers/pndm
276
277
278
279
280
281
282
      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
283
284
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
285
    - local: api/schedulers/score_sde_ve
286
      title: VE-SDE
287
    - local: api/schedulers/score_sde_vp
288
      title: VP-SDE
289
    - local: api/schedulers/vq_diffusion
290
291
      title: VQDiffusionScheduler
    title: Schedulers
292
293
  - sections:
    - local: api/experimental/rl
294
295
296
      title: RL Planning
    title: Experimental Features
  title: API