インストール

お使いのディープラーニングライブラリに合わせてDiffusersをインストールできます。

🤗 DiffusersはPython 3.8+、PyTorch 1.7.0+、Flaxでテストされています。使用するディープラーニングライブラリの以下のインストール手順に従ってください：

• PyTorchのインストール手順。
• Flaxのインストール手順。

pip でインストール

Diffusersは仮想環境の中でインストールすることが推奨されています。 Python の仮想環境についてよく知らない場合は、こちらの ガイド を参照してください。 仮想環境は異なるプロジェクトの管理を容易にし、依存関係間の互換性の問題を回避します。

ではさっそく、プロジェクトディレクトリに仮想環境を作ってみます：

python -m venv .env

仮想環境をアクティブにします：

source .env/bin/activate

🤗 Diffusers もまた 🤗 Transformers ライブラリに依存しており、以下のコマンドで両方をインストールできます：

pip install diffusers["torch"] transformers

pip install diffusers["flax"] transformers

ソースからのインストール

ソースから🤗 Diffusersをインストールする前に、torchと🤗 Accelerateがインストールされていることを確認してください。

torchのインストールについては、torch インストールガイドを参照してください。

🤗 Accelerateをインストールするには：

pip install accelerate

以下のコマンドでソースから🤗 Diffusersをインストールできます：

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

このコマンドは最新の stable バージョンではなく、最先端の main バージョンをインストールします。 mainバージョンは最新の開発に対応するのに便利です。 例えば、前回の公式リリース以降にバグが修正されたが、新しいリリースがまだリリースされていない場合などには都合がいいです。 しかし、これは main バージョンが常に安定しているとは限らないです。 私たちは main バージョンを運用し続けるよう努力しており、ほとんどの問題は通常数時間から1日以内に解決されます。 もし問題が発生した場合は、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環境は次の実行時に main バージョンの🤗 Diffusersを見つけます。

テレメトリー・ロギングに関するお知らせ

このライブラリは from_pretrained() リクエスト中にデータを収集します。 このデータには Diffusers と PyTorch/Flax のバージョン、要求されたモデルやパイプラインクラスが含まれます。 また、Hubでホストされている場合は、事前に学習されたチェックポイントへのパスが含まれます。 この使用データは問題のデバッグや新機能の優先順位付けに役立ちます。 テレメトリーはHuggingFace Hubからモデルやパイプラインをロードするときのみ送信されます。ローカルでの使用中は収集されません。

我々は、すべての人が追加情報を共有したくないことを理解し、あなたのプライバシーを尊重します。 そのため、ターミナルから DISABLE_TELEMETRY 環境変数を設定することで、データ収集を無効にすることができます：

Linux/MacOSの場合

export DISABLE_TELEMETRY=YES

Windows の場合

set DISABLE_TELEMETRY=YES