Skip to content

Commit a09d475

Browse files
authored
Add a reference to the name 'Sampler' (huggingface#1172)
* Add a reference to the name 'Sampler' - Facilitate people that are familiar with the name samplers to understand that we call that schedulers - Better SEO if people are googling for samplers to find our library as well * Update README.md with a reference to 'Sampler'
1 parent 2e980ac commit a09d475

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ If you just want to play around with some web demos, you can try out the followi
428428
<p>
429429

430430
**Schedulers**: Algorithm class for both **inference** and **training**.
431-
The class provides functionality to compute previous image according to alpha, beta schedule as well as predict noise for training.
431+
The class provides functionality to compute previous image according to alpha, beta schedule as well as predict noise for training. Also known as **Samplers**.
432432
*Examples*: [DDPM](https://arxiv.org/abs/2006.11239), [DDIM](https://arxiv.org/abs/2010.02502), [PNDM](https://arxiv.org/abs/2202.09778), [DEIS](https://arxiv.org/abs/2204.13902)
433433

434434
<p align="center">

docs/source/api/schedulers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Diffusers contains multiple pre-built schedule functions for the diffusion proce
1616

1717
## What is a scheduler?
1818

19-
The schedule functions, denoted *Schedulers* in the library take in the output of a trained model, a sample which the diffusion process is iterating on, and a timestep to return a denoised sample.
19+
The schedule functions, denoted *Schedulers* in the library take in the output of a trained model, a sample which the diffusion process is iterating on, and a timestep to return a denoised sample. That's why schedulers may also be called *Samplers* in other diffusion models implementations.
2020

2121
- Schedulers define the methodology for iteratively adding noise to an image or for updating a sample based on model outputs.
2222
- adding noise in different manners represent the algorithmic processes to train a diffusion model by adding noise to images.

0 commit comments

Comments
 (0)