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