_toctree.yml 9.54 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
    - local: using-diffusers/kerascv
32
      title: Load KerasCV Stable Diffusion checkpoints
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
    - local: using-diffusers/reusing_seeds
50
      title: Improve image quality with deterministic generation
51
    - local: using-diffusers/reproducibility
52
      title: Create reproducible pipelines
53
    - local: using-diffusers/custom_pipeline_examples
54
      title: Community pipelines
55
    - local: using-diffusers/contribute_pipeline
56
      title: How to contribute a community pipeline
57
58
    - local: using-diffusers/stable_diffusion_jax_how_to
      title: Stable Diffusion in JAX/Flax
59
60
    - local: using-diffusers/weighted_prompts
      title: Weighting Prompts
61
    title: Pipelines for Inference
62
63
64
  - sections:
    - local: training/overview
      title: Overview
Steven Liu's avatar
Steven Liu committed
65
66
    - local: training/create_dataset
      title: Create a dataset for training
Steven Liu's avatar
Steven Liu committed
67
68
    - local: training/adapt_a_model
      title: Adapt a model to a new task
69
70
71
72
73
74
75
76
77
78
    - 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)
79
80
    - local: training/controlnet
      title: ControlNet
81
82
    - local: training/instructpix2pix
      title: InstructPix2Pix Training
83
84
    - local: training/custom_diffusion
      title: Custom Diffusion
85
    title: Training
86
87
  - sections:
    - local: using-diffusers/rl
88
      title: Reinforcement Learning
89
    - local: using-diffusers/audio
90
      title: Audio
91
    - local: using-diffusers/other-modalities
92
93
94
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
95
- sections:
96
97
  - local: optimization/opt_overview
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
98
  - local: optimization/fp16
99
    title: Memory and Speed
100
101
  - local: optimization/torch2.0
    title: Torch2.0 support
102
  - local: optimization/xformers
103
    title: xFormers
Patrick von Platen's avatar
Patrick von Platen committed
104
  - local: optimization/onnx
105
    title: ONNX
Patrick von Platen's avatar
Patrick von Platen committed
106
  - local: optimization/open_vino
107
    title: OpenVINO
108
109
  - local: optimization/coreml
    title: Core ML
Patrick von Platen's avatar
Patrick von Platen committed
110
  - local: optimization/mps
111
    title: MPS
112
  - local: optimization/habana
113
    title: Habana Gaudi
114
115
  - local: optimization/tome
    title: Token Merging
116
  title: Optimization/Special Hardware
Patrick von Platen's avatar
Patrick von Platen committed
117
118
- sections:
  - local: conceptual/philosophy
119
    title: Philosophy
120
121
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
122
  - local: conceptual/contribution
123
    title: How to contribute?
124
125
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
126
127
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
128
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
129
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
130
  - sections:
Patrick von Platen's avatar
Patrick von Platen committed
131
    - local: api/models
132
      title: Models
Patrick von Platen's avatar
Patrick von Platen committed
133
    - local: api/diffusion_pipeline
134
      title: Diffusion Pipeline
Patrick von Platen's avatar
Patrick von Platen committed
135
    - local: api/logging
136
      title: Logging
Patrick von Platen's avatar
Patrick von Platen committed
137
    - local: api/configuration
138
      title: Configuration
Patrick von Platen's avatar
Patrick von Platen committed
139
    - local: api/outputs
140
      title: Outputs
141
142
    - local: api/loaders
      title: Loaders
143
    title: Main Classes
Nathan Lambert's avatar
Nathan Lambert committed
144
  - sections:
145
    - local: api/pipelines/overview
146
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
147
    - local: api/pipelines/alt_diffusion
148
149
150
      title: AltDiffusion
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
Sanchit Gandhi's avatar
Sanchit Gandhi committed
151
152
    - local: api/pipelines/audioldm
      title: AudioLDM
153
154
    - local: api/pipelines/controlnet
      title: ControlNet
155
    - local: api/pipelines/cycle_diffusion
156
157
158
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
159
    - local: api/pipelines/ddim
160
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
161
    - local: api/pipelines/ddpm
162
      title: DDPM
Kashif Rasul's avatar
Kashif Rasul committed
163
164
    - local: api/pipelines/dit
      title: DiT
Patrick von Platen's avatar
Patrick von Platen committed
165
166
    - local: api/pipelines/if
      title: IF
Patrick von Platen's avatar
Patrick von Platen committed
167
    - local: api/pipelines/latent_diffusion
168
      title: Latent Diffusion
169
    - local: api/pipelines/paint_by_example
170
      title: PaintByExample
Patrick von Platen's avatar
Patrick von Platen committed
171
    - local: api/pipelines/pndm
172
173
174
175
176
      title: PNDM
    - local: api/pipelines/repaint
      title: RePaint
    - local: api/pipelines/stable_diffusion_safe
      title: Safe Stable Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
177
    - local: api/pipelines/score_sde_ve
178
      title: Score SDE VE
179
180
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
181
    - local: api/pipelines/spectrogram_diffusion
182
      title: Spectrogram Diffusion
183
184
    - sections:
      - local: api/pipelines/stable_diffusion/overview
185
        title: Overview
186
      - local: api/pipelines/stable_diffusion/text2img
187
        title: Text-to-Image
188
      - local: api/pipelines/stable_diffusion/img2img
189
        title: Image-to-Image
190
      - local: api/pipelines/stable_diffusion/inpaint
191
        title: Inpaint
192
      - local: api/pipelines/stable_diffusion/depth2img
193
        title: Depth-to-Image
194
      - local: api/pipelines/stable_diffusion/image_variation
195
        title: Image-Variation
196
      - local: api/pipelines/stable_diffusion/upscale
197
        title: Super-Resolution
198
      - local: api/pipelines/stable_diffusion/latent_upscale
199
        title: Stable-Diffusion-Latent-Upscaler
200
201
      - local: api/pipelines/stable_diffusion/pix2pix
        title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
202
203
      - local: api/pipelines/stable_diffusion/attend_and_excite
        title: Attend and Excite
204
205
      - local: api/pipelines/stable_diffusion/pix2pix_zero
        title: Pix2Pix Zero
206
207
      - local: api/pipelines/stable_diffusion/self_attention_guidance
        title: Self-Attention Guidance
208
209
      - local: api/pipelines/stable_diffusion/panorama
        title: MultiDiffusion Panorama
210
211
      - local: api/pipelines/stable_diffusion/model_editing
        title: Text-to-Image Model Editing
212
213
      - local: api/pipelines/stable_diffusion/diffedit
        title: DiffEdit
214
      title: Stable Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
215
    - local: api/pipelines/stable_diffusion_2
216
      title: Stable Diffusion 2
Will Berman's avatar
Will Berman committed
217
218
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
219
    - local: api/pipelines/stochastic_karras_ve
220
      title: Stochastic Karras VE
221
222
    - local: api/pipelines/text_to_video
      title: Text-to-Video
223
224
    - local: api/pipelines/text_to_video_zero
      title: Text-to-Video Zero
Will Berman's avatar
Will Berman committed
225
    - local: api/pipelines/unclip
226
227
228
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
229
    - local: api/pipelines/versatile_diffusion
230
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
231
    - local: api/pipelines/vq_diffusion
232
233
      title: VQ Diffusion
    title: Pipelines
234
235
  - sections:
    - local: api/schedulers/overview
236
      title: Overview
237
    - local: api/schedulers/ddim
238
      title: DDIM
239
240
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
241
    - local: api/schedulers/ddpm
242
      title: DDPM
243
    - local: api/schedulers/deis
244
      title: DEIS
245
    - local: api/schedulers/dpm_discrete
246
      title: DPM Discrete Scheduler
247
    - local: api/schedulers/dpm_discrete_ancestral
248
      title: DPM Discrete Scheduler with ancestral sampling
249
250
    - local: api/schedulers/dpm_sde
      title: DPMSolverSDEScheduler
251
252
253
254
255
256
    - local: api/schedulers/euler_ancestral
      title: Euler Ancestral Scheduler
    - local: api/schedulers/euler
      title: Euler scheduler
    - local: api/schedulers/heun
      title: Heun Scheduler
257
258
    - local: api/schedulers/multistep_dpm_solver_inverse
      title: Inverse Multistep DPM-Solver
259
260
    - local: api/schedulers/ipndm
      title: IPNDM
261
    - local: api/schedulers/lms_discrete
262
263
264
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
265
    - local: api/schedulers/pndm
266
267
268
269
270
271
272
      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
273
274
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
275
    - local: api/schedulers/score_sde_ve
276
      title: VE-SDE
277
    - local: api/schedulers/score_sde_vp
278
      title: VP-SDE
279
    - local: api/schedulers/vq_diffusion
280
281
      title: VQDiffusionScheduler
    title: Schedulers
282
283
  - sections:
    - local: api/experimental/rl
284
285
286
      title: RL Planning
    title: Experimental Features
  title: API