_toctree.yml 8.34 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
Steven Liu's avatar
Steven Liu committed
14
15
16
  - local: tutorials/basic_training
    title: Train a diffusion model
  title: Tutorials
Nathan Lambert's avatar
Nathan Lambert committed
17
18
- sections:
  - sections:
19
20
    - local: using-diffusers/loading_overview
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
21
    - local: using-diffusers/loading
22
      title: Loading Pipelines, Models, and Schedulers
23
    - local: using-diffusers/schedulers
24
      title: Using different Schedulers
Patrick von Platen's avatar
Patrick von Platen committed
25
    - local: using-diffusers/configuration
26
      title: Configuring Pipelines, Models, and Schedulers
27
    - local: using-diffusers/custom_pipeline_overview
28
      title: Loading and Adding Custom Pipelines
29
30
    - local: using-diffusers/kerascv
      title: Using KerasCV Stable Diffusion Checkpoints in Diffusers
31
    title: Loading & Hub
Nathan Lambert's avatar
Nathan Lambert committed
32
  - sections:
33
34
    - local: using-diffusers/pipeline_overview
      title: Overview
35
36
    - local: using-diffusers/write_own_pipeline
      title: Understanding models and schedulers
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/controlling_generation
      title: Controlling generation
49
    - local: using-diffusers/reusing_seeds
50
      title: Reusing seeds for deterministic generation
51
52
    - local: using-diffusers/reproducibility
      title: Reproducibility
53
    - local: using-diffusers/custom_pipeline_examples
54
      title: Community Pipelines
55
    - local: using-diffusers/contribute_pipeline
56
      title: How to contribute a Pipeline
57
58
    - local: using-diffusers/using_safetensors
      title: Using safetensors
59
60
    - local: using-diffusers/weighted_prompts
      title: Weighting Prompts
61
    title: Pipelines for Inference
62
63
  - sections:
    - local: using-diffusers/rl
64
      title: Reinforcement Learning
65
    - local: using-diffusers/audio
66
      title: Audio
67
    - local: using-diffusers/other-modalities
68
69
70
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
71
- sections:
72
73
  - local: optimization/opt_overview
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
74
  - local: optimization/fp16
75
    title: Memory and Speed
76
77
  - local: optimization/torch2.0
    title: Torch2.0 support
78
  - local: optimization/xformers
79
    title: xFormers
Patrick von Platen's avatar
Patrick von Platen committed
80
  - local: optimization/onnx
81
    title: ONNX
Patrick von Platen's avatar
Patrick von Platen committed
82
  - local: optimization/open_vino
83
    title: OpenVINO
Patrick von Platen's avatar
Patrick von Platen committed
84
  - local: optimization/mps
85
    title: MPS
86
  - local: optimization/habana
87
88
    title: Habana Gaudi
  title: Optimization/Special Hardware
Patrick von Platen's avatar
Patrick von Platen committed
89
- sections:
90
  - local: training/overview
91
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
92
  - local: training/unconditional_training
93
    title: Unconditional image generation
Patrick von Platen's avatar
Patrick von Platen committed
94
  - local: training/text_inversion
95
    title: Textual Inversion
96
  - local: training/dreambooth
97
    title: DreamBooth
Patrick von Platen's avatar
Patrick von Platen committed
98
  - local: training/text2image
99
    title: Text-to-image
100
  - local: training/lora
101
    title: Low-Rank Adaptation of Large Language Models (LoRA)
102
  title: Training
Patrick von Platen's avatar
Patrick von Platen committed
103
104
- sections:
  - local: conceptual/philosophy
105
    title: Philosophy
Patrick von Platen's avatar
Patrick von Platen committed
106
  - local: conceptual/contribution
107
    title: How to contribute?
108
109
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
110
111
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
112
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
113
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
114
  - sections:
Patrick von Platen's avatar
Patrick von Platen committed
115
    - local: api/models
116
      title: Models
Patrick von Platen's avatar
Patrick von Platen committed
117
    - local: api/diffusion_pipeline
118
      title: Diffusion Pipeline
Patrick von Platen's avatar
Patrick von Platen committed
119
    - local: api/logging
120
      title: Logging
Patrick von Platen's avatar
Patrick von Platen committed
121
    - local: api/configuration
122
      title: Configuration
Patrick von Platen's avatar
Patrick von Platen committed
123
    - local: api/outputs
124
      title: Outputs
125
126
    - local: api/loaders
      title: Loaders
127
    title: Main Classes
Nathan Lambert's avatar
Nathan Lambert committed
128
  - sections:
129
    - local: api/pipelines/overview
130
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
131
    - local: api/pipelines/alt_diffusion
132
133
134
      title: AltDiffusion
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
135
    - local: api/pipelines/cycle_diffusion
136
137
138
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
139
    - local: api/pipelines/ddim
140
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
141
    - local: api/pipelines/ddpm
142
      title: DDPM
Kashif Rasul's avatar
Kashif Rasul committed
143
144
    - local: api/pipelines/dit
      title: DiT
Patrick von Platen's avatar
Patrick von Platen committed
145
    - local: api/pipelines/latent_diffusion
146
      title: Latent Diffusion
147
    - local: api/pipelines/paint_by_example
148
      title: PaintByExample
Patrick von Platen's avatar
Patrick von Platen committed
149
    - local: api/pipelines/pndm
150
151
152
153
154
      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
155
    - local: api/pipelines/score_sde_ve
156
      title: Score SDE VE
157
158
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
159
160
    - sections:
      - local: api/pipelines/stable_diffusion/overview
161
        title: Overview
162
      - local: api/pipelines/stable_diffusion/text2img
163
        title: Text-to-Image
164
      - local: api/pipelines/stable_diffusion/img2img
165
        title: Image-to-Image
166
      - local: api/pipelines/stable_diffusion/inpaint
167
        title: Inpaint
168
      - local: api/pipelines/stable_diffusion/depth2img
169
        title: Depth-to-Image
170
      - local: api/pipelines/stable_diffusion/image_variation
171
        title: Image-Variation
172
      - local: api/pipelines/stable_diffusion/upscale
173
        title: Super-Resolution
174
      - local: api/pipelines/stable_diffusion/latent_upscale
175
        title: Stable-Diffusion-Latent-Upscaler
176
177
      - local: api/pipelines/stable_diffusion/pix2pix
        title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
178
179
      - local: api/pipelines/stable_diffusion/attend_and_excite
        title: Attend and Excite
180
181
      - local: api/pipelines/stable_diffusion/pix2pix_zero
        title: Pix2Pix Zero
182
183
      - local: api/pipelines/stable_diffusion/self_attention_guidance
        title: Self-Attention Guidance
184
185
      - local: api/pipelines/stable_diffusion/panorama
        title: MultiDiffusion Panorama
186
187
      - local: api/pipelines/stable_diffusion/controlnet
        title: Text-to-Image Generation with ControlNet Conditioning
188
      title: Stable Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
189
    - local: api/pipelines/stable_diffusion_2
190
      title: Stable Diffusion 2
Will Berman's avatar
Will Berman committed
191
192
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
193
    - local: api/pipelines/stochastic_karras_ve
194
      title: Stochastic Karras VE
Will Berman's avatar
Will Berman committed
195
    - local: api/pipelines/unclip
196
197
198
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
199
    - local: api/pipelines/versatile_diffusion
200
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
201
    - local: api/pipelines/vq_diffusion
202
203
      title: VQ Diffusion
    title: Pipelines
204
205
  - sections:
    - local: api/schedulers/overview
206
      title: Overview
207
    - local: api/schedulers/ddim
208
      title: DDIM
209
210
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
211
    - local: api/schedulers/ddpm
212
      title: DDPM
213
    - local: api/schedulers/deis
214
      title: DEIS
215
    - local: api/schedulers/dpm_discrete
216
      title: DPM Discrete Scheduler
217
    - local: api/schedulers/dpm_discrete_ancestral
218
219
220
221
222
223
224
225
226
      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
227
    - local: api/schedulers/lms_discrete
228
229
230
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
231
    - local: api/schedulers/pndm
232
233
234
235
236
237
238
      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
239
240
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
241
    - local: api/schedulers/score_sde_ve
242
      title: VE-SDE
243
    - local: api/schedulers/score_sde_vp
244
      title: VP-SDE
245
    - local: api/schedulers/vq_diffusion
246
247
      title: VQDiffusionScheduler
    title: Schedulers
248
249
  - sections:
    - local: api/experimental/rl
250
251
252
      title: RL Planning
    title: Experimental Features
  title: API