Buckets:

hf-doc-build
/

doc

Files

xet

hf-doc-build/doc / diffusers /main /id /installation.md

mishig

1 day ago

preview code

download

raw

7.72 kB

# Instalasi

Diffusers memerlukan Python 3.10+ dan diuji dengan PyTorch 2.6+. Instal [PyTorch](https://pytorch.org/get-started/locally/) sesuai dengan sistem dan konfigurasi Anda.

Buat [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) untuk memudahkan pengelolaan proyek terpisah dan menghindari masalah kompatibilitas antar dependensi. Gunakan [uv](https://docs.astral.sh/uv/), manajer paket dan proyek Python berbasis Rust, untuk membuat virtual environment dan menginstal Diffusers.

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

Install Diffusers dengan salah satu metode berikut.

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

Untuk menginstal Diffusers dengan PyTorch pada perangkat NVIDIA Spark (seperti laptop RTX Spark) yang menjalankan ARM64, instal PyTorch dari indeks PyPI NVIDIA. Perangkat ini memerlukan build ARM64 PyTorch dari NVIDIA, yang tidak tersedia di indeks PyPI default atau indeks wheel PyTorch standar.

Jalankan perintah di bawah untuk memeriksa apakah sistem Anda mendeteksi GPU NVIDIA.

```bash
nvidia-smi
```

Install PyTorch dari indeks PyPI NVIDIA, lalu install Diffusers.

```bash
uv pip install torch --index-url https://pypi.nvidia.com
uv pip install diffusers
```

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

Instalasi dari sumber menginstal versi `main` alih-alih versi `stable` terbaru. Versi `main` berguna untuk tetap mengikuti perubahan terbaru, tetapi tidak selalu stabil. Jika Anda menemui masalah, buka [Issue](https://github.com/huggingface/diffusers/issues/new/choose) dan kami akan berusaha menyelesaikannya secepat mungkin.

Pastikan [Accelerate](https://huggingface.co/docs/accelerate/index) terinstal.

```bash
uv pip install accelerate
```

Install Diffusers dari sumber dengan perintah di bawah ini.

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

Install dengan extras saat Anda membutuhkannya. `diffusers["torch"]` menarik PyTorch dan Accelerate. Extras lainnya mencakup backend kuantisasi, pelatihan, dan dokumentasi. Lihat [`setup.py`](https://github.com/huggingface/diffusers/blob/main/setup.py) untuk daftar lengkap.

## Perangkat

Diffusers berjalan di akselerator apa pun yang didukung oleh PyTorch. Contoh di seluruh dokumentasi menggunakan `"cuda"` karena itu adalah konfigurasi yang paling umum, tetapi tidak ada yang spesifik CUDA. Ganti string perangkat untuk perangkat keras Anda, seperti `"xpu"` untuk GPU Intel, `"mps"` untuk Apple silicon, atau `"cpu"`.

```py
device = "cuda"  # or "mps", "xpu", "cpu"
pipeline.to(device)
```

Untuk memilih perangkat saat runtime alih-alih menuliskannya secara tetap, gunakan [torch.accelerator](https://docs.pytorch.org/docs/stable/accelerator.html).

```py
import torch
device = torch.accelerator.current_accelerator().type if torch.accelerator.is_available() else "cpu"
```

## Instalasi yang dapat diedit

Instalasi yang dapat diedit (editable install) direkomendasikan untuk alur kerja pengembangan atau jika Anda menggunakan versi `main` dari kode sumber. Tautan khusus dibuat antara repositori yang dikloning dan jalur pustaka Python. Hal ini menghindari pemasangan ulang paket setelah setiap perubahan.

Kloning repositori dan instal Diffusers dengan perintah berikut.

```bash
git clone https://github.com/huggingface/diffusers.git
cd diffusers
uv pip install -e ".[torch]"
```

> [!WARNING]
> Anda harus menyimpan folder `diffusers` jika ingin terus menggunakan pustaka dengan instalasi yang dapat diedit.

Perbarui repositori yang telah Anda klon ke versi terbaru Diffusers dengan perintah di bawah ini.

```bash
cd ~/diffusers/
git pull
```

## Cache

Bobot model dan file diunduh dari Hub ke cache, yang biasanya adalah direktori home Anda. Ubah lokasi cache dengan variabel lingkungan [HF_HOME](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhome) atau [HF_HUB_CACHE](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhubcache) atau dengan mengonfigurasi parameter `cache_dir` pada metode seperti [from_pretrained()](/docs/diffusers/main/id/api/pipelines/overview#diffusers.DiffusionPipeline.from_pretrained).

```bash
export HF_HOME="/path/to/your/cache"
export HF_HUB_CACHE="/path/to/your/hub/cache"
```

```py
from diffusers import DiffusionPipeline
pipeline = DiffusionPipeline.from_pretrained(
    "black-forest-labs/FLUX.1-dev",
    cache_dir="/path/to/your/cache"
)
```

File yang di-cache memungkinkan Anda menggunakan Diffusers secara offline. Atur variabel lingkungan [HF_HUB_OFFLINE](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhuboffline) ke `1` untuk mencegah Diffusers terhubung ke internet.

```shell
export HF_HUB_OFFLINE=1
```

Untuk detail lebih lanjut tentang pengelolaan dan pembersihan cache, lihat panduan [Memahami caching](https://huggingface.co/docs/huggingface_hub/guides/manage-cache).

### Bagikan file antar repositori

Cache menyimpan satu salinan file meskipun beberapa repositori Hub memuatnya. Banyak pipeline menggunakan text encoder yang sama, seperti T5. Jika repositori pipeline kedua memiliki file text encoder yang sama dengan yang sudah Anda unduh, [from_pretrained()](/docs/diffusers/main/id/api/pipelines/overview#diffusers.DiffusionPipeline.from_pretrained) menggunakan salinan di disk alih-alih mengunduhnya lagi. Diffusers membutuhkan `huggingface_hub>=1.32.0`, yang mengaktifkan berbagi file secara default.

Cache mencocokkan file berdasarkan hash [Xet](https://huggingface.co/docs/hub/xet/index), bukan berdasarkan nama repositori atau model. Checkpoint yang di-shard dicocokkan per shard, sehingga shard yang cocok akan dibagikan meskipun shard lainnya berbeda.

Sebuah file dibagikan hanya jika semua kondisi berikut terpenuhi:

- Kedua repositori menyimpan file dengan Xet.
- Kedua unduhan menggunakan direktori cache yang sama, yang diatur oleh `HF_HUB_CACHE` atau `cache_dir`.
- Sistem file mendukung symlink.
- File-file tersebut identik per byte. Mengonversi ke dtype yang berbeda, menyimpan dalam format yang berbeda, atau melakukan resharding akan mengubah hash.

> [!NOTE]
> File yang Anda unduh dengan versi `huggingface_hub` yang lebih lama tidak dibagikan dengan unduhan baru. Hanya file yang diunduh dengan versi 1.32.0 atau lebih baru yang ditambahkan ke penyimpanan bersama.
Berbagi file menghemat waktu unduhan dan ruang disk, tetapi tidak menghemat memori. Untuk menggunakan satu model yang dimuat di beberapa pipeline, lihat [Reusing models in multiple pipelines](./using-diffusers/loading#reusing-models-in-multiple-pipelines).
Untuk menonaktifkan berbagi file, atur `HF_HUB_DISABLE_SHARED_BLOBS=1`. Proses pemuatan tetap berfungsi, dan setiap repositori menyimpan salinannya sendiri.
```shell
export HF_HUB_DISABLE_SHARED_BLOBS=1
```
## Pencatatan telemetri
Diffusers mengumpulkan informasi telemetri selama permintaan [from_pretrained()](/docs/diffusers/main/id/api/pipelines/overview#diffusers.DiffusionPipeline.from_pretrained). Data yang dikumpulkan mencakup versi Diffusers dan PyTorch, kelas model atau pipeline yang diminta, serta jalur ke checkpoint pretrained jika dihosting di Hub.
Data penggunaan ini membantu kami men-debug masalah dan memprioritaskan fitur baru. Telemetri hanya dikirim saat memuat model dan pipeline dari Hub, dan tidak dikumpulkan jika Anda memuat file lokal.
Matikan dan nonaktifkan pengumpulan telemetri dengan variabel lingkungan [HF_HUB_DISABLE_TELEMETRY](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhubdisabletelemetry).
```bash
export HF_HUB_DISABLE_TELEMETRY=1
```
```bash
set HF_HUB_DISABLE_TELEMETRY=1
```

Xet Storage Details

Size:: 7.72 kB
Xet hash:: 3fa0fa9361b7b64d693a76ad53cde9b461a19f75dff954e6a16cc8ce94a67d36

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.

	# Instalasi

	Diffusers memerlukan Python 3.10+ dan diuji dengan PyTorch 2.6+. Instal [PyTorch](https://pytorch.org/get-started/locally/) sesuai dengan sistem dan konfigurasi Anda.

	Buat [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/) untuk memudahkan pengelolaan proyek terpisah dan menghindari masalah kompatibilitas antar dependensi. Gunakan [uv](https://docs.astral.sh/uv/), manajer paket dan proyek Python berbasis Rust, untuk membuat virtual environment dan menginstal Diffusers.

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

	Install Diffusers dengan salah satu metode berikut.

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

	Untuk menginstal Diffusers dengan PyTorch pada perangkat NVIDIA Spark (seperti laptop RTX Spark) yang menjalankan ARM64, instal PyTorch dari indeks PyPI NVIDIA. Perangkat ini memerlukan build ARM64 PyTorch dari NVIDIA, yang tidak tersedia di indeks PyPI default atau indeks wheel PyTorch standar.

	Jalankan perintah di bawah untuk memeriksa apakah sistem Anda mendeteksi GPU NVIDIA.

	```bash
	nvidia-smi
	```

	Install PyTorch dari indeks PyPI NVIDIA, lalu install Diffusers.

	```bash
	uv pip install torch --index-url https://pypi.nvidia.com
	uv pip install diffusers
	```

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

	Instalasi dari sumber menginstal versi `main` alih-alih versi `stable` terbaru. Versi `main` berguna untuk tetap mengikuti perubahan terbaru, tetapi tidak selalu stabil. Jika Anda menemui masalah, buka [Issue](https://github.com/huggingface/diffusers/issues/new/choose) dan kami akan berusaha menyelesaikannya secepat mungkin.

	Pastikan [Accelerate](https://huggingface.co/docs/accelerate/index) terinstal.

	```bash
	uv pip install accelerate
	```

	Install Diffusers dari sumber dengan perintah di bawah ini.

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

	Install dengan extras saat Anda membutuhkannya. `diffusers["torch"]` menarik PyTorch dan Accelerate. Extras lainnya mencakup backend kuantisasi, pelatihan, dan dokumentasi. Lihat [`setup.py`](https://github.com/huggingface/diffusers/blob/main/setup.py) untuk daftar lengkap.

	## Perangkat

	Diffusers berjalan di akselerator apa pun yang didukung oleh PyTorch. Contoh di seluruh dokumentasi menggunakan `"cuda"` karena itu adalah konfigurasi yang paling umum, tetapi tidak ada yang spesifik CUDA. Ganti string perangkat untuk perangkat keras Anda, seperti `"xpu"` untuk GPU Intel, `"mps"` untuk Apple silicon, atau `"cpu"`.

	```py
	device = "cuda" # or "mps", "xpu", "cpu"
	pipeline.to(device)
	```

	Untuk memilih perangkat saat runtime alih-alih menuliskannya secara tetap, gunakan [torch.accelerator](https://docs.pytorch.org/docs/stable/accelerator.html).

	```py
	import torch

	device = torch.accelerator.current_accelerator().type if torch.accelerator.is_available() else "cpu"
	```

	## Instalasi yang dapat diedit

	Instalasi yang dapat diedit (editable install) direkomendasikan untuk alur kerja pengembangan atau jika Anda menggunakan versi `main` dari kode sumber. Tautan khusus dibuat antara repositori yang dikloning dan jalur pustaka Python. Hal ini menghindari pemasangan ulang paket setelah setiap perubahan.

	Kloning repositori dan instal Diffusers dengan perintah berikut.

	```bash
	git clone https://github.com/huggingface/diffusers.git
	cd diffusers
	uv pip install -e ".[torch]"
	```

	> [!WARNING]
	> Anda harus menyimpan folder `diffusers` jika ingin terus menggunakan pustaka dengan instalasi yang dapat diedit.

	Perbarui repositori yang telah Anda klon ke versi terbaru Diffusers dengan perintah di bawah ini.

	```bash
	cd ~/diffusers/
	git pull
	```

	## Cache

	Bobot model dan file diunduh dari Hub ke cache, yang biasanya adalah direktori home Anda. Ubah lokasi cache dengan variabel lingkungan [HF_HOME](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhome) atau [HF_HUB_CACHE](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhubcache) atau dengan mengonfigurasi parameter `cache_dir` pada metode seperti [from_pretrained()](/docs/diffusers/main/id/api/pipelines/overview#diffusers.DiffusionPipeline.from_pretrained).

	```bash
	export HF_HOME="/path/to/your/cache"
	export HF_HUB_CACHE="/path/to/your/hub/cache"
	```

	```py
	from diffusers import DiffusionPipeline

	pipeline = DiffusionPipeline.from_pretrained(
	"black-forest-labs/FLUX.1-dev",
	cache_dir="/path/to/your/cache"
	)
	```

	File yang di-cache memungkinkan Anda menggunakan Diffusers secara offline. Atur variabel lingkungan [HF_HUB_OFFLINE](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhuboffline) ke `1` untuk mencegah Diffusers terhubung ke internet.

	```shell
	export HF_HUB_OFFLINE=1
	```

	Untuk detail lebih lanjut tentang pengelolaan dan pembersihan cache, lihat panduan [Memahami caching](https://huggingface.co/docs/huggingface_hub/guides/manage-cache).

	### Bagikan file antar repositori

	Cache menyimpan satu salinan file meskipun beberapa repositori Hub memuatnya. Banyak pipeline menggunakan text encoder yang sama, seperti T5. Jika repositori pipeline kedua memiliki file text encoder yang sama dengan yang sudah Anda unduh, [from_pretrained()](/docs/diffusers/main/id/api/pipelines/overview#diffusers.DiffusionPipeline.from_pretrained) menggunakan salinan di disk alih-alih mengunduhnya lagi. Diffusers membutuhkan `huggingface_hub>=1.32.0`, yang mengaktifkan berbagi file secara default.

	Cache mencocokkan file berdasarkan hash [Xet](https://huggingface.co/docs/hub/xet/index), bukan berdasarkan nama repositori atau model. Checkpoint yang di-shard dicocokkan per shard, sehingga shard yang cocok akan dibagikan meskipun shard lainnya berbeda.

	Sebuah file dibagikan hanya jika semua kondisi berikut terpenuhi:

	- Kedua repositori menyimpan file dengan Xet.
	- Kedua unduhan menggunakan direktori cache yang sama, yang diatur oleh `HF_HUB_CACHE` atau `cache_dir`.
	- Sistem file mendukung symlink.
	- File-file tersebut identik per byte. Mengonversi ke dtype yang berbeda, menyimpan dalam format yang berbeda, atau melakukan resharding akan mengubah hash.

	> [!NOTE]
	> File yang Anda unduh dengan versi `huggingface_hub` yang lebih lama tidak dibagikan dengan unduhan baru. Hanya file yang diunduh dengan versi 1.32.0 atau lebih baru yang ditambahkan ke penyimpanan bersama.

	Berbagi file menghemat waktu unduhan dan ruang disk, tetapi tidak menghemat memori. Untuk menggunakan satu model yang dimuat di beberapa pipeline, lihat [Reusing models in multiple pipelines](./using-diffusers/loading#reusing-models-in-multiple-pipelines).

	Untuk menonaktifkan berbagi file, atur `HF_HUB_DISABLE_SHARED_BLOBS=1`. Proses pemuatan tetap berfungsi, dan setiap repositori menyimpan salinannya sendiri.

	```shell
	export HF_HUB_DISABLE_SHARED_BLOBS=1
	```

	## Pencatatan telemetri

	Diffusers mengumpulkan informasi telemetri selama permintaan [from_pretrained()](/docs/diffusers/main/id/api/pipelines/overview#diffusers.DiffusionPipeline.from_pretrained). Data yang dikumpulkan mencakup versi Diffusers dan PyTorch, kelas model atau pipeline yang diminta, serta jalur ke checkpoint pretrained jika dihosting di Hub.

	Data penggunaan ini membantu kami men-debug masalah dan memprioritaskan fitur baru. Telemetri hanya dikirim saat memuat model dan pipeline dari Hub, dan tidak dikumpulkan jika Anda memuat file lokal.

	Matikan dan nonaktifkan pengumpulan telemetri dengan variabel lingkungan [HF_HUB_DISABLE_TELEMETRY](https://huggingface.co/docs/huggingface_hub/package_reference/environment_variables#hfhubdisabletelemetry).

	```bash
	export HF_HUB_DISABLE_TELEMETRY=1
	```

	```bash
	set HF_HUB_DISABLE_TELEMETRY=1
	```