Spaces 設定參考

Spaces 是透過儲存庫根目錄下的 README.md 檔案頂端的 YAML 區塊進行設定。所有接受的參數如下列出。

title : string
Space 的顯示標題。

emoji : string
Space 的表情符號（僅允許輸入表情符號字元）。

colorFrom : string
縮圖漸層的起始顏色（red, yellow, green, blue, indigo, purple, pink, gray）。

colorTo : string
縮圖漸層的起始顏色（red, yellow, green, blue, indigo, purple, pink, gray）。

sdk : string
可以是 gradio、docker 或 static。

python_version: string
任何有效的 Python 3.x 或 3.x.x 版本。
預設為 3.10。

sdk_version : string
指定要使用的 Gradio 版本。支援所有 Gradio 版本。

suggested_hardware : string
指定此 Space 執行時建議使用的 硬體。
對於旨在供其他使用者複製的 Space 非常有用。
設定此值不會自動為此 Space 指派硬體。
該值必須是有效的硬體類型。目前有效的硬體類型為：

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

suggested_storage : string
指定此 Space 執行時建議使用的 永久儲存空間。
對於旨在供其他使用者複製的 Space 非常有用。
設定此值不會自動為此 Space 指派永久儲存空間。
該值必須是 "small"、"medium" 或 "large" 其中之一。

永久儲存功能已不再提供，因此此設定將被忽略。

app_file : string
您的主應用程式檔案路徑（包含 gradio Python 程式碼或 static HTML 程式碼）。
路徑是相對於儲存庫根目錄的。

app_build_command : string
對於靜態 (static) Spaces，這是首先執行以產生渲染用 HTML 的指令。範例：npm run build。

此設定需搭配 app_file 使用，後者指向建置後的索引檔案：例如 app_file: dist/index.html。

每次更新時，建置指令將在一個 Job 中執行，建置輸出將儲存在 refs/convert/build 中，並由 Space 提供服務。請參閱範例：https://huggingface.co/spaces/coyotte508/static-vite

app_port : int
應用程式執行的連接埠。僅在 sdk 為 docker 時使用。預設連接埠為 7860。

base_path: string 對於非靜態 Spaces，這是要渲染的初始 URL。需要以 / 開頭。對於靜態 Spaces，請改用 app_file。

fullWidth: boolean
您的 Space 是否在 iframe 內以全寬（true 時）或固定寬度欄位（即“container” CSS）渲染。預設為 true。

header: string
可以是 mini 或 default。如果 header 設定為 mini，Space 將以全螢幕顯示並帶有一個小型浮動標頭。

short_description: string Space 的簡短描述。這將顯示在 Space 的縮圖中。

models : List[string]
Space 中使用的 HF 模型 ID（例如 openai-community/gpt2 或 deepset/roberta-base-squad2）。如果此處未指定，將從您的程式碼中自動解析。

datasets : List[string]
Space 中使用的 HF 資料集 ID（例如 mozilla-foundation/common_voice_13_0 或 oscar-corpus/OSCAR-2109）。如果此處未指定，將從您的程式碼中自動解析。

tags : List[string]
描述您 Space 任務或範圍的標籤清單。

thumbnail: string
用於定義社群分享自訂縮圖的 URL。

pinned : boolean
Space 是否固定在您的個人資料頁面頂端。如果您擁有多個 Spaces，這很有用，可以讓您和其他人快速看到您最出色的 Space。

hf_oauth : boolean
此 Space 是否關聯了一個已連接的 OAuth 應用程式。詳情請參閱 將「使用 HF 登入」按鈕新增至您的 Space。

hf_oauth_scopes : List[string] 已連接 OAuth 應用程式的授權範圍。openid 和 profile 預設為已授權，不需要此參數。詳情請參閱 將「使用 HF 登入」按鈕新增至您的 Space。

hf_oauth_expiration_minutes : int OAuth 權杖的有效期限（以分鐘為單位）。預設為 480 分鐘（8 小時）。最長期限為 43200 分鐘（30 天）。詳情請參閱 將「使用 HF 登入」按鈕新增至您的 Space。

hf_oauth_authorized_org : string 或 List[string] 將 OAuth 存取權限限制為特定組織的成員。詳情請參閱 將「使用 HF 登入」按鈕新增至您的 Space。

disable_embedding : boolean Space iframe 是否可以嵌入其他網站。預設為 false，即 Spaces 可以被嵌入。

startup_duration_timeout: string 為您的 Space 設定自訂啟動逾時時間。這是您的 Space 在被標記為不健康並逾時之前允許啟動的最長時間。預設為 30 分鐘，但任何有效的持續時間（如 1h、30m）皆可接受。

custom_headers : Dict[string, string]
設定自訂 HTTP 標頭，這些標頭將在為您的 Space 提供服務時新增至所有 HTTP 回應中。
目前僅允許使用 cross-origin-embedder-policy (COEP)、cross-origin-opener-policy (COOP) 和 cross-origin-resource-policy (CORP) 標頭。這些標頭可用於建立跨來源隔離環境並啟用強大功能，例如 SharedArrayBuffer。

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

注意：所有標頭和值皆必須為小寫。

preload_from_hub: List[string] 指定一個要在 Space 建置期間預先載入的 Hugging Face Hub 模型或其他大型檔案清單。這能讓應用程式啟動時檔案已就緒，從而最佳化啟動時間。這對於依賴大型模型或資料集的 Spaces 特別有用，否則這些檔案需要在執行階段下載。

每個項目的格式為 "repository_name"（下載儲存庫中的所有檔案），或 "repository_name file1,file2"（下載該儲存庫中的特定檔案）。您也可以使用 "repository_name file1,file2 commit_sha256" 格式來指定要下載的特定 commit。

使用範例

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

在此範例中，Space 將在建置期間從 Hugging Face Hub 預先載入 warp-ai/wuerstchen-prior 的特定 .safetensors 檔案、完整的 coqui/XTTS-v1 儲存庫，以及 openai-community/gpt2 儲存庫中 config.json 檔案的特定版本。

檔案儲存在預設的 huggingface_hub 磁碟快取路徑 ~/.cache/huggingface/hub 中。如果您的應用程式預期檔案在其他位置，或者您更改了 HF_HOME 變數，目前此預先載入功能無法跟隨該變動。

目前尚不支援預先載入私人儲存庫。