Hub Python Library documentation

Spaceランタイムの管理

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Spaceランタイムの管理

Hub上のSpaceを管理するためのメソッドの参考情報については、HfApiのドキュメントページを確認してください。

データ構造

SpaceRuntime

クラス huggingface_hub.SpaceRuntime

< >

( data: dict )

パラメータ

  • stage (str) — スペースの現在のステージです。例: RUNNING。
  • hardware (str または None) — スペースの現在のハードウェアです。例: “cpu-basic”。スペースが初めて BUILDING 状態にある場合、None になることがあります。
  • requested_hardware (str または None) — 要求されたハードウェアです。要求がまさに行われたばかりの場合など、hardware と異なる場合があります。例: “t4-medium”。まだハードウェアが要求されていない場合は None になる可能性があります。
  • sleep_time (int or None) — 最後のリクエスト後、Space がアクティブな状態を維持する秒数です。デフォルト(値がNoneの場合)、アップグレードされたハードウェアで実行されている場合は Space はスリープしませんが、無料の ‘cpu-basic’ ハードウェアでは 48 時間後にスリープします。詳細については、https://huggingface.co/docs/hub/spaces-gpus#sleep-timeを参照してください。
  • volumes (list[Volume] または None) — Space にマウントされているボリュームのリストです。各ボリュームは、その種類、ソース、マウントパス、およびオプションの設定を記述する Volume オブジェクトです。ボリュームが接続されていない場合は None になります。
  • raw (dict) — サーバーからの生レスポンス。Space ランタイムに関する追加情報(レプリカ数、CPU 数、メモリサイズなど)が含まれます。

Spaceの現在のランタイムに関する情報を含みます。

SpaceHardware

クラス huggingface_hub.SpaceHardware

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1 )

Hub上のSpaceを実行するために利用可能なハードウェアの列挙。

Value は文字列と比較できます:

assert SpaceHardware.CPU_BASIC == "cpu-basic"

https://github.com/huggingface-internal/moon-landing/blob/main/server/repo_types/SpaceHardwareFlavor.ts(非公開URL)より引用。

SpaceStage

クラス huggingface_hub.SpaceStage

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1 )

Hub上のSpaceのステージとして考えられる値の列挙。

Value は文字列と比較できます:

assert SpaceStage.BUILDING == "BUILDING"

https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceInfo.ts#L61 (非公開URL)より引用。

SpaceStorage

クラス huggingface_hub.SpaceStorage

< >

( valuenames = Nonemodule = Nonequalname = Nonetype = Nonestart = 1 )

Hub上のSpaceで利用可能な永続ストレージの列挙。

Value は文字列と比較できます:

assert SpaceStorage.SMALL == "small"

https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceHardwareFlavor.ts#L24 (非公開URL)より引用。

SpaceVariable

クラス huggingface_hub.SpaceVariable

< >

( key: strvalues: dict )

パラメータ

  • key (str) — 変数のキー。例: "MODEL_REPO_ID"
  • value (str) — 変数の値。例: "the_model_repo_id"。
  • description (str または None) — 変数の説明。例: "Model Repo ID of the implemented model"。
  • updatedAt (datetime または None) — 変数の最終更新時刻(変数が少なくとも一度更新された場合)。

Spaceの現在の変数に関する情報を含みます。

SpaceTemplate

クラス huggingface_hub.SpaceTemplate

< >

( data: dict )

パラメータ

  • name (str) — テンプレートの人間が読みやすい名前(例: "JupyterLab"、"chatbot")。
  • repo_id (str) — テンプレート Space のリポジトリ ID(例: "SpacesExamples/jupyterlab")。
  • sdk (str) — テンプレートが構築されているSDK(例: "gradio"、"docker"、"static")。
  • preferred_private (bool) — このテンプレートから作成される Spaces が非公開であることが推奨されるかどうかを示します。

Hubで利用可能なSpaceテンプレートに関する情報を含みます。

HfApi.list_space_templates() によって返されます。repo_id を space_template として HfApi.create_repo() に渡すことで、そのテンプレートから新しい Space を作成できます。

ZeroGpuQuota

クラス huggingface_hub.ZeroGpuQuota

< >

( data: dict )

パラメータ

  • base (float) — GPU秒単位の総クォータ。
  • remaining (float) — GPU秒単位の残りのクォータ。
  • resets_at (datetime または None) — クォータがリセットされる日付です。クォータがまだ使用されていない場合は None になります。
  • overquota_used (float または None) — ベースクォータを使い切った後に消費されたオーバークォータ(有料)GPU 秒数です。PRO、Team、Enterprise ユーザーは、https://huggingface.co/settings/billing?add-credits=true でクレジットを購入し、ベースクォータを超えて利用できます。

認証済みユーザーのZeroGPUクォータに関する情報を含みます。

ZeroGPUのクォータは、ZeroGPU Spaceを使用するたびに(UIからでも、そのAPIを通じてでも)消費され、定期的にリセットされます。詳細はhttps://huggingface.co/docs/hub/spaces-zerogpuを参照してください。

HfApi.get_zero_gpu_quota()によって返されます。

Update on GitHub