huggingface_hub/pr_4113/en/package_reference/space_runtime.md

Managing your Space runtime

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

• Duplicate a Space: duplicate_space()
• Fetch current runtime: get_space_runtime()
• Fetch build or run logs: fetch_space_logs()
• Manage secrets: add_space_secret() and delete_space_secret()
• Manage hardware: request_space_hardware()
• Manage state: pause_space(), restart_space(), set_space_sleep_time()

Data structures

SpaceRuntime[[huggingface_hub.SpaceRuntime]]

huggingface_hub.SpaceRuntime[[huggingface_hub.SpaceRuntime]]

Source

Contains information about the current runtime of a Space.

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 from 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.

volumes (list[Volume] or None) : List of volumes mounted in the Space. Each volume is a Volume object describing its type, source, mount path, and optional settings. None if no volumes are attached.

raw (dict) : Raw response from the server. Contains more information about the Space runtime like number of replicas, number of cpu, memory size,...

SpaceHardware[[huggingface_hub.SpaceHardware]]

huggingface_hub.SpaceHardware[[huggingface_hub.SpaceHardware]]

Source

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-internal/moon-landing/blob/main/server/repo_types/SpaceHardwareFlavor.ts (private url).

SpaceStage[[huggingface_hub.SpaceStage]]

huggingface_hub.SpaceStage[[huggingface_hub.SpaceStage]]

Source

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[[huggingface_hub.SpaceStorage]]

huggingface_hub.SpaceStorage[[huggingface_hub.SpaceStorage]]

Source

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[[huggingface_hub.SpaceVariable]]

huggingface_hub.SpaceVariable[[huggingface_hub.SpaceVariable]]

Source

Contains information about the current variables of a Space.

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).