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 必須執行的建議硬體。
對於旨在被其他使用者複製的 Spaces 很有用。
設定此值不會自動為該 Space 分配硬體。
值必須是有效的硬體型別。當前有效的硬體型別：

• CPU: "cpu-basic", "cpu-upgrade"
• GPU: "t4-small", "t4-medium", "l4x1", "l4x4", "a10g-small", "a10g-large", "a10g-largex2", "a10g-largex4","a100-large"
• TPU: "v5e-1x1", "v5e-2x2", "v5e-2x4"

suggested_storage : string
指定此 Space 必須執行的建議持久儲存。
對於旨在被其他使用者複製的 Spaces 很有用。
設定此值不會自動為該 Space 分配持久儲存。
值必須是 "small"、"medium" 或 "large" 之一。

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

app_build_command : string
對於靜態 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 時）還是固定寬度列（即“容器”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 應用程式。有關更多詳細資訊，請參閱向您的 Space 新增“使用 HF 登入”按鈕。

hf_oauth_scopes : List[string] 已連線 OAuth 應用程式的授權範圍。openid 和 profile 預設授權，無需此引數。有關更多詳細資訊，請參閱向您的 Space 新增“使用 HF 登入”按鈕。

hf_oauth_expiration_minutes : int OAuth 令牌的持續時間（分鐘）。預設為 480 分鐘（8 小時）。最長持續時間為 43200 分鐘（30 天）。有關更多詳細資訊，請參閱向您的 Space 新增“使用 HF 登入”按鈕。

hf_oauth_authorized_org : string 或 List[string] 將 OAuth 訪問限制為特定組織的成員。有關更多詳細資訊，請參閱向您的 Space 新增“使用 HF 登入”按鈕。

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

startup_duration_timeout: string
為您的 Space 設定自定義啟動持續時間超時。這是您的 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" 格式指定要下載的特定提交。

用法示例

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 檔案的特定修訂版本。