Skip to content

Commit 6b5baa9

Browse files
Add contributions to README and re-order a bit (open-mmlab#316)
* up * thanks Clau * finish * finish * up
1 parent 66fd3ec commit 6b5baa9

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

+26-14
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,32 @@ More precisely, 🤗 Diffusers offers:
2525
- Multiple types of models, such as UNet, 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)).
2626
- Training examples to show how to train the most popular diffusion model tasks (see [examples](https://github.com/huggingface/diffusers/tree/main/examples), *e.g.* [unconditional-image-generation](https://github.com/huggingface/diffusers/tree/main/examples/unconditional_image_generation)).
2727

28+
## Installation
29+
30+
**With `pip`**
31+
32+
```bash
33+
pip install --upgrade diffusers # should install diffusers 0.2.4
34+
```
35+
36+
**With `conda`**
37+
38+
```sh
39+
conda install -c conda-forge diffusers
40+
```
41+
42+
## Contributing
43+
44+
We ❤️ contributions from the open-source community!
45+
If you want to contribute to this library, please check out (or at least pretend to) our [Contribution guide](https://github.com/huggingface/diffusers/blob/main/CONTRIBUTING.md).
46+
You can look out for [issues](https://github.com/huggingface/diffusers/issues) you'd like to tackle to contribute to the library.
47+
- See [Good first issues](https://github.com/huggingface/diffusers/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) for general opportunities to contribute
48+
- See [New model/pipeline](https://github.com/huggingface/diffusers/issues?q=is%3Aopen+is%3Aissue+label%3A%22New+pipeline%2Fmodel%22) to contribute exciting new diffusion models / diffusion pipelines
49+
- See [New scheduler](https://github.com/huggingface/diffusers/issues?q=is%3Aopen+is%3Aissue+label%3A%22New+scheduler%22)
50+
51+
Also, say 👋 in our public Discord channel <a href="https://discord.gg/G7tWnz98XR"><img alt="Join us on Discord" src="https://img.shields.io/discord/823813159592001537?color=5865F2&logo=discord&logoColor=white"></a>. We discuss the hottest trends about diffusion models, help each other with contributions, personal projects or
52+
just hang out ☕.
53+
2854
## Quickstart
2955

3056
In order to get started, we recommend taking a look at two notebooks:
@@ -310,20 +336,6 @@ The class provides functionality to compute previous image according to alpha, b
310336
- Diffusers is **modality independent** and focuses on providing pretrained models and tools to build systems that generate **continous outputs**, *e.g.* vision and audio.
311337
- Diffusion models and schedulers are provided as concise, elementary building blocks. In contrast, 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 another 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).
312338

313-
## Installation
314-
315-
**With `pip`**
316-
317-
```bash
318-
pip install --upgrade diffusers # should install diffusers 0.2.4
319-
```
320-
321-
**With `conda`**
322-
323-
```sh
324-
conda install -c conda-forge diffusers
325-
```
326-
327339
## In the works
328340

329341
For the first release, 🤗 Diffusers focuses on text-to-image diffusion techniques. However, diffusers can be used for much more than that! Over the upcoming releases, we'll be focusing on:

0 commit comments

Comments
 (0)