Spaces 設定リファレンス

Spacesは、リポジトリのルートにあるREADME.mdファイルの先頭にあるYAMLブロックで設定されます。受け入れられるパラメータはすべて以下にリストされています。

title : string
Space の表示タイトル。

emoji : string
スペース絵文字（絵文字のみの文字が許可されます）。

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 を実行するために推奨される hardware を指定します。
他のユーザーによって複製されることを想定した Space に有用です。
この値を設定しても、この Space に自動的に hardware が割り当てられるわけではありません。
値は有効な hardware flavor である必要があります。現在有効な hardware flavors:

• 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
この Space を実行するために推奨される永続ストレージを指定します。
他のユーザーによって複製されることを想定した Space に有用です。
この値を設定しても、この 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
iframe 内で、Space が全幅（true の場合）または固定幅の列（「container」CSS など）でレンダリングされるかどうかを指定します。 デフォルト値は true です。

header: string
mini または default のいずれかです。header が mini に設定されている場合、スペースはフルスクリーンで表示され、ミニの浮動ヘッダーが表示されます。

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 が固定されるかどうか。Space が多数ある場合に、自分や他のユーザーが最良の Space を素早く確認できるようにするのに便利です。

hf_oauth : boolean
この Space に接続された OAuth アプリが関連付けられているかどうかを示します。詳細については、Space に HF によるサインイン ボタンを追加するを参照してください。

hf_oauth_scopes : List[string] 接続された OAuth アプリの認可スコープ。openid と profile はデフォルトで認可されるため、このパラメータは不要です。詳細は スペースに HF によるサインインボタンを追加する を参照してください。

hf_oauth_expiration_minutes : int OAuth トークンの有効期間（分単位）です。デフォルト値は 480 分（8 時間）です。最大期間は 43200 分（30 日）です。詳細については、スペースに HF によるサインインボタンを追加するを参照してください。

hf_oauth_authorized_org : string または List[string] 特定の組織のメンバーに OAuth アクセスを制限します。詳細については、スペースに Sign-In with HF ボタンを追加するを参照してください。

disable_embedding : boolean Spaceのiframeを他のウェブサイトに埋め込めるかどうかを指定します。 デフォルトはfalseです。つまり、Spacesは埋め込み可能です。

startup_duration_timeout: string Spaceの起動時間タイムアウトをカスタム設定します。これは、Spaceがタイムアウトして不健全とフラグ付けされる前に、起動を許可される最大時間です。 デフォルトは30分ですが、1hや30mなどの有効な期間であれば何でも指定できます。

custom_headers : Dict[string, string]
Spaceのサービング時に、すべてのHTTPレスポンスに追加されるカスタム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 ファイルの特定のリビジョンを事前読み込みします。

ファイルは、デフォルトのhuggingface_hubディスクキャッシュ~/.cache/huggingface/hubに保存されます。アプリケーションが他の場所を想定している場合や、HF_HOME変数を変更した場合は、現時点ではこのプリローディングがそれに追従しません。

プライベートリポジトリの事前読み込みは、まだサポートされていません。