Skip to content

安装

🤗 Diffusers 在 Python 3.8+、PyTorch 1.7.0+ 和 Flax 上进行了测试。请根据你使用的深度学习库,按照以下安装说明进行操作:

使用 pip 安装

你应该在 虚拟环境 中安装 🤗 Diffusers。如果你不熟悉 Python 虚拟环境,可以参考这个 指南。虚拟环境可以让你更轻松地管理不同的项目,避免依赖项之间的兼容性问题。

首先,在你的项目目录中创建一个虚拟环境:

bash
python -m venv .env

激活虚拟环境:

bash
source .env/bin/activate

你还需要安装 🤗 Transformers,因为 🤗 Diffusers 依赖于它的模型:

使用 conda 安装

在激活你的虚拟环境后,使用 conda(由社区维护):

bash
conda install -c conda-forge diffusers

从源代码安装

在从源代码安装 🤗 Diffusers 之前,请确保你已经安装了 PyTorch 和 🤗 Accelerate。

要安装 🤗 Accelerate:

bash
pip install accelerate

然后从源代码安装 🤗 Diffusers:

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

此命令安装的是最新的 main 版本,而不是最新的 stable 版本。 main 版本有助于保持与最新开发进展的同步。 例如,如果自上次正式发布以来已修复了一个错误,但尚未发布新版本。 然而,这意呸着 main 版本可能并不总是稳定的。 我们努力保持 main 版本的正常运行,大多数问题通常在几小时或一天内得到解决。 如果你遇到问题,请打开一个 Issue,以便我们尽快修复!

可编辑安装

如果你希望:

  • 使用 main 版本的源代码。
  • 为 🤗 Diffusers 贡献代码并需要测试代码中的更改。

请克隆仓库并使用以下命令安装 🤗 Diffusers:

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

这些命令将你克隆仓库的文件夹与你的 Python 库路径关联起来。 Python 现在除了正常的库路径外,还会查找你克隆的文件夹。 例如,如果你的 Python 包通常安装在 ~/anaconda3/envs/main/lib/python3.10/site-packages/,Python 还会搜索你克隆的 ~/diffusers/ 文件夹。

现在你可以轻松地将克隆更新到 🤗 Diffusers 的最新版本,使用以下命令:

bash
cd ~/diffusers/
git pull

你的 Python 环境将在下一次运行时找到 🤗 Diffusers 的 main 版本。

缓存

模型权重和文件将从 Hub 下载到缓存中,缓存通常位于你的主目录。你可以通过设置 HF_HOMEHUGGINFACE_HUB_CACHE 环境变量,或在类似 [~DiffusionPipeline.from_pretrained] 的方法中配置 cache_dir 参数来更改缓存位置。

缓存文件允许你在离线状态下运行 🤗 Diffusers。要防止 🤗 Diffusers 连接到互联网,可以将 HF_HUB_OFFLINE 环境变量设置为 True,这样 🤗 Diffusers 将仅加载缓存中之前下载的文件。

shell
export HF_HUB_OFFLINE=True

有关管理和清理缓存的更多详细信息,请参阅 缓存 指南。

茶叶计量日志记录

我们的库在 [~DiffusionPipeline.from_pretrained] 请求期间收集茶叶计量信息。 收集的数据包括 🤗 Diffusers 和 PyTorch/Flax 的版本、请求的模型或管道类, 以及如果模型托管在 Hugging Face Hub 上,则包括预训练检查点的路径。 这些使用数据有助于我们调试问题并优先考虑新功能。 茶叶计量信息仅在从 Hub 加载模型和管道时发送, 如果你加载的是本地文件,则不会收集这些信息。

我们理解并非每个人都愿意分享额外的信息,我们尊重你的隐私。 你可以通过在终端中设置 DISABLE_TELEMETRY 环境变量来禁用茶叶计量信息的收集:

在 Linux/MacOS 上:

bash
export DISABLE_TELEMETRY=YES

在 Windows 上:

bash
set DISABLE_TELEMETRY=YES