安裝

🤗 Diffusers 在 Python 3.8+、PyTorch 1.7.0+ 和 Flax 上進行測試。請按照以下針對您正在使用的深度學習庫的安裝說明進行操作

• PyTorch 安裝說明
• Flax 安裝說明

使用 pip 安裝

您應該在虛擬環境中安裝 🤗 Diffusers。如果您不熟悉 Python 虛擬環境，請檢視此指南。虛擬環境使得管理不同專案並避免依賴項之間的相容性問題變得更容易。

使用 Python 或 uv（請參閱安裝以獲取安裝說明），一個基於 Rust 的快速 Python 包和專案管理器來建立虛擬環境。

uv venv my-env
source my-env/bin/activate

您還應該安裝 🤗 Transformers，因為 🤗 Diffusers 依賴於它的模型。

uv install diffusers["torch"] transformers

pip install diffusers["torch"] transformers

uv pip install diffusers["flax"] transformers

pip install diffusers["flax"] transformers

使用 conda 安裝

啟用您的虛擬環境後，使用 conda（由社群維護）

conda install -c conda-forge diffusers

從原始碼安裝

在從原始碼安裝 🤗 Diffusers 之前，請確保您已安裝 PyTorch 和 🤗 Accelerate。

要安裝 🤗 Accelerate

pip install accelerate

然後從原始碼安裝 🤗 Diffusers

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

此命令安裝的是前沿的 main 版本，而非最新的 stable 版本。main 版本對於保持與最新開發同步非常有用。例如，如果自上次正式釋出以來某個 bug 已修復但尚未釋出新版本，則可以使用 main 版本。然而，這意味著 main 版本可能並非始終穩定。我們努力保持 main 版本的正常執行，並且大多數問題通常在幾小時或一天內解決。如果您遇到問題，請提出 Issue，以便我們能更快地解決！

可編輯安裝

如果您想使用以下功能，則需要可編輯安裝：

• 使用原始碼的 main 版本。
• 為 🤗 Diffusers 貢獻程式碼並需要測試程式碼更改。

使用以下命令克隆倉庫並安裝 🤗 Diffusers

git clone https://github.com/huggingface/diffusers.git
cd diffusers

pip install -e ".[torch]"

pip install -e ".[flax]"

這些命令會將您克隆倉庫的資料夾連結到您的 Python 庫路徑。Python 現在除了正常的庫路徑外，還會查詢您克隆的資料夾。例如，如果您的 Python 包通常安裝在 ~/anaconda3/envs/main/lib/python3.10/site-packages/ 中，Python 也會搜尋您克隆的 ~/diffusers/ 資料夾。

現在，您可以使用以下命令輕鬆地將您的克隆更新到 🤗 Diffusers 的最新版本

cd ~/diffusers/
git pull

您的 Python 環境將在下次執行時找到 🤗 Diffusers 的 main 版本。

快取

模型權重和檔案從 Hub 下載到快取，通常是您的主目錄。您可以透過指定 HF_HOME 或 HUGGINFACE_HUB_CACHE 環境變數或在諸如 from_pretrained() 之類的方法中配置 cache_dir 引數來更改快取位置。

快取檔案允許您離線執行 🤗 Diffusers。為了防止 🤗 Diffusers 連線到網際網路，請將 HF_HUB_OFFLINE 環境變數設定為 1，這樣 🤗 Diffusers 將僅載入快取中以前下載的檔案。

export HF_HUB_OFFLINE=1

有關管理和清理快取的更多詳細資訊，請參閱快取指南。

遙測日誌

我們的庫在 from_pretrained() 請求期間收集遙測資訊。收集的資料包括 🤗 Diffusers 和 PyTorch/Flax 的版本、請求的模型或管道類，以及（如果託管在 Hugging Face Hub 上）預訓練檢查點的路徑。此使用資料有助於我們除錯問題並優先開發新功能。遙測僅在從 Hub 載入模型和管道時傳送，如果您載入本地檔案，則不會收集遙測。

我們理解並非所有人都希望分享額外資訊，我們尊重您的隱私。您可以透過在終端設定 HF_HUB_DISABLE_TELEMETRY 環境變數來停用遙測收集

在 Linux/MacOS 上

export HF_HUB_DISABLE_TELEMETRY=1

在 Windows 上

set HF_HUB_DISABLE_TELEMETRY=1