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