Skip to content

Commit b6d7e31

Browse files
authored
add edm schedulers in doc (#7319)
* add edm schedulers in doc * add in toctree * address reviewe comments
1 parent 53e9aac commit b6d7e31

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

docs/source/en/_toctree.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,10 @@
404404
title: EulerAncestralDiscreteScheduler
405405
- local: api/schedulers/euler
406406
title: EulerDiscreteScheduler
407+
- local: api/schedulers/edm_euler
408+
title: EDMEulerScheduler
409+
- local: api/schedulers/edm_multistep_dpm_solver
410+
title: EDMDPMSolverMultistepScheduler
407411
- local: api/schedulers/heun
408412
title: HeunDiscreteScheduler
409413
- local: api/schedulers/ipndm
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!--Copyright 2024 The HuggingFace Team. All rights reserved.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
4+
the License. You may obtain a copy of the License at
5+
6+
http://www.apache.org/licenses/LICENSE-2.0
7+
8+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
9+
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
10+
specific language governing permissions and limitations under the License.
11+
-->
12+
13+
# EDMEulerScheduler
14+
15+
The Karras formulation of the Euler scheduler (Algorithm 2) from the [Elucidating the Design Space of Diffusion-Based Generative Models](https://huggingface.co/papers/2206.00364) paper by Karras et al. This is a fast scheduler which can often generate good outputs in 20-30 steps. The scheduler is based on the original [k-diffusion](https://github.com/crowsonkb/k-diffusion/blob/481677d114f6ea445aa009cf5bd7a9cdee909e47/k_diffusion/sampling.py#L51) implementation by [Katherine Crowson](https://github.com/crowsonkb/).
16+
17+
18+
## EDMEulerScheduler
19+
[[autodoc]] EDMEulerScheduler
20+
21+
## EDMEulerSchedulerOutput
22+
[[autodoc]] schedulers.scheduling_edm_euler.EDMEulerSchedulerOutput
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--Copyright 2024 The HuggingFace Team. All rights reserved.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
4+
the License. You may obtain a copy of the License at
5+
6+
http://www.apache.org/licenses/LICENSE-2.0
7+
8+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
9+
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
10+
specific language governing permissions and limitations under the License.
11+
-->
12+
13+
# EDMDPMSolverMultistepScheduler
14+
15+
`EDMDPMSolverMultistepScheduler` is a [Karras formulation](https://huggingface.co/papers/2206.00364) of `DPMSolverMultistep`, a multistep scheduler from [DPM-Solver: A Fast ODE Solver for Diffusion Probabilistic Model Sampling in Around 10 Steps](https://huggingface.co/papers/2206.00927) and [DPM-Solver++: Fast Solver for Guided Sampling of Diffusion Probabilistic Models](https://huggingface.co/papers/2211.01095) by Cheng Lu, Yuhao Zhou, Fan Bao, Jianfei Chen, Chongxuan Li, and Jun Zhu.
16+
17+
DPMSolver (and the improved version DPMSolver++) is a fast dedicated high-order solver for diffusion ODEs with convergence order guarantee. Empirically, DPMSolver sampling with only 20 steps can generate high-quality
18+
samples, and it can generate quite good samples even in 10 steps.
19+
20+
## EDMDPMSolverMultistepScheduler
21+
[[autodoc]] EDMDPMSolverMultistepScheduler
22+
23+
## SchedulerOutput
24+
[[autodoc]] schedulers.scheduling_utils.SchedulerOutput

0 commit comments

Comments
 (0)