Spaces Yapılandırma Referansı

Spaces, depoyun kök dizinindeki README.md dosyasının başındaki YAML bloğu üzerinden yapılandırılır. Kabul edilen tüm parametreler aşağıda listelenmiştir.

title : string
Space için görüntülenen başlık.

emoji : string
Boşluk emojisi (yalnızca emoji karakteri kabul edilir).

colorFrom : string
Küçük resim (thumbnail) gradyanı rengi (kırmızı, sarı, yeşil, mavi, lacivert, mor, pembe, gri).

colorTo : string
Küçük resim (thumbnail) gradyanı için renk (kırmızı, sarı, yeşil, mavi, lacivert, mor, pembe, gri).

sdk : string
gradio, docker veya static olabilir.

python_version: string
Geçerli herhangi bir Python 3.x veya 3.x.x sürümü.
Varsayılan olarak 3.10'dur.

sdk_version : string
Kullanılacak Gradio sürümünü belirtir. Gradio'nun tüm sürümleri desteklenir.

suggested_hardware : string
Bu Space'in çalıştırılması gereken önerilen donanımı belirtir.
Diğer kullanıcılar tarafından kopyalanması amaçlanan Spaces için kullanışlıdır.
Bu değeri ayarlamak, bu Space'e otomatik olarak bir donanım atamaz.
Değer, geçerli bir donanım türü olmalıdır. Geçerli donanım türleri:

• 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
Bu Space'in çalıştırılması gereken önerilen kalıcı depolamayı belirtir.
Diğer kullanıcılar tarafından kopyalanması amaçlanan Spaces için kullanışlıdır.
Bu değeri ayarlamak, bu Space'e otomatik olarak kalıcı bir depolama atamaz.
Değer, "small", "medium" veya "large" değerlerinden biri olmalıdır.

Kalıcı depolama özelliği artık kullanılamadığından bu ayar yok sayılacaktır.

app_file : string
Ana uygulama dosyanızın yolu (içinde gradio Python kodu veya static html kodu bulunur).
Yol, deponun kök dizinine göre göreli olarak tanımlanır.

app_build_command : string
Statik Spaces için, render edilecek HTML'i oluşturmak üzere ilk çalıştırılacak komut. Örnek: npm run build.

Bu, derlenmiş indeks dosyasına işaret eden app_file ile birlikte kullanılır: örn. app_file: dist/index.html.

Her güncellemede, derleme komutu bir Job içinde çalışır ve derleme çıktısı refs/convert/build konumunda saklanır; bu içerik Space tarafından sunulur. Örnek için https://huggingface.co/spaces/coyotte508/static-vite adresine bakın.

app_port : int
Uygulamanızın çalıştığı port. Yalnızca sdk değeri docker ise kullanılır. Varsayılan port 7860'dır.

base_path: string Statik olmayan Spaces için, render edilecek başlangıç url'si. / ile başlamalıdır. Statik Spaces için bunun yerine app_file kullanın.

fullWidth: boolean
Space'ınızın iframe içinde tam genişlikte (true ise) veya sabit genişlikli bir sütunda (ör. “container” CSS) render edilip edilmeyeceğini belirtir. Varsayılan değer true'dür.

header: string
mini veya default olabilir. header değeri mini olarak ayarlanırsa alan, mini bir yüzen başlıkla tam ekran olarak görüntülenir.

short_description: string Space'in kısa açıklaması. Bu, Space'in küçük resminde (thumbnail) görüntülenecektir.

models : List[string]
Space'te kullanılan HF model kimlikleri (ör. openai-community/gpt2 veya deepset/roberta-base-squad2). Burada belirtilmezse kodunuzdan otomatik olarak ayrıştırılır.

datasets : List[string]
Space'te kullanılan HF veri seti kimlikleri (ör. mozilla-foundation/common_voice_13_0 veya oscar-corpus/OSCAR-2109). Burada belirtilmezse kodunuzdan otomatik olarak ayrıştırılır.

tags : List[string]
Space görevinizi veya kapsamınızı tanımlayan terimlerin listesi.

thumbnail: string
Sosyal paylaşım için özel bir küçük resim tanımlamak için kullanılan URL.

pinned : boolean
Space'in profilinizin en üstünde kalıp kalmayacağını belirtir. Birçok Space'iniz varsa, sizin ve diğer kişilerin en iyi Space'inizi hızlıca görmesi için faydalı olabilir.

hf_oauth : boolean
Bu Space ile ilişkili bağlı bir OAuth uygulamasının olup olmadığı. Daha fazla ayrıntı için Space'inize HF ile Giriş Yapma düğmesi ekleme bölümüne bakın.

hf_oauth_scopes : List[string] Bağlı OAuth uygulamasının yetkili kapsamları. openid ve profile varsayılan olarak yetkilidir ve bu parametreye ihtiyaç duymaz. Daha fazla ayrıntı için Uzayınıza HF ile Giriş Yapma düğmesi ekleme bölümüne bakın.

hf_oauth_expiration_minutes : int OAuth jetonunun dakika cinsinden geçerlilik süresi. Varsayılan değer 480 dakikadır (8 saat). Maksimum süre 43200 dakikadır (30 gün). Daha fazla ayrıntı için Uzayınıza HF ile Giriş Yapma düğmesi ekleme bölümüne bakın.

hf_oauth_authorized_org : string veya List[string] OAuth erişimini belirli kuruluşların üyelerine kısıtlar. Daha fazla ayrıntı için Alanınıza HF ile Giriş Yapma düğmesi ekleme bölümüne bakın.

disable_embedding : boolean Space iframe'ının diğer web sitelerine gömülüp gömülemeyeceğini belirtir. Varsayılan olarak false'dır, yani Spaces gömülebilir.

startup_duration_timeout: string Space'iniz için özel bir başlatma süresi zaman aşımı ayarlayın. Bu, Space'inizin zaman aşımına uğramadan ve sağlıksız olarak işaretlenmeden önce başlatılmasına izin verilen en uzun süredir. Varsayılan olarak 30 dakikadır, ancak geçerli herhangi bir süre (ör. 1h, 30m) kabul edilir.

custom_headers : Dict[string, string]
Space'inizi sunarken tüm HTTP yanıtlarına eklenecek özel HTTP başlıklarını ayarlayın.
Şu an için yalnızca cross-origin-embedder-policy (COEP), cross-origin-opener-policy (COOP) ve cross-origin-resource-policy (CORP) başlıkları izin verilmektedir. Bu başlıklar, SharedArrayBuffer gibi güçlü özellikleri etkinleştirmek için çapraz kaynak yalıtımlı bir ortam kurmak amacıyla kullanılabilir; örneğin:

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

Not: tüm başlıklar ve değerler küçük harf olmalıdır.

preload_from_hub: List[string] Space'inizin derleme sırasında önceden yüklenmesi istenen Hugging Face Hub modelleri veya diğer büyük dosyaların listesini belirtir. Bu, dosyaların uygulamanız başlatıldığında hazır olmasını sağlayarak başlatma süresini optimize eder. Bu özellik, çalışma zamanında indirilmesi gereken büyük modeller veya veri setlerine bağımlı olan Spaces için özellikle faydalıdır.

Her öğenin biçimi, bir depodaki tüm dosyaları indirmek için "repository_name" veya o depodaki belirli dosyaları indirmek için "repository_name file1,file2" şeklindedir. İndirilecek belirli bir commit'i de "repository_name file1,file2 commit_sha256" biçimini kullanarak belirtebilirsiniz.

Örnek kullanım:

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

Bu örnekte, Space derleme sırasında Hugging Face Hub'dan warp-ai/wuerstchen-prior deposundan belirli .safetensors dosyalarını, coqui/XTTS-v1 deposunun tamamını ve openai-community/gpt2 deposundaki config.json dosyasının belirli bir revizyonunu önceden yükleyecektir.

Dosyalar, varsayılan huggingface_hub disk önbelleğinde, ~/.cache/huggingface/hub konumunda saklanır. Uygulamanız bunların başka bir yerde olmasını bekliyorsa veya HF_HOME değişkeninizi değiştirdiyseniz, bu ön yükleme şu an için bu ayarı takip etmez.

Özel depoların önceden yüklenmesi henüz desteklenmiyor.