You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-72Lines changed: 22 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,15 @@ More precisely, 🤗 Diffusers offers:
25
25
- Multiple types of models, such as UNet, that can be used as building blocks in an end-to-end diffusion system (see [src/diffusers/models](https://github.com/huggingface/diffusers/tree/main/src/diffusers/models)).
26
26
- Training examples to show how to train the most popular diffusion models (see [examples](https://github.com/huggingface/diffusers/tree/main/examples)).
27
27
28
+
## Quickstart
29
+
30
+
In order to get started, we recommend taking a look at two notebooks:
31
+
32
+
- The [Diffusers](https://github.com/patrickvonplaten/notebooks/blob/master/Diffusers.ipynb) notebook, which showcases an end-to-end example of usage for diffusion models, schedulers and pipelines.
33
+
Take a look at this notebook to learn how to use the pipeline abstraction, which takes care of everything (model, scheduler, noise handling) for you, but also to get an understanding of each independent building blocks in the library.
34
+
- The [Training diffusers](https://colab.research.google.com/gist/anton-l/cde0c3643e991ad7dbc01939865acaf4/diffusers_training_example.ipynb) notebook, which summarizes diffuser model training methods. This notebook takes a step-by-step approach to training your
35
+
diffuser model on an image dataset, with explanatory graphics.
36
+
28
37
## Definitions
29
38
30
39
**Models**: Neural network that models $p_\theta(\mathbf{x}_{t-1}|\mathbf{x}_t)$ (see image below) and is trained end-to-end to *denoise* a noisy input to an image.
@@ -62,83 +71,24 @@ The class provides functionality to compute previous image according to alpha, b
62
71
- Diffusers is **modality independent** and focusses on providing pretrained models and tools to build systems that generate **continous outputs**, *e.g.* vision and audio.
63
72
- Diffusion models and schedulers are provided as consise, elementary building blocks whereas diffusion pipelines are a collection of end-to-end diffusion systems that can be used out-of-the-box, should stay as close as possible to their original implementation and can include components of other library, such as text-encoders. Examples for diffusion pipelines are [Glide](https://github.com/openai/glide-text2im) and [Latent Diffusion](https://github.com/CompVis/latent-diffusion).
64
73
65
-
## Quickstart
66
-
67
-
In order to get started, we recommend taking a look at two notebooks:
68
-
69
-
- The [Diffusers](https://colab.research.google.com/drive/1aEFVu0CvcIBzSNIQ7F71ujYYplAX4Bml?usp=sharing#scrollTo=PzW5ublpBuUt) notebook, which showcases an end-to-end example of usage for diffusion models, schedulers and pipelines.
70
-
Take a look at this notebook to learn how to use the pipeline abstraction, which takes care of everything (model, scheduler, noise handling) for you, but also to get an understanding of each independent building blocks in the library.
71
-
- The [Training diffusers](https://colab.research.google.com/drive/1qqJmz7JJ04suJzEF4Hn4-Acb8rfL-eA3?usp=sharing) notebook, which summarizes diffuser model training methods. This notebook takes a step-by-step approach to training your
72
-
diffuser model on an image dataset, with explanatory graphics.
73
-
74
-
### Installation
74
+
## Installation
75
75
76
76
```
77
-
pip install diffusers # should install diffusers 0.0.4
77
+
pip install diffusers # should install diffusers 0.1.2
78
78
```
79
79
80
-
### 1. `diffusers` as a toolbox for schedulers and models
81
-
82
-
`diffusers` is more modularized than `transformers`. The idea is that researchers and engineers can use only parts of the library easily for the own use cases.
83
-
It could become a central place for all kinds of models, schedulers, training utils and processors that one can mix and match for one's own use case.
84
-
Both models and schedulers should be load- and saveable from the Hub.
80
+
## Examples
85
81
86
-
For more examples see [schedulers](https://github.com/huggingface/diffusers/tree/main/src/diffusers/schedulers) and [models](https://github.com/huggingface/diffusers/tree/main/src/diffusers/models)
87
-
88
-
#### **Example for Unconditonal Image generation [DDPM](https://arxiv.org/abs/2006.11239):**
-[DDPM with different schedulers](https://huggingface.co/spaces/fusing/celeba-diffusion)
142
92
143
93
## In the works
144
94
@@ -166,4 +116,4 @@ This library concretizes previous work by many different authors and would not h
166
116
-@ermongroup's DDIM implementation, available [here](https://github.com/ermongroup/ddim).
167
117
-@yang-song's Score-VE and Score-VP implementations, available [here](https://github.com/yang-song/score_sde_pytorch)
168
118
169
-
We also want to thank @heejkoo for the very helpful overview of papers, code and resources on diffusion models, available [here](https://github.com/heejkoo/Awesome-Diffusion-Models).
119
+
We also want to thank @heejkoo for the very helpful overview of papers, code and resources on diffusion models, available [here](https://github.com/heejkoo/Awesome-Diffusion-Models) as well as @crowsonkb and @rromb for useful discussions and insights.
0 commit comments