Referensi Konfigurasi Spaces

Spaces dikonfigurasi melalui blok YAML di bagian atas file README.md di root repositori. Semua parameter yang diterima tercantum di bawah ini.

title : string
Judul tampilan untuk Space.

emoji : string
Emoji spasi (karakter emoji saja yang diizinkan).

colorFrom : string
Warna untuk gradien Thumbnail (merah, kuning, hijau, biru, indigo, ungu, pink, abu-abu).

colorTo : string
Warna untuk gradien Thumbnail (merah, kuning, hijau, biru, indigo, ungu, pink, abu-abu).

sdk : string
Bisa berupa gradio, docker, atau static.

python_version: string
Versi Python 3.x atau 3.x.x yang valid apa pun.
Secara default, nilainya adalah 3.10.

sdk_version : string
Tentukan versi Gradio yang akan digunakan. Semua versi Gradio didukung.

suggested_hardware : string
Tentukan hardware yang disarankan untuk menjalankan Space ini.
Berguna untuk Spaces yang dimaksudkan untuk diduplikasi oleh pengguna lain.
Menetapkan nilai ini tidak akan secara otomatis mengalokasikan hardware ke Space ini.
Nilai harus berupa hardware flavor yang valid. Hardware flavor yang valid saat ini:

• CPU: "cpu-basic", "cpu-upgrade"
• GPU: "t4-small", "t4-medium", "l4x1", "l4x4", "l40sx1", "l40sx4", "l40sx8", "rtx-pro-6000", "rtx-pro-6000x2", "rtx-pro-6000x4", "rtx-pro-6000x8", "a10g-small", "a10g-large", "a10g-largex2", "a10g-largex4", "a100-large", "a100x4", "a100x8"

suggested_storage : string
Tentukan penyimpanan permanen yang disarankan untuk menjalankan Space ini.
Berguna untuk Space yang dimaksudkan untuk diduplikasi oleh pengguna lain.
Menetapkan nilai ini tidak akan secara otomatis menetapkan penyimpanan permanen ke Space ini.
Nilai harus salah satu dari "small", "medium" atau "large".

Fitur penyimpanan persisten tidak lagi tersedia sehingga pengaturan ini akan diabaikan.

app_file : string
Path ke file aplikasi utama Anda (yang berisi kode Python gradio atau kode html static).
Path relatif terhadap root dari repository.

app_build_command : string
Untuk Spaces statis, perintah yang dijalankan pertama kali untuk menghasilkan HTML yang akan dirender. Contoh: npm run build.

Ini digunakan bersamaan dengan app_file yang menunjuk ke file indeks yang dibangun: misalnya app_file: dist/index.html.

Setiap pembaruan, perintah build akan dijalankan dalam sebuah Job dan output build akan disimpan di refs/convert/build, yang akan disajikan oleh Space. Lihat contohnya di https://huggingface.co/spaces/coyotte508/static-vite

app_port : int
Port tempat aplikasi Anda berjalan. Hanya digunakan jika sdk adalah docker. Port default adalah 7860.

base_path: string Untuk Spaces non-statis, url awal untuk dirender. Harus diawali dengan /. Untuk Spaces statis, gunakan app_file sebagai gantinya.

fullWidth: boolean
Apakah Space Anda dirender di dalam kolom lebar penuh (ketika true) atau kolom lebar tetap (misalnya CSS “container”) di dalam iframe. Nilai defaultnya adalah true.

header: string
Bisa berupa mini atau default. Jika header diatur ke mini, ruang akan ditampilkan layar penuh dengan header mengambang mini.

short_description: string Deskripsi singkat tentang Space. Ini akan ditampilkan di thumbnail Space.

models : List[string]
ID model HF (seperti openai-community/gpt2 atau deepset/roberta-base-squad2) yang digunakan di Space. Akan diparsing secara otomatis dari kode Anda jika tidak ditentukan di sini.

datasets : List[string]
ID dataset HF (seperti mozilla-foundation/common_voice_13_0 atau oscar-corpus/OSCAR-2109) yang digunakan di Space. Akan diparsing secara otomatis dari kode Anda jika tidak ditentukan di sini.

tags : List[string]
Daftar istilah yang menjelaskan tugas atau ruang lingkup Space Anda.

thumbnail: string
URL untuk mendefinisikan thumbnail kustom untuk berbagi di media sosial.

pinned : boolean
Apakah Space tetap berada di bagian atas profil Anda. Dapat berguna jika Anda memiliki banyak Space sehingga Anda dan orang lain dapat dengan cepat melihat Space terbaik Anda.

hf_oauth : boolean
Apakah aplikasi OAuth yang terhubung terkait dengan Space ini. Lihat Menambahkan tombol Sign-In with HF ke Space Anda untuk detail lebih lanjut.

hf_oauth_scopes : List[string] Cakupan (scopes) yang diotorisasi untuk aplikasi OAuth yang terhubung. openid dan profile diotorisasi secara default dan tidak memerlukan parameter ini. Lihat Menambahkan tombol Sign-In with HF ke space Anda untuk detail lebih lanjut.

hf_oauth_expiration_minutes : int Durasi token OAuth dalam menit. Bawaan adalah 480 menit (8 jam). Durasi maksimum adalah 43200 menit (30 hari). Lihat Menambahkan tombol Sign-In with HF ke space Anda untuk detail lebih lanjut.

hf_oauth_authorized_org : string atau List[string] Membatasi akses OAuth untuk anggota organisasi tertentu. Lihat Menambahkan tombol Sign-In with HF ke space Anda untuk detail lebih lanjut.

disable_embedding : boolean Apakah iframe Space dapat disematkan di situs web lain. Nilai defaultnya false, yaitu Spaces dapat disematkan.

startup_duration_timeout: string Atur batas waktu durasi startup khusus untuk Space Anda. Ini adalah waktu maksimum yang diizinkan Space Anda untuk memulai sebelum habis waktu dan ditandai sebagai tidak sehat. Nilai defaultnya adalah 30 menit, tetapi durasi valid apa pun (seperti 1h, 30m) dapat diterima.

custom_headers : Dict[string, string]
Atur header HTTP kustom yang akan ditambahkan ke semua respons HTTP saat Anda menyajikan Space Anda.
Saat ini, hanya header cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP), dan cross-origin-resource-policy (CORP) yang diizinkan. Header-header ini dapat digunakan untuk mengatur lingkungan yang terisolasi lintas asal (cross-origin isolated) dan mengaktifkan fitur-fitur canggih seperti SharedArrayBuffer, misalnya:

custom_headers:
  cross-origin-embedder-policy: require-corp
  cross-origin-opener-policy: same-origin
  cross-origin-resource-policy: cross-origin

Catatan: semua header dan nilai harus menggunakan huruf kecil.

preload_from_hub: List[string] Tentukan daftar model Hugging Face Hub atau file besar lainnya yang akan dimuat sebelumnya (preloaded) selama proses build Space Anda. Hal ini mengoptimalkan waktu startup dengan memastikan file sudah siap saat aplikasi Anda dimulai. Fitur ini sangat berguna untuk Space yang bergantung pada model atau dataset besar yang jika tidak dimuat sebelumnya harus diunduh saat runtime.

Format untuk setiap item adalah "repository_name" untuk mengunduh semua file dari sebuah repositori, atau "repository_name file1,file2" untuk mengunduh file tertentu di dalam repositori tersebut. Anda juga dapat menentukan commit tertentu untuk diunduh menggunakan format "repository_name file1,file2 commit_sha256".

Contoh penggunaan:

preload_from_hub:
  - warp-ai/wuerstchen-prior text_encoder/model.safetensors,prior/diffusion_pytorch_model.safetensors
  - coqui/XTTS-v1
  - openai-community/gpt2 config.json 11c5a3d5811f50298f278a704980280950aedb10

Pada contoh ini, Space akan memuat ulang file .safetensors tertentu dari warp-ai/wuerstchen-prior, repositori lengkap coqui/XTTS-v1, dan revisi tertentu dari file config.json di repositori openai-community/gpt2 dari Hugging Face Hub saat proses build.

File disimpan di cache disk huggingface_hub bawaan ~/.cache/huggingface/hub. Jika aplikasi Anda mengharapkan file di lokasi lain atau Anda mengubah variabel HF_HOME, pra-pemuatan ini saat ini tidak mengikuti pengaturan tersebut.

Preloading untuk repositori privat belum didukung.