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