Skip to content

[docs] uv installation #10622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 23, 2025
Merged

[docs] uv installation #10622

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d35e7df
uv
stevhliu Jan 21, 2025
7ed1b67
feedback
stevhliu Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions docs/source/en/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,46 @@ You should install 🤗 Diffusers in a [virtual environment](https://docs.python
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/).
A virtual environment makes it easier to manage different projects and avoid compatibility issues between dependencies.

Start by creating a virtual environment in your project directory:
Create a virtual environment with [uv](https://docs.astral.sh/uv/) (refer to [Installation](https://docs.astral.sh/uv/getting-started/installation/) for installation instructions), a fast Rust-based Python package and project manager.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still some cases where managing virtual envs with uv might be problematic. We could maybe keep two options venv and uv?


```bash
python -m venv .env
uv venv my-env
source my-env/bin/activate
```

Activate the virtual environment:
You should also install 🤗 Transformers because 🤗 Diffusers relies on its models.


<frameworkcontent>
<pt>

PyTorch only supports Python 3.8 - 3.11 on Windows. Install Diffusers with uv.

```bash
source .env/bin/activate
uv install diffusers["torch"] transformers
```

You should also install 🤗 Transformers because 🤗 Diffusers relies on its models:

You can also install Diffusers with pip.

<frameworkcontent>
<pt>
Note - PyTorch only supports Python 3.8 - 3.11 on Windows.
```bash
pip install diffusers["torch"] transformers
```

</pt>
<jax>

Install Diffusers with uv.

```bash
uv pip install diffusers["flax"] transformers
```

You can also install Diffusers with pip.

```bash
pip install diffusers["flax"] transformers
```

</jax>
</frameworkcontent>

Expand Down