Spaces 配置参考

Spaces 通过位于仓库根目录 README.md 文件顶部的 YAML 块进行配置。所有接受的参数都列在下面。

title : string
Space 的显示标题。

emoji : string
Space emoji（仅允许 emoji 字符）。

colorFrom : string
缩略图渐变的颜色（红色、黄色、绿色、蓝色、靛蓝色、紫色、粉色、灰色）。

colorTo : string
缩略图渐变的颜色（红色、黄色、绿色、蓝色、靛蓝色、紫色、粉色、灰色）。

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

python_version: string
任何有效的 Python 3.x 或 3.x.x 版本。
默认为 3.10。

sdk_version : string
指定所选 SDK 的版本（Streamlit 或 Gradio）。
支持 Gradio 的所有版本。
支持 0.79.0 及以上版本的 Streamlit。

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 或 streamlit Python 代码，或 static html 代码）。
路径相对于仓库的根目录。

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
是否有连接的 OAuth 应用与此 Space 关联。有关更多详细信息，请参阅向您的 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 在超时并被标记为不健康之前允许启动的最长时间。默认为 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 文件的特定修订版本。