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