_toctree.yml 8.88 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: Stable 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/weighted_prompts
      title: Weighting Prompts
57
    title: Pipelines for Inference
58
59
60
61
62
63
64
65
66
67
68
69
70
  - 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)
71
72
    - local: training/controlnet
      title: ControlNet
73
    title: Training
74
75
  - sections:
    - local: using-diffusers/rl
76
      title: Reinforcement Learning
77
    - local: using-diffusers/audio
78
      title: Audio
79
    - local: using-diffusers/other-modalities
80
81
82
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
83
- sections:
84
85
  - local: optimization/opt_overview
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
86
  - local: optimization/fp16
87
    title: Memory and Speed
88
89
  - local: optimization/torch2.0
    title: Torch2.0 support
90
  - local: optimization/xformers
91
    title: xFormers
Patrick von Platen's avatar
Patrick von Platen committed
92
  - local: optimization/onnx
93
    title: ONNX
Patrick von Platen's avatar
Patrick von Platen committed
94
  - local: optimization/open_vino
95
    title: OpenVINO
Patrick von Platen's avatar
Patrick von Platen committed
96
  - local: optimization/mps
97
    title: MPS
98
  - local: optimization/habana
99
100
    title: Habana Gaudi
  title: Optimization/Special Hardware
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
- 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)
  - local: training/instructpix2pix
    title: InstructPix2Pix Training
  title: Training
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
151
    - local: api/pipelines/cycle_diffusion
152
153
154
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
155
    - local: api/pipelines/ddim
156
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
157
    - local: api/pipelines/ddpm
158
      title: DDPM
Kashif Rasul's avatar
Kashif Rasul committed
159
160
    - local: api/pipelines/dit
      title: DiT
Patrick von Platen's avatar
Patrick von Platen committed
161
    - local: api/pipelines/latent_diffusion
162
      title: Latent Diffusion
163
    - local: api/pipelines/paint_by_example
164
      title: PaintByExample
Patrick von Platen's avatar
Patrick von Platen committed
165
    - local: api/pipelines/pndm
166
167
168
169
170
      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
171
    - local: api/pipelines/score_sde_ve
172
      title: Score SDE VE
173
174
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
175
176
    - sections:
      - local: api/pipelines/stable_diffusion/overview
177
        title: Overview
178
      - local: api/pipelines/stable_diffusion/text2img
179
        title: Text-to-Image
180
      - local: api/pipelines/stable_diffusion/img2img
181
        title: Image-to-Image
182
      - local: api/pipelines/stable_diffusion/inpaint
183
        title: Inpaint
184
      - local: api/pipelines/stable_diffusion/depth2img
185
        title: Depth-to-Image
186
      - local: api/pipelines/stable_diffusion/image_variation
187
        title: Image-Variation
188
      - local: api/pipelines/stable_diffusion/upscale
189
        title: Super-Resolution
190
      - local: api/pipelines/stable_diffusion/latent_upscale
191
        title: Stable-Diffusion-Latent-Upscaler
192
193
      - local: api/pipelines/stable_diffusion/pix2pix
        title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
194
195
      - local: api/pipelines/stable_diffusion/attend_and_excite
        title: Attend and Excite
196
197
      - local: api/pipelines/stable_diffusion/pix2pix_zero
        title: Pix2Pix Zero
198
199
      - local: api/pipelines/stable_diffusion/self_attention_guidance
        title: Self-Attention Guidance
200
201
      - local: api/pipelines/stable_diffusion/panorama
        title: MultiDiffusion Panorama
202
203
      - local: api/pipelines/stable_diffusion/controlnet
        title: Text-to-Image Generation with ControlNet Conditioning
204
      title: Stable Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
205
    - local: api/pipelines/stable_diffusion_2
206
      title: Stable Diffusion 2
Will Berman's avatar
Will Berman committed
207
208
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
209
    - local: api/pipelines/stochastic_karras_ve
210
      title: Stochastic Karras VE
211
212
    - local: api/pipelines/text_to_video
      title: Text-to-Video
Will Berman's avatar
Will Berman committed
213
    - local: api/pipelines/unclip
214
215
216
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
217
    - local: api/pipelines/versatile_diffusion
218
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
219
    - local: api/pipelines/vq_diffusion
220
221
      title: VQ Diffusion
    title: Pipelines
222
223
  - sections:
    - local: api/schedulers/overview
224
      title: Overview
225
    - local: api/schedulers/ddim
226
      title: DDIM
227
228
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
229
    - local: api/schedulers/ddpm
230
      title: DDPM
231
    - local: api/schedulers/deis
232
      title: DEIS
233
    - local: api/schedulers/dpm_discrete
234
      title: DPM Discrete Scheduler
235
    - local: api/schedulers/dpm_discrete_ancestral
236
237
238
239
240
241
242
243
244
      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
245
    - local: api/schedulers/lms_discrete
246
247
248
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
249
    - local: api/schedulers/pndm
250
251
252
253
254
255
256
      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
257
258
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
259
    - local: api/schedulers/score_sde_ve
260
      title: VE-SDE
261
    - local: api/schedulers/score_sde_vp
262
      title: VP-SDE
263
    - local: api/schedulers/vq_diffusion
264
265
      title: VQDiffusionScheduler
    title: Schedulers
266
267
  - sections:
    - local: api/experimental/rl
268
269
270
      title: RL Planning
    title: Experimental Features
  title: API