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