_toctree.yml 8.47 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
74
    - local: training/instructpix2pix
      title: InstructPix2Pix Training
75
    title: Training
76
77
  - sections:
    - local: using-diffusers/rl
78
      title: Reinforcement Learning
79
    - local: using-diffusers/audio
80
      title: Audio
81
    - local: using-diffusers/other-modalities
82
83
84
      title: Other Modalities
    title: Taking Diffusers Beyond Images
  title: Using Diffusers
Patrick von Platen's avatar
Patrick von Platen committed
85
- sections:
86
87
  - local: optimization/opt_overview
    title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
88
  - local: optimization/fp16
89
    title: Memory and Speed
90
91
  - local: optimization/torch2.0
    title: Torch2.0 support
92
  - local: optimization/xformers
93
    title: xFormers
Patrick von Platen's avatar
Patrick von Platen committed
94
  - local: optimization/onnx
95
    title: ONNX
Patrick von Platen's avatar
Patrick von Platen committed
96
  - local: optimization/open_vino
97
    title: OpenVINO
Patrick von Platen's avatar
Patrick von Platen committed
98
  - local: optimization/mps
99
    title: MPS
100
  - local: optimization/habana
101
102
    title: Habana Gaudi
  title: Optimization/Special Hardware
Patrick von Platen's avatar
Patrick von Platen committed
103
104
- sections:
  - local: conceptual/philosophy
105
    title: Philosophy
106
107
  - local: using-diffusers/controlling_generation
    title: Controlled generation
Patrick von Platen's avatar
Patrick von Platen committed
108
  - local: conceptual/contribution
109
    title: How to contribute?
110
111
  - local: conceptual/ethical_guidelines
    title: Diffusers' Ethical Guidelines
112
113
  - local: conceptual/evaluation
    title: Evaluating Diffusion Models
114
  title: Conceptual Guides
Patrick von Platen's avatar
Patrick von Platen committed
115
- sections:
Nathan Lambert's avatar
Nathan Lambert committed
116
  - sections:
Patrick von Platen's avatar
Patrick von Platen committed
117
    - local: api/models
118
      title: Models
Patrick von Platen's avatar
Patrick von Platen committed
119
    - local: api/diffusion_pipeline
120
      title: Diffusion Pipeline
Patrick von Platen's avatar
Patrick von Platen committed
121
    - local: api/logging
122
      title: Logging
Patrick von Platen's avatar
Patrick von Platen committed
123
    - local: api/configuration
124
      title: Configuration
Patrick von Platen's avatar
Patrick von Platen committed
125
    - local: api/outputs
126
      title: Outputs
127
128
    - local: api/loaders
      title: Loaders
129
    title: Main Classes
Nathan Lambert's avatar
Nathan Lambert committed
130
  - sections:
131
    - local: api/pipelines/overview
132
      title: Overview
Patrick von Platen's avatar
Patrick von Platen committed
133
    - local: api/pipelines/alt_diffusion
134
135
136
      title: AltDiffusion
    - local: api/pipelines/audio_diffusion
      title: Audio Diffusion
137
    - local: api/pipelines/cycle_diffusion
138
139
140
      title: Cycle Diffusion
    - local: api/pipelines/dance_diffusion
      title: Dance Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
141
    - local: api/pipelines/ddim
142
      title: DDIM
Patrick von Platen's avatar
Patrick von Platen committed
143
    - local: api/pipelines/ddpm
144
      title: DDPM
Kashif Rasul's avatar
Kashif Rasul committed
145
146
    - local: api/pipelines/dit
      title: DiT
Patrick von Platen's avatar
Patrick von Platen committed
147
    - local: api/pipelines/latent_diffusion
148
      title: Latent Diffusion
149
    - local: api/pipelines/paint_by_example
150
      title: PaintByExample
Patrick von Platen's avatar
Patrick von Platen committed
151
    - local: api/pipelines/pndm
152
153
154
155
156
      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
157
    - local: api/pipelines/score_sde_ve
158
      title: Score SDE VE
159
160
    - local: api/pipelines/semantic_stable_diffusion
      title: Semantic Guidance
161
162
    - sections:
      - local: api/pipelines/stable_diffusion/overview
163
        title: Overview
164
      - local: api/pipelines/stable_diffusion/text2img
165
        title: Text-to-Image
166
      - local: api/pipelines/stable_diffusion/img2img
167
        title: Image-to-Image
168
      - local: api/pipelines/stable_diffusion/inpaint
169
        title: Inpaint
170
      - local: api/pipelines/stable_diffusion/depth2img
171
        title: Depth-to-Image
172
      - local: api/pipelines/stable_diffusion/image_variation
173
        title: Image-Variation
174
      - local: api/pipelines/stable_diffusion/upscale
175
        title: Super-Resolution
176
      - local: api/pipelines/stable_diffusion/latent_upscale
177
        title: Stable-Diffusion-Latent-Upscaler
178
179
      - local: api/pipelines/stable_diffusion/pix2pix
        title: InstructPix2Pix
YiYi Xu's avatar
YiYi Xu committed
180
181
      - local: api/pipelines/stable_diffusion/attend_and_excite
        title: Attend and Excite
182
183
      - local: api/pipelines/stable_diffusion/pix2pix_zero
        title: Pix2Pix Zero
184
185
      - local: api/pipelines/stable_diffusion/self_attention_guidance
        title: Self-Attention Guidance
186
187
      - local: api/pipelines/stable_diffusion/panorama
        title: MultiDiffusion Panorama
188
189
      - local: api/pipelines/stable_diffusion/controlnet
        title: Text-to-Image Generation with ControlNet Conditioning
190
      title: Stable Diffusion
Patrick von Platen's avatar
Patrick von Platen committed
191
    - local: api/pipelines/stable_diffusion_2
192
      title: Stable Diffusion 2
Will Berman's avatar
Will Berman committed
193
194
    - local: api/pipelines/stable_unclip
      title: Stable unCLIP
Patrick von Platen's avatar
Patrick von Platen committed
195
    - local: api/pipelines/stochastic_karras_ve
196
      title: Stochastic Karras VE
197
198
    - local: api/pipelines/text_to_video
      title: Text-to-Video
Will Berman's avatar
Will Berman committed
199
    - local: api/pipelines/unclip
200
201
202
      title: UnCLIP
    - local: api/pipelines/latent_diffusion_uncond
      title: Unconditional Latent Diffusion
203
    - local: api/pipelines/versatile_diffusion
204
      title: Versatile Diffusion
Will Berman's avatar
Will Berman committed
205
    - local: api/pipelines/vq_diffusion
206
207
      title: VQ Diffusion
    title: Pipelines
208
209
  - sections:
    - local: api/schedulers/overview
210
      title: Overview
211
    - local: api/schedulers/ddim
212
      title: DDIM
213
214
    - local: api/schedulers/ddim_inverse
      title: DDIMInverse
215
    - local: api/schedulers/ddpm
216
      title: DDPM
217
    - local: api/schedulers/deis
218
      title: DEIS
219
    - local: api/schedulers/dpm_discrete
220
      title: DPM Discrete Scheduler
221
    - local: api/schedulers/dpm_discrete_ancestral
222
223
224
225
226
227
228
229
230
      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
231
    - local: api/schedulers/lms_discrete
232
233
234
      title: Linear Multistep
    - local: api/schedulers/multistep_dpm_solver
      title: Multistep DPM-Solver
235
    - local: api/schedulers/pndm
236
237
238
239
240
241
242
      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
243
244
    - local: api/schedulers/unipc
      title: UniPCMultistepScheduler
245
    - local: api/schedulers/score_sde_ve
246
      title: VE-SDE
247
    - local: api/schedulers/score_sde_vp
248
      title: VP-SDE
249
    - local: api/schedulers/vq_diffusion
250
251
      title: VQDiffusionScheduler
    title: Schedulers
252
253
  - sections:
    - local: api/experimental/rl
254
255
256
      title: RL Planning
    title: Experimental Features
  title: API