Hub Python Library documentation

Managing your Space runtime

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.23.0).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Managing your Space runtime

Check the HfApi documentation page for the reference of methods to manage your Space on the Hub.

Data structures

SpaceRuntime

class huggingface_hub.SpaceRuntime

< >

( data: Dict )

Parameters

  • stage (str) — Current stage of the space. Example: RUNNING.
  • hardware (str or None) — Current hardware of the space. Example: “cpu-basic”. Can be None if Space is BUILDING for the first time.
  • requested_hardware (str or None) — Requested hardware. Can be different than hardware especially if the request has just been made. Example: “t4-medium”. Can be None if no hardware has been requested yet.
  • sleep_time (int or None) — Number of seconds the Space will be kept alive after the last request. By default (if value is None), the Space will never go to sleep if it’s running on an upgraded hardware, while it will go to sleep after 48 hours on a free ‘cpu-basic’ hardware. For more details, see https://huggingface.co/docs/hub/spaces-gpus#sleep-time.
  • raw (dict) — Raw response from the server. Contains more information about the Space runtime like number of replicas, number of cpu, memory size,…

Contains information about the current runtime of a Space.

SpaceHardware

class huggingface_hub.SpaceHardware

< >

( value names = None module = None qualname = None type = None start = 1 )

Enumeration of hardwares available to run your Space on the Hub.

Value can be compared to a string:

assert SpaceHardware.CPU_BASIC == "cpu-basic"

Taken from https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceInfo.ts#L73 (private url).

SpaceStage

class huggingface_hub.SpaceStage

< >

( value names = None module = None qualname = None type = None start = 1 )

Enumeration of possible stage of a Space on the Hub.

Value can be compared to a string:

assert SpaceStage.BUILDING == "BUILDING"

Taken from https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceInfo.ts#L61 (private url).

SpaceStorage

class huggingface_hub.SpaceStorage

< >

( value names = None module = None qualname = None type = None start = 1 )

Enumeration of persistent storage available for your Space on the Hub.

Value can be compared to a string:

assert SpaceStorage.SMALL == "small"

Taken from https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceHardwareFlavor.ts#L24 (private url).

SpaceVariable

class huggingface_hub.SpaceVariable

< >

( key: str values: Dict )

Parameters

  • key (str) — Variable key. Example: "MODEL_REPO_ID"
  • value (str) — Variable value. Example: "the_model_repo_id".
  • description (str or None) — Description of the variable. Example: "Model Repo ID of the implemented model".
  • updatedAt (datetime or None) — datetime of the last update of the variable (if the variable has been updated at least once).

Contains information about the current variables of a Space.

< > Update on GitHub