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 文件的特定修订版本。