o j/@sddlmZddlmZddlmZddlmZddlmZGddde eZ Gdd d e eZ Gd d d e eZ eGd d d Z eGdddZeGdddZeGdddZeGdddZeGdddZdS)) dataclass)datetime)Enum)Literal)parse_datetimec@s@eZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdS) SpaceStagea Enumeration of possible stage of a Space on the Hub. Value can be compared to a string: ```py assert SpaceStage.BUILDING == "BUILDING" ``` Taken from https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceInfo.ts#L61 (private url). NO_APP_FILE CONFIG_ERRORBUILDING BUILD_ERRORRUNNINGRUNNING_BUILDING RUNTIME_ERRORDELETINGSTOPPEDPAUSED APP_STARTINGRUNNING_APP_STARTINGN)__name__ __module__ __qualname____doc__rr r r r r rrrrrrrrM/home/kuhnn/.local/lib/python3.10/site-packages/huggingface_hub/_space_api.pyrs rc@steZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdS) SpaceHardwarea= Enumeration of hardwares available to run your Space on the Hub. Value can be compared to a string: ```py assert SpaceHardware.CPU_BASIC == "cpu-basic" ``` Taken from https://github.com/huggingface-internal/moon-landing/blob/main/server/repo_types/SpaceHardwareFlavor.ts (private url). z cpu-basicz cpu-upgradezcpu-performancezcpu-xlsprx8z zero-a10gzt4-smallz t4-mediuml4x1l4x4l40sx1l40sx4l40sx8z a10g-smallz a10g-largez a10g-largex2z a10g-largex4z a100-largea100x4a100x8h200h200x2h200x4h200x8inf2x6N)rrrr CPU_BASIC CPU_UPGRADECPU_PERFORMANCECPU_XLSPRX8 ZERO_A10GT4_SMALL T4_MEDIUML4X1L4X4L40SX1L40SX4L40SX8 A10G_SMALL A10G_LARGE A10G_LARGEX2 A10G_LARGEX4 A100_LARGEA100X4A100X8H200H200X2H200X4H200X8INF2X6rrrrr1s6 rc@seZdZdZdZdZdZdS) SpaceStoragea5 Enumeration of persistent storage available for your Space on the Hub. Value can be compared to a string: ```py assert SpaceStorage.SMALL == "small" ``` Taken from https://github.com/huggingface/moon-landing/blob/main/server/repo_types/SpaceHardwareFlavor.ts#L24 (private url). smallmediumlargeN)rrrrSMALLMEDIUMLARGErrrrrA_s  rAc@seZdZUdZeded<eed<eed<dZedBed<dZe dBed<dZ edBed <dd d Z d e fd dZ d efddZdS)Volumea Describes a volume to mount in a Space or Job container. Args: type (`str`): Type of volume: `"bucket"`, `"model"`, `"dataset"`, or `"space"`. source (`str`): Source identifier, e.g. `"username/my-bucket"` or `"username/my-model"`. mount_path (`str`): Mount path inside the container, e.g. `"/data"`. Must start with `/`. revision (`str` or `None`): Git revision (only for repos, defaults to `"main"`). read_only (`bool` or `None`): Read-only mount. Forced `True` for repos, defaults to `False` for buckets. path (`str` or `None`): Subfolder prefix inside the bucket/repo to mount, e.g. `"path/to/dir"`. )bucketmodeldatasetspacetypesource mount_pathNrevision read_onlypathreturncKsv|dd|_|d|_|d}|dur|n|d|_|d|_|d}|dur-|n|d|_|d |_dS) NrMrJrN mountPathrOrPreadOnlyrQrR)getrMrNrOrPrQrR)selfkwargsrOrQrrr__init__s    zVolume.__init__cCsR|j|j|jd}|jdur|j|d<|jdur|j|d<|jdur'|j|d<|S)z6Serialize to the JSON payload expected by the Hub API.)rMrNrTNrPrUrR)rMrNrOrPrQrRrWdatarrrto_dicts      zVolume.to_dictc Csj|jr d|jnd}|jrd|jnd}dddd|jd}d|jd|j||d |j| S) zDReturn the volume as an HF handle in the format expected by the CLI./@z:roz:rw)TFNzhf://zs/:)rRrPrVrQrMrNrO)rWrRrProrrr to_hf_handles(zVolume.to_hf_handle)rSN)rrrrr__annotations__strrPrQboolrRrYdictr\rbrrrrrHps    rHc@sLeZdZUeded<eeeedBfed<eed<deddfdd Z dS) SpaceHotReloading)createdcanceledstatusNreplica_statusesrawr[rScCs|d|_|d|_||_dS)NrjreplicaStatuses)rjrkrlrZrrrrYs   zSpaceHotReloading.__init__) rrrrrclisttuplerdrfrYrrrrrgs rgc@seZdZUdZeed<edBed<edBed<edBed<edBed<e dBed<e e dBed <e ed <d e d dfd dZ dS) SpaceRuntimea Contains information about the current runtime of a Space. Args: 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,... stageNhardwarerequested_hardware sleep_timestorage hot_reloadingvolumesrlr[rScCs|d|_|did|_|did|_|d|_|d|_|d}dur2t|nd|_|d}|durEd d |Dnd|_||_ dS) Nrqrrcurrent requested gcTimeoutru hotReloadingrwcSsg|] }tdi|qS)r)rH).0vrrr sz)SpaceRuntime.__init__..) rqrVrrrsrtrurgrvrwrl)rWr[raw_hr raw_volumesrrrrYs      zSpaceRuntime.__init__)rrrrrrcrintrArgrnrHrfrYrrrrrps      rpc@sHeZdZUdZeed<edBed<edBed<dededdfdd ZdS) SpaceSecreta& Contains information about a secret of a Space. Secret values are write-only and cannot be read back. Only the key, description, and last update time are returned by the API. Args: key (`str`): Secret key. Example: `"GITHUB_API_KEY"` description (`str` or None): Description of the secret. Example: `"Github API key to access the Github API"`. updated_at (`datetime` or None): datetime of the last update of the secret (if the secret has been updated at least once). keyN description updated_atvaluesrScCs<||_|d|_|d}|durt||_dSd|_dS)Nr updatedAt)rrVrrrrWrrrrrrrYs   zSpaceSecret.__init__ rrrrrdrcrrfrYrrrrrs   rc@sPeZdZUdZeed<eed<edBed<edBed<dededdfd d ZdS) SpaceVariablea Contains information about the current variables of a Space. Args: 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). rvalueNrrrrScCsF||_|d|_|d|_|d}|durt||_dSd|_dS)Nrrr)rrrVrrrrrrrrYs     zSpaceVariable.__init__rrrrrrs   rc@seZdZUdZeed<eed<eed<edBed<edBed<eed<eed <eedBed <e dBed <edBed <edBed <e dBed<edBed<de ddfddZ dS)SpaceSearchResultaA single result from the Spaces semantic search API. Returned by [`HfApi.search_spaces`]. Attributes: id (`str`): ID of the Space (e.g. `"username/repo-name"`). author (`str`): Author of the Space. title (`str`): Display title of the Space. emoji (`str` or `None`): Emoji icon of the Space. sdk (`str` or `None`): SDK used by the Space (e.g. `"gradio"`, `"docker"`, `"static"`). likes (`int`): Number of likes. private (`bool`): Whether the Space is private. tags (`list[str]` or `None`): List of tags. runtime ([`SpaceRuntime`] or `None`): Runtime information (stage, hardware, etc.). ai_short_description (`str` or `None`): AI-generated short description. ai_category (`str` or `None`): AI-generated category (e.g. `"Image Generation"`). semantic_relevancy_score (`float` or `None`): Semantic relevancy score (0-1) relative to the search query. trending_score (`int` or `None`): Trending score. idauthortitleNemojisdklikesprivatetagsruntimeai_short_description ai_categorysemantic_relevancy_scoretrending_scorer[rScCs|d}|d|_|dd|_|dd|_|d|_|d|_|dd |_|d d |_|d |_|r>t |nd|_ |d |_ |d|_ |d|_ |d|_dS)Nrrrr^rrrrrrFrrrsemanticRelevancyScore trendingScore)rVrrrrrrrrrprrrrr)rWr[rrrrrYRs        zSpaceSearchResult.__init__) rrrrrdrcrrernrpfloatrfrYrrrrr!s !       rN) dataclassesrrenumrtypingrhuggingface_hub.utilsrrdrrrArHrgrprrrrrrrs(    .; /