installation.md 5.58 KB
Newer Older
Patrick von Platen's avatar
Patrick von Platen committed
1
<!--Copyright 2023 The HuggingFace Team. All rights reserved.
Nathan Lambert's avatar
Nathan Lambert committed
2
3
4
5
6
7
8
9
10
11
12

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
-->

13
# Installation
Patrick von Platen's avatar
Patrick von Platen committed
14

Steven Liu's avatar
Steven Liu committed
15
🤗 Diffusers is tested on Python 3.8+, PyTorch 1.7.0+, and Flax. Follow the installation instructions below for the deep learning library you are using:
Patrick von Platen's avatar
Patrick von Platen committed
16

Steven Liu's avatar
Steven Liu committed
17
18
- [PyTorch](https://pytorch.org/get-started/locally/) installation instructions
- [Flax](https://flax.readthedocs.io/en/latest/) installation instructions
Patrick von Platen's avatar
Patrick von Platen committed
19

20
## Install with pip
Patrick von Platen's avatar
Patrick von Platen committed
21

22
23
You should install 🤗 Diffusers in a [virtual environment](https://docs.python.org/3/library/venv.html).
If you're unfamiliar with Python virtual environments, take a look at this [guide](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
24
A virtual environment makes it easier to manage different projects and avoid compatibility issues between dependencies.
25
26
27
28
29
30
31
32
33
34
35

Start by creating a virtual environment in your project directory:

```bash
python -m venv .env
```

Activate the virtual environment:

```bash
source .env/bin/activate
Patrick von Platen's avatar
Patrick von Platen committed
36
```
37

Steven Liu's avatar
Steven Liu committed
38
You should also install 🤗 Transformers because 🤗 Diffusers relies on its models:
39

40

41
42
<frameworkcontent>
<pt>
43
Note - PyTorch only supports Python 3.8 - 3.11 on Windows.
44
```bash
45
pip install diffusers["torch"] transformers
46
```
47
48
</pt>
<jax>
49
```bash
50
pip install diffusers["flax"] transformers
Patrick von Platen's avatar
Patrick von Platen committed
51
```
52
53
</jax>
</frameworkcontent>
Patrick von Platen's avatar
Patrick von Platen committed
54

55
56
57
58
59
60
61
62
## Install with conda

After activating your virtual environment, with `conda` (maintained by the community):

```bash
conda install -c conda-forge diffusers
```

63
64
## Install from source

Steven Liu's avatar
Steven Liu committed
65
Before installing 🤗 Diffusers from source, make sure you have PyTorch and 🤗 Accelerate installed.
66

67
To install 🤗 Accelerate:
68
69
70
71
72

```bash
pip install accelerate
```

Steven Liu's avatar
Steven Liu committed
73
Then install 🤗 Diffusers from source:
74
75
76
77
78
79
80
81
82
83

```bash
pip install git+https://github.com/huggingface/diffusers
```

This command installs the bleeding edge `main` version rather than the latest `stable` version.
The `main` version is useful for staying up-to-date with the latest developments.
For instance, if a bug has been fixed since the last official release but a new release hasn't been rolled out yet.
However, this means the `main` version may not always be stable.
We strive to keep the `main` version operational, and most issues are usually resolved within a few hours or a day.
Steven Liu's avatar
Steven Liu committed
84
If you run into a problem, please open an [Issue](https://github.com/huggingface/diffusers/issues/new/choose) so we can fix it even sooner!
85
86
87
88
89
90
91
92
93
94
95
96

## Editable install

You will need an editable install if you'd like to:

* Use the `main` version of the source code.
* Contribute to 🤗 Diffusers and need to test changes in the code.

Clone the repository and install 🤗 Diffusers with the following commands:

```bash
git clone https://github.com/huggingface/diffusers.git
Partho's avatar
Partho committed
97
cd diffusers
98
99
```

100
101
102
<frameworkcontent>
<pt>
```bash
103
104
pip install -e ".[torch]"
```
105
106
107
</pt>
<jax>
```bash
108
pip install -e ".[flax]"
109
```
110
111
</jax>
</frameworkcontent>
112
113
114

These commands will link the folder you cloned the repository to and your Python library paths.
Python will now look inside the folder you cloned to in addition to the normal library paths.
115
For example, if your Python packages are typically installed in `~/anaconda3/envs/main/lib/python3.8/site-packages/`, Python will also search the `~/diffusers/` folder you cloned to.
Patrick von Platen's avatar
Patrick von Platen committed
116

117
<Tip warning={true}>
Patrick von Platen's avatar
Patrick von Platen committed
118

119
You must keep the `diffusers` folder if you want to keep using the library.
Patrick von Platen's avatar
Patrick von Platen committed
120

121
</Tip>
Patrick von Platen's avatar
Patrick von Platen committed
122

123
124
125
126
127
128
Now you can easily update your clone to the latest version of 🤗 Diffusers with the following command:

```bash
cd ~/diffusers/
git pull
```
Patrick von Platen's avatar
Patrick von Platen committed
129

130
Your Python environment will find the `main` version of 🤗 Diffusers on the next run.
131

Steven Liu's avatar
Steven Liu committed
132
133
134
135
136
137
138
139
140
141
142
143
144
## Cache

Model weights and files are downloaded from the Hub to a cache which is usually your home directory. You can change the cache location by specifying the `HF_HOME` or `HUGGINFACE_HUB_CACHE` environment variables or configuring the `cache_dir` parameter in methods like [`~DiffusionPipeline.from_pretrained`].

Cached files allow you to run 🤗 Diffusers offline. To prevent 🤗 Diffusers from connecting to the internet, set the `HF_HUB_OFFLINE` environment variable to `True` and 🤗 Diffusers will only load previously downloaded files in the cache.

```shell
export HF_HUB_OFFLINE=True
```

For more details about managing and cleaning the cache, take a look at the [caching](https://huggingface.co/docs/huggingface_hub/guides/manage-cache) guide.

## Telemetry logging
145

Steven Liu's avatar
Steven Liu committed
146
147
148
Our library gathers telemetry information during [`~DiffusionPipeline.from_pretrained`] requests.
The data gathered includes the version of 🤗 Diffusers and PyTorch/Flax, the requested model or pipeline class,
and the path to a pretrained checkpoint if it is hosted on the Hugging Face Hub.
149
This usage data helps us debug issues and prioritize new features.
Steven Liu's avatar
Steven Liu committed
150
151
Telemetry is only sent when loading models and pipelines from the Hub,
and it is not collected if you're loading local files.
152

Steven Liu's avatar
Steven Liu committed
153
154
We understand that not everyone wants to share additional information,and we respect your privacy.
You can disable telemetry collection by setting the `DISABLE_TELEMETRY` environment variable from your terminal:
155
156
157
158
159
160
161
162
163

On Linux/MacOS:
```bash
export DISABLE_TELEMETRY=YES
```

On Windows:
```bash
set DISABLE_TELEMETRY=YES
164
```