o Zhԛ@s<ddlmZddlZddlZddlZddlZddlZddlmZm Z ddl m Z m Z m Z ddlmZddlmZddlmZddlmZdd lmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"dd l#m$Z$ddl%Z%dd l&m'Z'dd l(m)Z*dd l+m,Z,ddl-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6ddl7m8Z8m9Z9ddl:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEddlFmGZGmHZHmIZImJZJddlKmLZLmMZMmNZNmOZOmPZPmQZQddlRmSZSmTZTmUZUmVZVmWZWmXZXmYZYmZZZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZambZbmcZcmdZdmeZemfZfddlgmhZhmiZimjZjddlkmlZlmmZmmnZnddlompZpmqZqmrZrmsZsmtZtmuZumvZvmwZwmxZxmyZymzZzm{Z{m|Z|m}Z}m~Z~mZmZmZmZmZmZmZmZdd lom)ZddlmZmZddlmZddlmZmZmZe dZedZdZedZdZeeZdfdgd&d'Ze Gd(d)d)eZe Gd*d+d+eZe Gd,d-d-eZe Gd.d/d/eZe Gd0d1d1eZe Gd2d3d3eZe Gd4d5d5ZGd6d7d7eZe Gd8d9d9Ze Gd:d;d;Ze Gdd?d?Ze Gd@dAdAZe GdBdCdCZe GdDdEdEZe GdFdGdGZe GdHdIdIZe GdJdKdKZe GdLdMdMZe GdNdOdOZe GdPdQdQZe GdRdSdSZdhdVdWZGdXdYdYZ  didjdadbZdkdddeZeZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZej Z ej Z ej Z ej Z ej Z ej Z ejZejZejZejZdS)l) annotationsN)FutureThreadPoolExecutor)asdict dataclassfield)datetime)wraps)islice)Path) AnyBinaryIOCallableDictIterableIteratorListLiteralOptionalTupleTypeVarUnionoverload)quote) HTTPError)tqdm) thread_map) CommitOperationCommitOperationAddCommitOperationCopyCommitOperationDelete_fetch_files_to_copy_fetch_upload_modes_prepare_commit_payload_upload_lfs_files_warn_on_overwriting_operations)InferenceEndpointInferenceEndpointType) :MULTI_COMMIT_PR_CLOSE_COMMENT_FAILURE_BAD_REQUEST_TEMPLATE9MULTI_COMMIT_PR_CLOSE_COMMENT_FAILURE_NO_CHANGES_TEMPLATE(MULTI_COMMIT_PR_CLOSING_COMMENT_TEMPLATE+MULTI_COMMIT_PR_COMPLETION_COMMENT_TEMPLATEMultiCommitExceptionMultiCommitStepMultiCommitStrategy multi_commit_create_pull_requestmulti_commit_generate_comment!multi_commit_parse_pr_descriptionplan_multi_commits) SpaceHardware SpaceRuntime SpaceStorage SpaceVariable) DiscussionDiscussionCommentDiscussionStatusChangeDiscussionTitleChangeDiscussionWithDetailsdeserialize_event)_HF_DEFAULT_ENDPOINT_HF_DEFAULT_STAGING_ENDPOINTDEFAULT_ETAG_TIMEOUTDEFAULT_REQUEST_TIMEOUTDEFAULT_REVISIONDISCUSSION_STATUSDISCUSSION_TYPESENDPOINTINFERENCE_ENDPOINTS_ENDPOINTREGEX_COMMIT_OIDREPO_TYPE_MODEL REPO_TYPESREPO_TYPES_MAPPINGREPO_TYPES_URL_PREFIXESSAFETENSORS_INDEX_FILESAFETENSORS_MAX_HEADER_LENGTHSAFETENSORS_SINGLE_FILESPACES_SDK_TYPESDiscussionStatusFilterDiscussionTypeFilter)HfFileMetadataget_hf_file_metadata hf_hub_url)DatasetCardData ModelCardData SpaceCardData)IGNORE_GIT_FOLDER_PATTERNSBadRequestErrorEntryNotFoundErrorGatedRepoErrorHfFolderHfHubHTTPErrorLocalTokenNotFoundErrorNotASafetensorsRepoErrorRepositoryNotFoundErrorRevisionNotFoundErrorSafetensorsFileMetadataSafetensorsParsingErrorSafetensorsRepoMetadata TensorInfobuild_hf_headers experimentalfilter_repo_objects get_sessionhf_raise_for_statusloggingpaginateparse_datetimevalidate_hf_hub_args)_deprecate_arguments_deprecate_method) CallableT) DatasetFilter ModelFilter_is_emission_within_tresholdR)modeldatasetspaceZpaperZhf_userz.*/discussions/(\d+)$z Note: Creating a commit assumes that the repo already exists on the Huggingface Hub. Please use `create_repo` if it's not the case.hf_idstrhub_url Optional[str]return(Tuple[Optional[str], Optional[str], str]c Cs|}tttfvr|tt}|tt}tdd|dur|nt}||vo(d|v}d}||r8|t|d}|d}t|dk}|rr|dd\}}||krSd}t|d krd||d vrd|d } nZ|t vrot |} d}nOd} nL|rt|dkr|d d\} }}n:t|d kr|d t vrt |d } d}|dd }n|ddd\}}d} n|d }d \}} nt d|| t vrt | } | dkrd} | t vrt d| d|d| ||fS)a Returns the repo type and ID from a huggingface.co URL linking to a repository Args: hf_id (`str`): An URL or ID of a repository on the HF hub. Accepted values are: - https://huggingface.co/// - https://huggingface.co// - hf://// - hf:/// - // - / - hub_url (`str`, *optional*): The URL of the HuggingFace Hub, defaults to https://huggingface.co Returns: A tuple with three items: repo_type (`str` or `None`), namespace (`str` or `None`) and repo_id (`str`). Raises: - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If URL cannot be parsed. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If `repo_type` is unknown. z https?://N@zhf:///rNNz;Unable to retrieve user and repo ID from the passed HF ID: zUnknown `repo_type`: 'z' ('')) rEr>r?replaceresub startswithlensplitrJ ValueErrorrI) ryr{Z input_hf_idZ is_hf_urlZ HFFS_PREFIXZ url_segmentsZis_hf_id namespacerepo_id repo_typerM/var/www/html/lang_env/lib/python3.10/site-packages/huggingface_hub/hf_api.pyrepo_type_and_id_from_hf_idsR             rc@s.eZdZUded<ded<ded<ddZdS) LastCommitInforzoidtitlerdatecC|t|dSNupdaterselfrrr __post_init__zLastCommitInfo.__post_init__N__name__ __module__ __qualname____annotations__rrrrrr  rc@s.eZdZUded<ded<ded<ddZdS) BlobLfsInfointsizerzsha256 pointer_sizecCrrrrrrrrrzBlobLfsInfo.__post_init__Nrrrrrrrrc@s.eZdZUded<ded<ded<ddZdS) BlobSecurityInfoboolsafeOptional[Dict]av_scanpickle_import_scancCrrrrrrrrrzBlobSecurityInfo.__post_init__Nrrrrrr rrc@sBeZdZUded<dZded<dZded<dZded<dd ZdS) TransformersInforzZ auto_modelNr| custom_class pipeline_tag processorcCrrrrrrrrrzTransformersInfo.__post_init__)rrrrrrrrrrrrrs     rc@s&eZdZUded<ded<ddZdS)SafeTensorsInfozList[Dict[str, int]] parametersrtotalcCrrrrrrrr'rzSafeTensorsInfo.__post_init__Nrrrrrr"s  rc@seZdZUdZded<ded<ded<ded<dZded <ed d Zded <ed d Zded <ed ddZ ded<dddddZ ddZ dS) CommitInfoaData structure containing information about a newly created commit. Returned by any method that creates a commit on the Hub: [`create_commit`], [`upload_file`], [`upload_folder`], [`delete_file`], [`delete_folder`]. It inherits from `str` for backward compatibility but using methods specific to `str` is deprecated. Attributes: commit_url (`str`): Url where to find the commit. commit_message (`str`): The summary (first line) of the commit that has been created. commit_description (`str`): Description of the commit that has been created. Can be empty. oid (`str`): Commit hash id. Example: `"91c54ad1727ee830252e457677f467be0bfd8a57"`. pr_url (`str`, *optional*): Url to the PR that has been created, if any. Populated when `create_pr=True` is passed. pr_revision (`str`, *optional*): Revision of the PR that has been created, if any. Populated when `create_pr=True` is passed. Example: `"refs/pr/1"`. pr_num (`int`, *optional*): Number of the PR discussion that has been created, if any. Populated when `create_pr=True` is passed. Can be passed as `discussion_num` in [`get_discussion_details`]. Example: `1`. _url (`str`, *optional*): Legacy url for `str` compatibility. Can be the url to the uploaded file on the Hub (if returned by [`upload_file`]), to the uploaded folder on the Hub (if returned by [`upload_folder`]) or to the commit on the Hub (if returned by [`create_commit`]). Defaults to `commit_url`. It is deprecated to use this attribute. Please use `commit_url` instead. rz commit_urlcommit_messagecommit_descriptionrNr|pr_urlF)init pr_revisionpr_num)reprdefault_urlrcOst||p|Sr)rz__new__)clsrrargskwargsrrrraszCommitInfo.__new__cCs@|jdurt|j|_t|jdd|_dSd|_d|_dS)zPopulate pr-related fields after initialization. See https://docs.python.org/3.10/library/dataclasses.html#post-init-processing. Nrr)r_parse_revision_from_pr_urlrrrrrrrrrds   zCommitInfo.__post_init__)rrzrr|) rrr__doc__rrrrrrrrrrrrr+s '  rc@sFeZdZUdZded<ded<ded<ded<ded <d Zd ed <d S) AccessRequestaData structure containing information about a user access request. Attributes: username (`str`): Username of the user who requested access. fullname (`str`): Fullname of the user who requested access. email (`str`): Email of the user who requested access. timestamp (`datetime`): Timestamp of the request. status (`Literal["pending", "accepted", "rejected"]`): Status of the request. Can be one of `["pending", "accepted", "rejected"]`. fields (`Dict[str, Any]`, *optional*): Additional fields filled by the user in the gate form. rzusernamefullnameemailr timestampz*Literal['pending', 'accepted', 'rejected']statusNzOptional[Dict[str, Any]]fields)rrrrrrrrrrrqs rcs>eZdZdZddfdd Zddfd d ZdddZZS)RepoUrlaSubclass of `str` describing a repo URL on the Hub. `RepoUrl` is returned by `HfApi.create_repo`. It inherits from `str` for backward compatibility. At initialization, the URL is parsed to populate properties: - endpoint (`str`) - namespace (`Optional[str]`) - repo_name (`str`) - repo_id (`str`) - repo_type (`Literal["model", "dataset", "space"]`) - url (`str`) Args: url (`Any`): String value of the repo url. endpoint (`str`, *optional*): Endpoint of the Hub. Defaults to . Example: ```py >>> RepoUrl('https://huggingface.co/gpt2') RepoUrl('https://huggingface.co/gpt2', endpoint='https://huggingface.co', repo_type='model', repo_id='gpt2') >>> RepoUrl('https://hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://hub-ci.huggingface.co') RepoUrl('https://hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://hub-ci.huggingface.co', repo_type='dataset', repo_id='dummy_user/dummy_dataset') >>> RepoUrl('hf://datasets/my-user/my-dataset') RepoUrl('hf://datasets/my-user/my-dataset', endpoint='https://huggingface.co', repo_type='dataset', repo_id='user/dataset') >>> HfApi.create_repo("dummy_model") RepoUrl('https://huggingface.co/Wauplin/dummy_model', endpoint='https://huggingface.co', repo_type='model', repo_id='Wauplin/dummy_model') ``` Raises: - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If URL cannot be parsed. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If `repo_type` is unknown. Nurlr endpointr|cstt|||Sr)superrr)rrr __class__rrrrzRepoUrl.__new__r}Nonecsht|pt|_t||jd\}}}||_||_|dur |n|d||_|p+t|_ t ||_ dS)N)r{r) r__init__rErrr repo_namerrHrrzr)rrrrrrrrrrs   zRepoUrl.__init__rzc Cs$d|d|jd|jd|jd S)Nz RepoUrl('z ', endpoint='z', repo_type='z ', repo_id='r)rrrrrrr__repr__s$zRepoUrl.__repr__r)rr rr|)rr rr|r}rr}rz)rrrrrrr __classcell__rrrrrs ' rc@s>eZdZUdZded<dZded<dZded<dZd ed <dS) RepoSiblinga& Contains basic information about a repo file inside a repo on the Hub. All attributes of this class are optional except `rfilename`. This is because only the file names are returned when listing repositories on the Hub (with [`list_models`], [`list_datasets`] or [`list_spaces`]). If you need more information like file size, blob id or lfs details, you must request them specifically from one repo at a time (using [`model_info`], [`dataset_info`] or [`space_info`]) as it adds more constraints on the backend server to retrieve these. Attributes: rfilename (str): file name, relative to the repo root. size (`int`, *optional*): The file's size, in bytes. This attribute is defined when `files_metadata` argument of [`repo_info`] is set to `True`. It's `None` otherwise. blob_id (`str`, *optional*): The file's git OID. This attribute is defined when `files_metadata` argument of [`repo_info`] is set to `True`. It's `None` otherwise. lfs (`BlobLfsInfo`, *optional*): The file's LFS metadata. This attribute is defined when`files_metadata` argument of [`repo_info`] is set to `True` and the file is stored with Git LFS. It's `None` otherwise. rz rfilenameN Optional[int]rr|blob_idOptional[BlobLfsInfo]lfs)rrrrrrrrrrrrrs   rc@sVeZdZUdZded<ded<ded<dZded <dZd ed <dZd ed <ddZdS)RepoFilea Contains information about a file on the Hub. Attributes: path (str): file path relative to the repo root. size (`int`): The file's size, in bytes. blob_id (`str`): The file's git OID. lfs (`BlobLfsInfo`): The file's LFS metadata. last_commit (`LastCommitInfo`, *optional*): The file's last commit metadata. Only defined if [`list_files_info`], [`list_repo_tree`] and [`get_paths_info`] are called with `expand=True`. security (`BlobSecurityInfo`, *optional*): The file's security scan metadata. Only defined if [`list_files_info`], [`list_repo_tree`] and [`get_paths_info`] are called with `expand=True`. rzpathrrrNrrOptional[LastCommitInfo] last_commitzOptional[BlobSecurityInfo]securitycKs|d|_|d|_|d|_|dd}|dur)t|d|d|dd}||_|ddp7|dd}|durKt|d |d t|d d }||_|d d}|duret |d|d|dd}||_ |j|_ |j|_ dS)Nrrrr pointerSizerrr lastCommitridrrrrrrrZavScanZpickleImportScan)rrr) poprrrrrrrmrrrrr)rrrrrrrrr s*      zRepoFile.__init__) rrrrrrrrrrrrrrs     rc@s6eZdZUdZded<ded<dZded<dd ZdS) RepoFoldera Contains information about a folder on the Hub. Attributes: path (str): folder path relative to the repo root. tree_id (`str`): The folder's git OID. last_commit (`LastCommitInfo`, *optional*): The folder's last commit metadata. Only defined if [`list_repo_tree`] and [`get_paths_info`] are called with `expand=True`. rzrtree_idNrrcKs`|d|_|d|_|ddp|dd}|dur+t|d|dt|dd}||_dS) Nrrrrrrrr)rrrrrmr)rrrrrrr7s   zRepoFolder.__init__)rrrrrrrrrrrr$s    rc@seZdZUdZded<ded<ded<ded<ded <d ed <d ed <ded<ded<ded<ded<ded<ded<ded<ded<ded<ded<ded<ded <d!ed"<d#ed$<d%ed&<d'd(Zd)S)* ModelInfoau Contains information about a model on the Hub. Most attributes of this class are optional. This is because the data returned by the Hub depends on the query made. In general, the more specific the query, the more information is returned. On the contrary, when listing models using [`list_models`] only a subset of the attributes are returned. Attributes: id (`str`): ID of model. author (`str`, *optional*): Author of the model. sha (`str`, *optional*): Repo SHA at this particular revision. created_at (`datetime`, *optional*): Date of creation of the repo on the Hub. Note that the lowest value is `2022-03-02T23:29:04.000Z`, corresponding to the date when we began to store creation dates. last_modified (`datetime`, *optional*): Date of last commit to the repo. private (`bool`): Is the repo private. disabled (`bool`, *optional*): Is the repo disabled. gated (`Literal["auto", "manual", False]`, *optional*): Is the repo gated. If so, whether there is manual or automatic approval. downloads (`int`): Number of downloads of the model. likes (`int`): Number of likes of the model. library_name (`str`, *optional*): Library associated with the model. tags (`List[str]`): List of tags of the model. Compared to `card_data.tags`, contains extra tags computed by the Hub (e.g. supported libraries, model's arXiv). pipeline_tag (`str`, *optional*): Pipeline tag associated with the model. mask_token (`str`, *optional*): Mask token used by the model. widget_data (`Any`, *optional*): Widget data associated with the model. model_index (`Dict`, *optional*): Model index for evaluation. config (`Dict`, *optional*): Model configuration. transformers_info (`TransformersInfo`, *optional*): Transformers-specific info (auto class, processor, etc.) associated with the model. card_data (`ModelCardData`, *optional*): Model Card Metadata as a [`huggingface_hub.repocard_data.ModelCardData`] object. siblings (`List[RepoSibling]`): List of [`huggingface_hub.hf_api.RepoSibling`] objects that constitute the model. spaces (`List[str]`, *optional*): List of spaces using the model. safetensors (`SafeTensorsInfo`, *optional*): Model's safetensors information. rzrr|authorshaOptional[datetime] created_at last_modifiedrprivate*Optional[Literal['auto', 'manual', False]]gatedOptional[bool]disabledr downloadslikes library_name List[str]tagsr mask_tokenzOptional[ModelCardData] card_dataz Optional[Any] widget_datar model_indexconfigzOptional[TransformersInfo]transformers_infoOptional[List[RepoSibling]]siblingsOptional[List[str]]spaceszOptional[SafeTensorsInfo] safetensorscKs|d|_|dd|_|dd|_|ddp|dd}|r&t|nd|_|ddp4|dd}|r;t|nd|_|d|_|d d|_|d d|_ |d |_ |d |_ |d d|_ |d|_ |dd|_|dd|_|ddp|dd}t|trtd i|ddin||_|dd|_|ddp|dd|_|dd|_|ddp|dd}|rtd i|nd|_|dd}|rdd|Dnd|_|dd|_|dd}|rtd i|nd|_|j|_|j|_|j|_|j j!d i|dS)!Nrrr lastModifiedr createdAtrrrrrrrrrrcardDatarignore_metadata_errorsTZ widgetDataz model-indexrrtransformersInforr c S\g|]*}t|d|d|d|dr(t|dd|dd|dddnddqS rrZblobIdrrrrN)rrrrrgetr.0Zsiblingrrr    z&ModelInfo.__init__..r r r)"rrrrrmrrrrrrrrrrr isinstancedictrVrrrrrrr r rr r rr__dict__r)rrrrrrr r rrrrsL     "  zModelInfo.__init__NrrrrrrrrrrrBs2 = rc@seZdZUdZded<ded<ded<ded<ded <d ed <d ed <ded<ded<ded<ded<ded<ded<ded<ddZdS) DatasetInfoa Contains information about a dataset on the Hub. Most attributes of this class are optional. This is because the data returned by the Hub depends on the query made. In general, the more specific the query, the more information is returned. On the contrary, when listing datasets using [`list_datasets`] only a subset of the attributes are returned. Attributes: id (`str`): ID of dataset. author (`str`): Author of the dataset. sha (`str`): Repo SHA at this particular revision. created_at (`datetime`, *optional*): Date of creation of the repo on the Hub. Note that the lowest value is `2022-03-02T23:29:04.000Z`, corresponding to the date when we began to store creation dates. last_modified (`datetime`, *optional*): Date of last commit to the repo. private (`bool`): Is the repo private. disabled (`bool`, *optional*): Is the repo disabled. gated (`Literal["auto", "manual", False]`, *optional*): Is the repo gated. If so, whether there is manual or automatic approval. downloads (`int`): Number of downloads of the dataset. likes (`int`): Number of likes of the dataset. tags (`List[str]`): List of tags of the dataset. card_data (`DatasetCardData`, *optional*): Model Card Metadata as a [`huggingface_hub.repocard_data.DatasetCardData`] object. siblings (`List[RepoSibling]`): List of [`huggingface_hub.hf_api.RepoSibling`] objects that constitute the dataset. rzrr|rrrrrrrrrrrrrrpaperswithcode_idrrzOptional[DatasetCardData]rrr cKs^|d|_|dd|_|dd|_|ddp|dd}|r&t|nd|_|ddp4|dd}|r;t|nd|_|d|_|d d|_|d d|_ |d |_ |d |_ |d d|_ |d|_ |ddpv|dd}t|trtdi|ddin||_|dd}|rdd|Dnd|_|j|_|j|_|jjdi|dS)Nrrrrrr rrrrrrrrrrrTr c Srrrrrrrr$rz(DatasetInfo.__init__..r)rrrrrmrrrrrrrrrrrrUrr r rrr)rrrrrr rrrrs6     " zDatasetInfo.__init__Nrrrrrrs" * rc@seZdZUdZded<ded<ded<ded<ded <d ed <d ed <ded<ded<ded<ded<ded<ded<ded<ded<ded<ded<ded<d d!Zd"S)# SpaceInfoat Contains information about a Space on the Hub. Most attributes of this class are optional. This is because the data returned by the Hub depends on the query made. In general, the more specific the query, the more information is returned. On the contrary, when listing spaces using [`list_spaces`] only a subset of the attributes are returned. Attributes: id (`str`): ID of the Space. author (`str`, *optional*): Author of the Space. sha (`str`, *optional*): Repo SHA at this particular revision. created_at (`datetime`, *optional*): Date of creation of the repo on the Hub. Note that the lowest value is `2022-03-02T23:29:04.000Z`, corresponding to the date when we began to store creation dates. last_modified (`datetime`, *optional*): Date of last commit to the repo. private (`bool`): Is the repo private. gated (`Literal["auto", "manual", False]`, *optional*): Is the repo gated. If so, whether there is manual or automatic approval. disabled (`bool`, *optional*): Is the Space disabled. host (`str`, *optional*): Host URL of the Space. subdomain (`str`, *optional*): Subdomain of the Space. likes (`int`): Number of likes of the Space. tags (`List[str]`): List of tags of the Space. siblings (`List[RepoSibling]`): List of [`huggingface_hub.hf_api.RepoSibling`] objects that constitute the Space. card_data (`SpaceCardData`, *optional*): Space Card Metadata as a [`huggingface_hub.repocard_data.SpaceCardData`] object. runtime (`SpaceRuntime`, *optional*): Space runtime information as a [`huggingface_hub.hf_api.SpaceRuntime`] object. sdk (`str`, *optional*): SDK used by the Space. models (`List[str]`, *optional*): List of models used by the Space. datasets (`List[str]`, *optional*): List of datasets used by the Space. rzrr|rrrrrrrrrrrhost subdomainrrsdkrrrr zOptional[SpaceCardData]rzOptional[SpaceRuntime]runtimer modelsdatasetscKs|d|_|dd|_|dd|_|ddp|dd}|r&t|nd|_|ddp4|dd}|r;t|nd|_|d|_|d d|_|d d|_ |d d|_ |d d|_ |d |_ |dd|_ |d|_|ddp~|dd}t|trtdi|ddin||_|dd}|rdd|Dnd|_|dd}|rt|nd|_|dd|_|dd|_|j|_|j|_|jjdi|dS)Nrrrrrr rrrrr!r"rr#rrrrTr c Srrrrrrrrrz&SpaceInfo.__init__..r$r%r&r)rrrrrmrrrrrr!r"rr#rrrrWrr r5r$r%r&r rrr)rrrrrr r$rrrrs@    "  zSpaceInfo.__init__Nrrrrrr ?s* 4 r c@s2eZdZUdZded<ded<ded<ddZd S) MetricInfoa8 Contains information about a metric on the Hub. Attributes: id (`str`): ID of the metric. E.g. `"accuracy"`. space_id (`str`): ID of the space associated with the metric. E.g. `"Accuracy"`. description (`str`): Description of the metric. rzrspace_idr| descriptioncKsD|d|_|d|_|dd|_|j|_|jjdi|dS)NrspaceIdr)r)rrr(r)r*rr)rrrrrrs  zMetricInfo.__init__Nrrrrrr's   r'c@sLeZdZUdZded<ded<ded<ded<dZd ed < ddddZdS)CollectionItema Contains information about an item of a Collection (model, dataset, Space or paper). Attributes: item_object_id (`str`): Unique ID of the item in the collection. item_id (`str`): ID of the underlying object on the Hub. Can be either a repo_id or a paper id e.g. `"jbilcke-hf/ai-comic-factory"`, `"2307.09288"`. item_type (`str`): Type of the underlying object. Can be one of `"model"`, `"dataset"`, `"space"` or `"paper"`. position (`int`): Position of the item in the collection. note (`str`, *optional*): Note associated with the item, as plain text. rzitem_object_iditem_id item_typerpositionNr|note_idrtypeCollectionItemType_Trr}rcKs8||_||_||_||_|dur|d|_dSd|_dS)Ntext)r,r-r.r/r0)rr1rr2r/r0rrrrrs  zCollectionItem.__init__r) r1rzrrzr2r3r/rr0rr}r)rrrrrr0rrrrrr+s  r+c@s~eZdZUdZded<ded<ded<ded<ded <d ed <d ed <ded<d ed<dZded<dddZedddZdS) Collectiona Contains information about a Collection on the Hub. Attributes: slug (`str`): Slug of the collection. E.g. `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. title (`str`): Title of the collection. E.g. `"Recent models"`. owner (`str`): Owner of the collection. E.g. `"TheBloke"`. items (`List[CollectionItem]`): List of items in the collection. last_updated (`datetime`): Date of the last update of the collection. position (`int`): Position of the collection in the list of collections of the owner. private (`bool`): Whether the collection is private or not. theme (`str`): Theme of the collection. E.g. `"green"`. upvotes (`int`): Number of upvotes of the collection. description (`str`, *optional*): Description of the collection, as plain text. url (`str`): (property) URL of the collection on the Hub. rzslugrownerzList[CollectionItem]itemsr last_updatedrr/rrthemeupvotesNr|r)r}rcKs|d|_|d|_|d|_dd|dD|_t|d|_|d|_|d |_|d |_ |d |_ |d d|_ |d d}|durPt }|d|j|_ dS)Nr6rr7cSg|] }tdi|qSr)r+ritemrrrr(z'Collection.__init__..r8Z lastUpdatedr/rr:r;r)rz /collections/)rr6rr7r8rmr9r/rr:r;r)rEr)rrrrrrr$s        zCollection.__init__cCs|jS)z-Returns the URL of the collection on the Hub.rrrrrr4szCollection.url)r}rr) rrrrrr)rpropertyrrrrrr5s   r5c@*eZdZUdZded<ded<ded<dS) GitRefInfoa Contains information about a git reference for a repo on the Hub. Attributes: name (`str`): Name of the reference (e.g. tag name or branch name). ref (`str`): Full git ref on the Hub (e.g. `"refs/heads/main"` or `"refs/tags/v1.0"`). target_commit (`str`): OID of the target commit for the ref (e.g. `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`) rznameref target_commitNrrrrrrrrrrC:s   rCc@s6eZdZUdZded<ded<ded<dZded<dS) GitRefsa2 Contains information about all git references for a repo on the Hub. Object is returned by [`list_repo_refs`]. Attributes: branches (`List[GitRefInfo]`): A list of [`GitRefInfo`] containing information about branches on the repo. converts (`List[GitRefInfo]`): A list of [`GitRefInfo`] containing information about "convert" refs on the repo. Converts are refs used (internally) to push preprocessed data in Dataset repos. tags (`List[GitRefInfo]`): A list of [`GitRefInfo`] containing information about tags on the repo. pull_requests (`List[GitRefInfo]`, *optional*): A list of [`GitRefInfo`] containing information about pull requests on the repo. Only returned if `include_prs=True` is set. zList[GitRefInfo]branchesconvertsrNzOptional[List[GitRefInfo]] pull_requests)rrrrrrKrrrrrHMs rHc@sJeZdZUdZded<ded<ded<ded<ded <d ed <d ed <d S) GitCommitInfoau Contains information about a git commit for a repo on the Hub. Check out [`list_repo_commits`] for more details. Attributes: commit_id (`str`): OID of the commit (e.g. `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`) authors (`List[str]`): List of authors of the commit. created_at (`datetime`): Datetime when the commit was created. title (`str`): Title of the commit. This is a free-text value entered by the authors. message (`str`): Description of the commit. This is a free-text value entered by the authors. formatted_title (`str`): Title of the commit formatted as HTML. Only returned if `formatted=True` is set. formatted_message (`str`): Description of the commit formatted as HTML. Only returned if `formatted=True` is set. rz commit_idrauthorsrrrmessager|formatted_titleformatted_messageNrGrrrrrLgs  rLc@s:eZdZUdZded<ded<ded<ded<ded <d S) UserLikesa Contains information about a user likes on the Hub. Attributes: user (`str`): Name of the user for which we fetched the likes. total (`int`): Total number of likes. datasets (`List[str]`): List of datasets liked by the user (as repo_ids). models (`List[str]`): List of models liked by the user (as repo_ids). spaces (`List[str]`): List of spaces liked by the user (as repo_ids). rzuserrrrr&r%r NrGrrrrrRs  rRc@rB)Usera Contains information about a user on the Hub. Attributes: avatar_url (`str`): URL of the user's avatar. username (`str`): Name of the user on the Hub (unique). fullname (`str`): User's full name. rz avatar_urlrrNrGrrrrrTs   rTfnrqcs<t}t|jddtfdd}d|_|S)aWrap a method of `HfApi` to handle `run_as_future=True`. A method flagged as "future_compatible" will be called in a thread if `run_as_future=True` and return a `concurrent.futures.Future` instance. Otherwise, it will be called normally and return the result. rNcsvd|vr |d}d|d<nd}t|D] \}}|dkr |}nq|r0|j|g|Ri|S|g|Ri|S)N run_as_futureF)ziprW)rrrrWparamvalueZ args_paramsrVrr_inners z!future_compatible.._innerT)inspect signaturelistrr Zis_future_compatible)rVsigr\rr[rfuture_compatibles rac@sj eZdZ      ddddZdddZeddddZddddZdddZdddZ eddddddddddddddddddd dddd Z/eddddddddd?ddZ0eddddddddd?ddZ1edde2dd@ddZ3eddddddddde4ddddddAd-d.Z5edddddde4ddddddd/dd0dBd4d5Z6dddddCd7d8Z7dddddDd:d;Z8eddddd<dEd=d>Z9eddd^dFd?d@Z:eddddddAdGdDdEZ;eddd^dHdFdGZedddkdKdVdWZ?edddddXdLd\d]Z@edddd^dMd_d`ZAddddadNdfdgZBeddd^dOdjdkZCeddd^dPdndoZDeddddpdQdtduZEeddddpdRdvdwZFeddd^dSdzd{ZGeddd^dTd|d}ZHeddd~dUddZIeddfdVddZJeddfdWddZKeddd~dXddZLeddfdYddZMeddfdZddZNedddd[ddZOeddfd\ddZPeddfdZddZQedddd]ddZRe ddddddddddd^ddZSeddfd_ddZTeddfdZddZU dddfd`ddZVddddddeWjXddd daddZYddddbddZZddddddddddddœ dcdÐdĄZ[ddddddŐdƄZ\ddddbdǐdȄZ]ddddbdɐdʄZ^ddddbdːd̄Z_dded͐d΄Z`eddddddϜdfdԐdՄZaddfdgdؐdلZbddddddڜdhdܐd݄ZcdddddddޜdiddZdddddjddZedddddkddZfdddddlddZgddddmddZhedddkdnddZiedddkdnddZjedddkdnddZk  dodpddZledddkdqddZmedddkdqddZnedddkdqddZoe  dodrddZpedddkdqddZq     dsdtd d Zrdud dZsdS(vHfApiNrr|tokenUnion[str, bool, None]rlibrary_version user_agentUnion[Dict, str, None]headersOptional[Dict[str, str]]r}rcCs:|dur|nt|_||_||_||_||_||_d|_dS)aCreate a HF client to interact with the Hub via HTTP. The client is initialized with some high-level settings used in all requests made to the Hub (HF endpoint, authentication, user agents...). Using the `HfApi` client is preferred but not mandatory as all of its public methods are exposed directly at the root of `huggingface_hub`. Args: token (`str` or `bool`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Pass `token=False` if you don't want to send your token to the server. library_name (`str`, *optional*): The name of the library that is making the HTTP request. Will be added to the user-agent header. Example: `"transformers"`. library_version (`str`, *optional*): The version of the library that is making the HTTP request. Will be added to the user-agent header. Example: `"4.24.0"`. user_agent (`str`, `dict`, *optional*): The user agent info in the form of a dictionary or a single string. It will be completed with information about the installed packages. headers (`dict`, *optional*): Additional headers to be sent with each request. Example: `{"X-My-Header": "value"}`. Headers passed here are taking precedence over the default headers. N)rErrcrrerfrh _thread_pool)rrrcrrerfrhrrrrs! zHfApi.__init__rVCallable[..., R] Future[R]cOs6|jdur tdd|_|j|jj|g|Ri|S)a Run a method in the background and return a Future instance. The main goal is to run methods without blocking the main thread (e.g. to push data during a training). Background jobs are queued to preserve order but are not ran in parallel. If you need to speed-up your scripts by parallelizing lots of call to the API, you must setup and use your own [ThreadPoolExecutor](https://docs.python.org/3/library/concurrent.futures.html#threadpoolexecutor). Note: Most-used methods like [`upload_file`], [`upload_folder`] and [`create_commit`] have a `run_as_future: bool` argument to directly call them in the background. This is equivalent to calling `api.run_as_future(...)` on them but less verbose. Args: fn (`Callable`): The method to run in the background. *args, **kwargs: Arguments with which the method will be called. Return: `Future`: a [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) instance to get the result of the task. Example: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> future = api.run_as_future(api.whoami) # instant >>> future.done() False >>> future.result() # wait until complete and return result (...) >>> future.done() True ``` Nr) max_workers)rjrsubmit)rrVrrrrrrWs # zHfApi.run_as_futurerc Csjtj|jd|j|p|jpddd}z t|W| Sty4}z td|j|jd|d}~ww)z Call HF API to know "whoami". Args: token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. z/api/whoami-v2TrcrhzInvalid user token. If you didn't pass a user token, make sure you are properly logged in by executing `huggingface-cli login`, and if you did pass a user token, double-check it's correct.)requestresponseN) rirr_build_hf_headersrcrjrrqrrjson)rrcrerrrwhoami+s&    z HfApi.whoamiLiteral['read', 'write', None]c Cs4z |j|ddddWSttfyYdSw)a Check if a given `token` is valid and return its permissions. For more details about tokens, please refer to https://huggingface.co/docs/hub/security-tokens#what-are-user-access-tokens. Args: token (`str`, *optional*): The token to check for validity. Defaults to the one saved locally. Returns: `Literal["read", "write", None]`: Permission granted by the token ("read" or "write"). Returns `None` if no token passed or token is invalid. roauthZ accessTokenZroleN)rwr^r)rrcrrrget_token_permissionIs zHfApi.get_token_permissioncC(|jd}t|}t||S)zH List all valid model tags as a nested namespace object z/api/models-tags-by-typerrirrjrtrrrurrrget_model_tags\  zHfApi.get_model_tagscCr{)zK List all valid dataset tags as a nested namespace object. z/api/datasets-tags-by-typer|r}rrrget_dataset_tagserzHfApi.get_dataset_tagsF)filterrlibrarylanguage model_nametasktrained_datasetrsearchemissions_thresholdssort directionlimitfullr fetch_configrcrr,Union[ModelFilter, str, Iterable[str], None]rrOptional[Union[str, List[str]]]rrrrrrrOptional[Tuple[float, float]]r*Union[Literal['last_modified'], str, None]rOptional[Literal[-1]]rrrrrrrOptional[Union[bool, str]]rIterable[ModelInfo]ccs| dur |dur td|jd}|j|d}i}g}|dur:t|tr,||}n|d|i|ddi|rC|d|i|rL|d |i|r[|t|trX|gn||rj|t|trg|gn||rt|t t fsv|g}|D]}| d sd |}| |qx|r|t|tr|gn||r|t|tr|gn|| r|d | i| dur|d | d krd n| i| dur|d| i| dur|d| i|dur|r|ddind|vr|d=|r|ddi|r|ddi|r |d|i| dg}|r"|t|tr|gnt ||d|it|||d}| dur:t|| }|D]$}d|vrGd|d<tdi|}| dus\t|g| Rr_|Vq>> from huggingface_hub import HfApi >>> api = HfApi() >>> # List all models >>> api.list_models() >>> # List only the text classification models >>> api.list_models(filter="text-classification") >>> # List only models from the AllenNLP library >>> api.list_models(filter="allennlp") ``` Example usage with the `search` argument: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> # List all models with "bert" in their name >>> api.list_models(search="bert") >>> # List all models with "bert" in their name made by google >>> api.list_models(search="bert", author="google") ``` NzC`emissions_thresholds` were passed without setting `cardData=True`.z /api/modelsrorrTrrdataset:rrr rrrrrparamsrhr r)rrrsrrs_unpack_model_filterrextendrzr_tuplerappendrrlr rrt)rrrrrrrrrrrrrrrrrrcrrrhr filter_listrw filter_valuer8r? model_inforrr list_modelsnsw            zHfApi.list_models model_filterrscCs6d}|jr |jd}|jr||j7}g}|jr(|t|jtr$|jgn|j|jrLt|jttfs8|jg|_|jD]}d|vrFd|}| |q;|j r_|t|j tr[|j gn|j |j rr|t|j trn|j gn|j i}|rz||d<t|j tr||j n t|j tr| |j t||d<|S)zU Unpacks a [`ModelFilter`] into something readable for `list_models` rrrrr) rrrrrrzrr_rrrrr)rrZ model_strrrw query_dictrrrr.s<            zHfApi._unpack_model_filter)rr benchmark dataset_namelanguage_creatorsrmultilingualitysize_categoriestask_categoriestask_idsrrrrrrc.Union[DatasetFilter, str, Iterable[str], None]rrrrrrr.Optional[Union[Literal['last_modified'], str]]Iterable[DatasetInfo]ccs|jd}|j|d}i}g}|dur't|tr ||}n|d|i|r0|d|i|r9|d|i|||||| | fD]'}|rit|ttfsP|g}|D]}||dsc|d|}| |qRqB| rs|d| i| dur|d| d krd n| i| dur|d | i|dur|d |i|r|d di| dg}|r| t|t r|gnt||d|it |||d}|durt||}|D]}d|vrd|d<tdi|VqdS)a2 List datasets hosted on the Huggingface Hub, given some filters. Args: filter ([`DatasetFilter`] or `str` or `Iterable`, *optional*): A string or [`DatasetFilter`] which can be used to identify datasets on the hub. author (`str`, *optional*): A string which identify the author of the returned datasets. benchmark (`str` or `List`, *optional*): A string or list of strings that can be used to identify datasets on the Hub by their official benchmark. dataset_name (`str`, *optional*): A string or list of strings that can be used to identify datasets on the Hub by its name, such as `SQAC` or `wikineural` language_creators (`str` or `List`, *optional*): A string or list of strings that can be used to identify datasets on the Hub with how the data was curated, such as `crowdsourced` or `machine_generated`. language (`str` or `List`, *optional*): A string or list of strings representing a two-character language to filter datasets by on the Hub. multilinguality (`str` or `List`, *optional*): A string or list of strings representing a filter for datasets that contain multiple languages. size_categories (`str` or `List`, *optional*): A string or list of strings that can be used to identify datasets on the Hub by the size of the dataset such as `100K>> from huggingface_hub import HfApi >>> api = HfApi() >>> # List all datasets >>> api.list_datasets() >>> # List only the text classification datasets >>> api.list_datasets(filter="task_categories:text-classification") >>> # List only the datasets in russian for language modeling >>> api.list_datasets( ... filter=("language:ru", "task_ids:language-modeling") ... ) >>> api.list_datasets(filter=filt) ``` Example usage with the `search` argument: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> # List all datasets with "text" in their name >>> api.list_datasets(search="text") >>> # List all datasets with "text" in their name made by google >>> api.list_datasets(search="text", author="google") ``` z /api/datasetsroNrrr:rrr rrrTrr r)rrsrrr_unpack_dataset_filterrr_rrrrrrzrlr r)rrrrrrrrrrrrrrrrrcrrhrrattrdatarr8r?rrr list_datasets_sf w       zHfApi.list_datasetsdataset_filterrrc Csd}|jr |jd}|jr||j7}g}gd}|D]-}t||}|durHt|ttfs0|g}|D]}|d|vrB|d|}||q2qi}|durS||d<t||d<|S)zY Unpacks a [`DatasetFilter`] into something readable for `list_datasets` rr)rrrrrrrNrrr)rrgetattrrr_rr) rrZ dataset_strrZdata_attributesrZ curr_attrrrrrrrs,     zHfApi._unpack_dataset_filterList[MetricInfo]cCs6|jd}t|}t||}dd|DS)z Get the public list of all the metrics on huggingface.co Returns: `List[MetricInfo]`: a list of [`MetricInfo`] objects which. z /api/metricscSr<r=)r')rxrrrrDr@z&HfApi.list_metrics..r|)rrrudrrr list_metrics9s  zHfApi.list_metrics) rrrrrrr&r%linkedrrcUnion[str, Iterable[str], None]r&r%rIterable[SpaceInfo]c csL|jd} |j| d} i}|dur|d|i|dur%|d|i|dur0|d|i|durA|d|dkr=d n|i|durL|d |i|durW|d |i| r`|d d i| ri|dd i|durt|d|i|dur|d|it| || d}|durt||}|D]}d|vrd|d<tdi|VqdS)a List spaces hosted on the Huggingface Hub, given some filters. Args: filter (`str` or `Iterable`, *optional*): A string tag or list of tags that can be used to identify Spaces on the Hub. author (`str`, *optional*): A string which identify the author of the returned Spaces. search (`str`, *optional*): A string that will be contained in the returned Spaces. sort (`Literal["last_modified"]` or `str`, *optional*): The key with which to sort the resulting Spaces. Possible values are the properties of the [`huggingface_hub.hf_api.SpaceInfo`]` class. direction (`Literal[-1]` or `int`, *optional*): Direction in which to sort. The value `-1` sorts by descending order while all other values sort by ascending order. limit (`int`, *optional*): The limit on the number of Spaces fetched. Leaving this option to `None` fetches all Spaces. datasets (`str` or `Iterable`, *optional*): Whether to return Spaces that make use of a dataset. The name of a specific dataset can be passed as a string. models (`str` or `Iterable`, *optional*): Whether to return Spaces that make use of a model. The name of a specific model can be passed as a string. linked (`bool`, *optional*): Whether to return Spaces that make use of either a model or a dataset. full (`bool`, *optional*): Whether to fetch all Spaces data, including the `last_modified`, `siblings` and `card_data` fields. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `Iterable[SpaceInfo]`: an iterable of [`huggingface_hub.hf_api.SpaceInfo`] objects. z /api/spacesroNrrrrrr rrrTrr&r%rr r)rrsrrlr r )rrrrrrrr&r%rrrcrrhrr8r?rrr list_spacesFs@ 7  zHfApi.list_spaces)rcrrrzrcCD|durt}tj|jd|d|d|j|dd}t|dS)a$ Like a given repo on the Hub (e.g. set as favorite). See also [`unlike`] and [`list_liked_repos`]. Args: repo_id (`str`): The repository to like. Example: `"user/my-cool-model"`. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if liking a dataset or space, `None` or `"model"` if liking a model. Default is `None`. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. Example: ```python >>> from huggingface_hub import like, list_liked_repos, unlike >>> like("gpt2") >>> "gpt2" in list_liked_repos().models True >>> unlike("gpt2") >>> "gpt2" in list_liked_repos().models False ``` N/api/s//likerorrh)rHripostrrsrjrrrcrrrrrrlikes(  z HfApi.likecCr)a4 Unlike a given repo on the Hub (e.g. remove from favorite list). See also [`like`] and [`list_liked_repos`]. Args: repo_id (`str`): The repository to unlike. Example: `"user/my-cool-model"`. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if unliking a dataset or space, `None` or `"model"` if unliking a model. Default is `None`. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. Example: ```python >>> from huggingface_hub import like, list_liked_repos, unlike >>> like("gpt2") >>> "gpt2" in list_liked_repos().models True >>> unlike("gpt2") >>> "gpt2" in list_liked_repos().models False ``` Nrrrror)rHrideleterrsrjrrrrunlikes (  z HfApi.unlikerorSrRcCs|dur|j|d}|ddkr|d}ntd|jd|d}|j|d}tt|i|d }t|t|d d |Dd d |Dd d |DdS)a List all public repos liked by a user on huggingface.co. This list is public so token is optional. If `user` is not passed, it defaults to the logged in user. See also [`like`] and [`unlike`]. Args: user (`str`, *optional*): Name of the user for which you want to fetch the likes. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Used only if `user` is not passed to implicitly determine the current user name. Returns: [`UserLikes`]: object containing the user name and 3 lists of repo ids (1 for models, 1 for datasets and 1 for Spaces). Raises: [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If `user` is not passed and no token found (either from argument or from machine). Example: ```python >>> from huggingface_hub import list_liked_repos >>> likes = list_liked_repos("julien-c") >>> likes.user "julien-c" >>> likes.models ["osanseviero/streamlit_1.15", "Xhaheen/ChatGPT_HF", ...] ``` Nror2rSrDzVCannot list liked repos. You must provide a 'user' as input or be logged in as a user.z /api/users/z/likesrcS(g|]}|dddkr|ddqS)repor2rvrDrrrrrrrB(z*HfApi.list_liked_repos..cSr)rr2rwrDrrrrrrCrcSr)rr2rxrDrrrrrrDr)rSrr%r&r )rwrrrsr_rlrRr)rrSrcmerrhrrrrlist_liked_reposs"-        zHfApi.list_liked_reposrrc List[User]cCs^|durt}|jd|d|d}|j|d}tj||d}t||}dd|DS) a List all users who liked a given repo on the hugging Face Hub. See also [`like`] and [`list_liked_repos`]. Args: repo_id (`str`): The repository to retrieve . Example: `"user/my-cool-model"`. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. Returns: `List[User]`: a list of [`User`] objects. Nrrz/likersrorpcSs&g|]}t|d|d|ddqS)rSrZ avatarUrl)rrrU)rT)r user_datarrrrpsz*HfApi.list_repo_likers..)rHrrsrirrjrt)rrrrcrrhrrZ likers_datarrrlist_repo_likersGs zHfApi.list_repo_likers)revisiontimeoutsecurityStatusfiles_metadatarcrrOptional[float]rrrc Cs|j|d}|dur|jd|n|jd|dt|dd}i} |r)d| d<|r/d| d <tj|||| d } t| | } td i| S) a  Get info on one specific model on huggingface.co Model can be private if you pass an acceptable token or are logged in. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. revision (`str`, *optional*): The revision of the model repository from which to get the information. timeout (`float`, *optional*): Whether to set a timeout for the request to the Hub. securityStatus (`bool`, *optional*): Whether to retrieve the security status from the model repository as well. files_metadata (`bool`, *optional*): Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults to `False`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: [`huggingface_hub.hf_api.ModelInfo`]: The model repository information. Raises the following errors: - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. roN /api/models/ /revision/rrTrblobsrhrrr)rsrrrirrjrtr) rrrrrrrcrhrrrurrrrrys 4zHfApi.model_info)rrrrcrc C|j|d}|dur|jd|n|jd|dt|dd}i}|r)d|d<tj||||d } t| | } td i| S) a[ Get info on one specific dataset on huggingface.co. Dataset can be private if you pass an acceptable token. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. revision (`str`, *optional*): The revision of the dataset repository from which to get the information. timeout (`float`, *optional*): Whether to set a timeout for the request to the Hub. files_metadata (`bool`, *optional*): Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults to `False`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: [`hf_api.DatasetInfo`]: The dataset repository information. Raises the following errors: - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. roNz/api/datasets/rrrTrrr)rsrrrirrjrtr rrrrrrcrhrrrurrrr dataset_info 0zHfApi.dataset_infor c Cr) aR Get info on one specific Space on huggingface.co. Space can be private if you pass an acceptable token. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. revision (`str`, *optional*): The revision of the space repository from which to get the information. timeout (`float`, *optional*): Whether to set a timeout for the request to the Hub. files_metadata (`bool`, *optional*): Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults to `False`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: [`~hf_api.SpaceInfo`]: The space repository information. Raises the following errors: - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. roN /api/spaces/rrrTrrr)rsrrrirrjrtr rrrr space_inforzHfApi.space_info)rrrrrc(Union[ModelInfo, DatasetInfo, SpaceInfo]cCsR|dus|dkr |j}n|dkr|j}n |dkr|j}ntd||||||dS)a Get the info object for a given repo of a given type. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. revision (`str`, *optional*): The revision of the repository from which to get the information. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if getting repository info from a dataset or a space, `None` or `"model"` if getting repository info from a model. Default is `None`. timeout (`float`, *optional*): Whether to set a timeout for the request to the Hub. files_metadata (`bool`, *optional*): Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults to `False`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `Union[SpaceInfo, DatasetInfo, ModelInfo]`: The repository information, as a [`huggingface_hub.hf_api.DatasetInfo`], [`huggingface_hub.hf_api.ModelInfo`] or [`huggingface_hub.hf_api.SpaceInfo`] object. Raises the following errors: - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. NrvrwrxzUnsupported repo type.)rrcrr)rrrr)rrrrrrrcmethodrrr repo_info; s4zHfApi.repo_infocCs>z |j|||dWdStyYdStyYdSw)a Checks if a repository exists on the Hugging Face Hub. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if getting repository info from a dataset or a space, `None` or `"model"` if getting repository info from a model. Default is `None`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: True if the repository exists, False otherwise. Examples: ```py >>> from huggingface_hub import repo_exists >>> repo_exists("google/gemma-7b") True >>> repo_exists("google/not-a-repo") False ``` rrrcTF)rr[r`rrrrcrrr repo_exists s$  zHfApi.repo_existscCs@z |j||||dWdStyYdStyYdSw)a3 Checks if a specific revision exists on a repo on the Hugging Face Hub. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. revision (`str`): The revision of the repository to check. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if getting repository info from a dataset or a space, `None` or `"model"` if getting repository info from a model. Default is `None`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: True if the repository and the revision exists, False otherwise. Examples: ```py >>> from huggingface_hub import revision_exists >>> revision_exists("google/gemma-7b", "float16") True >>> revision_exists("google/gemma-7b", "not-a-revision") False ``` rrrrcTF)rrar`rrrrrcrrrrevision_exists s'  zHfApi.revision_exists)rrrcfilenamec Cs^t|||||jd}z|dur|j}t||dWdSty"tttfy.YdSw)a Checks if a file exists in a repository on the Hugging Face Hub. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. filename (`str`): The name of the file to check, for example: `"config.json"` repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if getting repository info from a dataset or a space, `None` or `"model"` if getting repository info from a model. Default is `None`. revision (`str`, *optional*): The revision of the repository from which to get the information. Defaults to `"main"` branch. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: True if the file exists, False otherwise. Examples: ```py >>> from huggingface_hub import file_exists >>> file_exists("bigcode/starcoder", "config.json") True >>> file_exists("bigcode/starcoder", "not-a-file") False >>> file_exists("bigcode/not-a-repo", "config.json") False ``` )rrrrrNroTF)rTrrcrSr[r`rZra)rrrrrrcrrrr file_exists s-   zHfApi.file_existsz0.23z2Use `list_repo_tree` and `get_paths_info` instead.)versionrO)expandrrrcpathsUnion[List[str], str, None]rIterable[RepoFile]c csT|pt}|durt|ddnt}|j|d}g}|dur#|dnI|gkr)dStj|jd|d|d|t|t r@|n|g|d|d } t | | } | D]} | d d krdt di| VqS|| d qS|D]9} | rzd t| ddnd} |jd|d|d|| }t ||d|ddD]}|d d krt di|VqqndS)a List files on a repo and get information about them. Takes as input a list of paths. Those paths can be either files or folders. Two server endpoints are called: 1. POST "/paths-info" to get information about the provided paths. Called once. 2. GET "/tree?recursive=True" to paginate over the input folders. Called only if a folder path is provided as input. Will be called multiple times to follow pagination. If no path is provided as input, step 1. is ignored and all files from the repo are listed. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. paths (`Union[List[str], str, None]`, *optional*): The paths to get information about. Paths to files are directly resolved. Paths to folders are resolved recursively which means that information is returned about all files in the folder and its subfolders. If `None`, all files are returned (the default). If a path do not exist, it is ignored without raising an exception. expand (`bool`, *optional*, defaults to `False`): Whether to fetch more information about the files (e.g. last commit and security scan results). This operation is more expensive for the server so only 50 results are returned per page (instead of 1000). As pagination is implemented in `huggingface_hub`, this is transparent for you except for the time it takes to get the results. revision (`str`, *optional*): The revision of the repository from which to get the information. Defaults to `"main"` branch. repo_type (`str`, *optional*): The type of the repository from which to get the information (`"model"`, `"dataset"` or `"space"`. Defaults to `"model"`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `Iterable[RepoFile]`: The information about the files, as an iterable of [`RepoFile`] objects. The order of the files is not guaranteed. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If revision is not found (error 404) on the repo. Examples: Get information about files on a repo. ```py >>> from huggingface_hub import list_files_info >>> files_info = list_files_info("lysandre/arxiv-nlp", ["README.md", "config.json"]) >>> files_info >>> list(files_info) [ RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None), RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None) ] ``` Get even more information about files on a repo (last commit and security scan results) ```py >>> from huggingface_hub import list_files_info >>> files_info = list_files_info("prompthero/openjourney-v4", expand=True) >>> list(files_info) [ RepoFile( path='safety_checker/pytorch_model.bin', size=1216064769, blob_id='c8835557a0d3af583cb06c7c154b7e54a069c41d', lfs={ 'size': 1216064769, 'sha256': '16d28f2b37109f222cdc33620fdd262102ac32112be0352a7f77e9614b35a394', 'pointer_size': 135 }, last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 10, 5, 27, tzinfo=datetime.timezone.utc) }, security={ 'safe': True, 'av_scan': { 'virusFound': False, 'virusNames': None }, 'pickle_import_scan': { 'highestSafetyLevel': 'innocuous', 'imports': [ {'module': 'torch', 'name': 'FloatStorage', 'safety': 'innocuous'}, {'module': 'collections', 'name': 'OrderedDict', 'safety': 'innocuous'}, {'module': 'torch', 'name': 'LongStorage', 'safety': 'innocuous'}, {'module': 'torch._utils', 'name': '_rebuild_tensor_v2', 'safety': 'innocuous'} ] } } ), RepoFile( path='scheduler/scheduler_config.json', size=465, blob_id='70d55e3e9679f41cbc66222831b38d5abce683dd', lfs=None, last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 10, 5, 27, tzinfo=datetime.timezone.utc)}, security={ 'safe': True, 'av_scan': { 'virusFound': False, 'virusNames': None }, 'pickle_import_scan': None } ), ... ] ``` List LFS files from the "vae/" folder in "stabilityai/stable-diffusion-2" repository. ```py >>> from huggingface_hub import list_files_info >>> [info.path for info in list_files_info("stabilityai/stable-diffusion-2", "vae") if info.lfs is not None] ['vae/diffusion_pytorch_model.bin', 'vae/diffusion_pytorch_model.safetensors'] ``` List all files on a repo. ```py >>> from huggingface_hub import list_files_info >>> [info.path for info in list_files_info("glue", repo_type="dataset")] ['.gitattributes', 'README.md', 'dataset_infos.json', 'glue.py'] ``` Nrrrorr /paths-info/rrrrhr2filerr/tree/T recursiverrrhrr)rHrrBrsrrirrrr_rjrtrrl)rrrrrrrcrhZ folder_pathsrr paths_info path_inforZ encoded_pathtree_urlZ subpath_inforrrlist_files_info s@     zHfApi.list_files_info)rrrcrcCsdd|j|d|||dDS)a Get the list of files in a given repo. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. revision (`str`, *optional*): The revision of the model repository from which to get the information. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `List[str]`: the list of files in a given repository. cSsg|] }t|tr|jqSr)rrr)rfrrrr s z)HfApi.list_repo_files..T)rrrrrc)list_repo_treerrrrlist_repo_files s  zHfApi.list_repo_files)rrrrrc path_in_repor%Iterable[Union[RepoFile, RepoFolder]]c cs|pt}|durt|ddnt}|j|d}|r!dt|ddnd} |jd|d|d|| } t| |||d d D]} | d d krLtd i| ntd i| Vq=dS)a List a repo tree's files and folders and get information about them. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. path_in_repo (`str`, *optional*): Relative path of the tree (folder) in the repo, for example: `"checkpoints/1fec34a/results"`. Will default to the root tree (folder) of the repository. recursive (`bool`, *optional*, defaults to `False`): Whether to list tree's files and folders recursively. expand (`bool`, *optional*, defaults to `False`): Whether to fetch more information about the tree's files and folders (e.g. last commit and files' security scan results). This operation is more expensive for the server so only 50 results are returned per page (instead of 1000). As pagination is implemented in `huggingface_hub`, this is transparent for you except for the time it takes to get the results. revision (`str`, *optional*): The revision of the repository from which to get the tree. Defaults to `"main"` branch. repo_type (`str`, *optional*): The type of the repository from which to get the tree (`"model"`, `"dataset"` or `"space"`. Defaults to `"model"`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `Iterable[Union[RepoFile, RepoFolder]]`: The information about the tree's files and folders, as an iterable of [`RepoFile`] and [`RepoFolder`] objects. The order of the files and folders is not guaranteed. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If revision is not found (error 404) on the repo. [`~utils.EntryNotFoundError`]: If the tree (folder) does not exist (error 404) on the repo. Examples: Get information about a repo's tree. ```py >>> from huggingface_hub import list_repo_tree >>> repo_tree = list_repo_tree("lysandre/arxiv-nlp") >>> repo_tree >>> list(repo_tree) [ RepoFile(path='.gitattributes', size=391, blob_id='ae8c63daedbd4206d7d40126955d4e6ab1c80f8f', lfs=None, last_commit=None, security=None), RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None), RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None), RepoFile( path='flax_model.msgpack', size=497764107, blob_id='8095a62ccb4d806da7666fcda07467e2d150218e', lfs={'size': 497764107, 'sha256': 'd88b0d6a6ff9c3f8151f9d3228f57092aaea997f09af009eefd7373a77b5abb9', 'pointer_size': 134}, last_commit=None, security=None ), RepoFile(path='merges.txt', size=456318, blob_id='226b0752cac7789c48f0cb3ec53eda48b7be36cc', lfs=None, last_commit=None, security=None), RepoFile( path='pytorch_model.bin', size=548123560, blob_id='64eaa9c526867e404b68f2c5d66fd78e27026523', lfs={'size': 548123560, 'sha256': '9be78edb5b928eba33aa88f431551348f7466ba9f5ef3daf1d552398722a5436', 'pointer_size': 134}, last_commit=None, security=None ), RepoFile(path='vocab.json', size=898669, blob_id='b00361fece0387ca34b4b8b8539ed830d644dbeb', lfs=None, last_commit=None, security=None)] ] ``` Get even more information about a repo's tree (last commit and files' security scan results) ```py >>> from huggingface_hub import list_repo_tree >>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True) >>> list(repo_tree) [ RepoFolder( path='feature_extractor', tree_id='aa536c4ea18073388b5b0bc791057a7296a00398', last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc) } ), RepoFolder( path='safety_checker', tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440', last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc) } ), RepoFile( path='model_index.json', size=582, blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1', lfs=None, last_commit={ 'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e', 'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)', 'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc) }, security={ 'safe': True, 'av_scan': {'virusFound': False, 'virusNames': None}, 'pickle_import_scan': None } ) ... ] ``` Nrrrorrrrrrr2rr)rHrrBrsrrlrr) rrrrrrrrcrhZencoded_path_in_reporrrrrr sz  ,zHfApi.list_repo_tree)rinclude_pull_requestsrcrrHcs|pt}tj|jd|d|d|j|d|rddinid}t||}dd d tfdd|dDfdd|dDfdd|dD|r\fdd|dDdSddS)a Get the list of refs of a given repo (both tags and branches). Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if listing refs from a dataset or a Space, `None` or `"model"` if listing from a model. Default is `None`. include_pull_requests (`bool`, *optional*): Whether to include refs from pull requests in the list. Defaults to `False`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Example: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.list_repo_refs("gpt2") GitRefs(branches=[GitRefInfo(name='main', ref='refs/heads/main', target_commit='e7da7f221d5bf496a48136c0cd264e630fe9fcc8')], converts=[], tags=[]) >>> api.list_repo_refs("bigcode/the-stack", repo_type='dataset') GitRefs( branches=[ GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'), GitRefInfo(name='v1.1.a1', ref='refs/heads/v1.1.a1', target_commit='f9826b862d1567f3822d3d25649b0d6d22ace714') ], converts=[], tags=[ GitRefInfo(name='v1.0', ref='refs/tags/v1.0', target_commit='c37a8cd1e382064d8aced5e05543c5f7753834da') ] ) ``` Returns: [`GitRefs`]: object containing all information about branches and tags for a repo on the Hub. rrz/refsroZ include_prsrrhrr?rr}rCcSst|d|d|ddS)NrDrEZ targetCommit)rDrErF)rCr?rrr_format_as_git_ref_info sz5HfApi.list_repo_refs.._format_as_git_ref_infocg|]}|qSrrr>rrrr z(HfApi.list_repo_refs..rIcrrrr>rrrr rrJcrrrr>rrrr rrcrrrr>rrrr rZ pullRequestsN)rIrJrrK)r?rr}rC)rHrirrrsrjrtrH)rrrrrcrrrrrrlist_repo_refss s$3  zHfApi.list_repo_refs)rrcr formattedrList[GitCommitInfo]c Csd|pt}|durt|ddnt}ddt|jd|d|d||j|d |r,d d inid DS) a Get the list of commits of a given revision for a repo on the Hub. Commits are sorted by date (last commit first). Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if listing commits from a dataset or a Space, `None` or `"model"` if listing from a model. Default is `None`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. formatted (`bool`): Whether to return the HTML-formatted title and description of the commits. Defaults to False. Example: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() # Commits are sorted by date (last commit first) >>> initial_commit = api.list_repo_commits("gpt2")[-1] # Initial commit is always a system commit containing the `.gitattributes` file. >>> initial_commit GitCommitInfo( commit_id='9b865efde13a30c13e0a33e536cf3e4a5a9d71d8', authors=['system'], created_at=datetime.datetime(2019, 2, 18, 10, 36, 15, tzinfo=datetime.timezone.utc), title='initial commit', message='', formatted_title=None, formatted_message=None ) # Create an empty branch by deriving from initial commit >>> api.create_branch("gpt2", "new_empty_branch", revision=initial_commit.commit_id) ``` Returns: List[[`GitCommitInfo`]]: list of objects containing information about the commits for a repo on the Hub. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If revision is not found (error 404) on the repo. Nrrc Ss`g|],}t|ddd|dDt|d|d|d|did|diddqS) rcSsg|]}|dqS)rSr)rrrrrr rz6HfApi.list_repo_commits...rNrrrOr)rMrNrrrOrPrQ)rLrmrr>rrrr s  z+HfApi.list_repo_commits..rrz /commits/rozexpand[]rr)rHrrBrlrrs)rrrrcrrrrrlist_repo_commits sA  zHfApi.list_repo_commitsUnion[List[str], str]!List[Union[RepoFile, RepoFolder]]c Cs|pt}|durt|ddnt}|j|d}tj|jd|d|d|t|tr-|n|g|d|d }t || } d d | DS) a Get information about a repo's paths. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. paths (`Union[List[str], str]`, *optional*): The paths to get information about. If a path do not exist, it is ignored without raising an exception. expand (`bool`, *optional*, defaults to `False`): Whether to fetch more information about the paths (e.g. last commit and files' security scan results). This operation is more expensive for the server so only 50 results are returned per page (instead of 1000). As pagination is implemented in `huggingface_hub`, this is transparent for you except for the time it takes to get the results. revision (`str`, *optional*): The revision of the repository from which to get the information. Defaults to `"main"` branch. repo_type (`str`, *optional*): The type of the repository from which to get the information (`"model"`, `"dataset"` or `"space"`. Defaults to `"model"`. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `List[Union[RepoFile, RepoFolder]]`: The information about the paths, as a list of [`RepoFile`] and [`RepoFolder`] objects. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If revision is not found (error 404) on the repo. Example: ```py >>> from huggingface_hub import get_paths_info >>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset") >>> paths_info [ RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None), RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None) ] ``` NrrrorrrrrcSs4g|]}|ddkrtdi|ntdi|qS)r2rr)rr)rrrrrrX s&z(HfApi.get_paths_info..) rHrrBrsrirrrr_rjrt) rrrrrrrcrhrrrrrrget_paths_info s9 zHfApi.get_paths_info)branchrrrcrrc Cs|durt}|tvrtd|durt}|jd|d|d|}|j|d}|p/d|d}tj||d |id }t|dS) a Squash commit history on a branch for a repo on the Hub. Squashing the repo history is useful when you know you'll make hundreds of commits and you don't want to clutter the history. Squashing commits can only be performed from the head of a branch. Once squashed, the commit history cannot be retrieved. This is a non-revertible operation. Once the history of a branch has been squashed, it is not possible to merge it back into another branch since their history will have diverged. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. branch (`str`, *optional*): The branch to squash. Defaults to the head of the `"main"` branch. commit_message (`str`, *optional*): The commit message to use for the squashed commit. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if listing commits from a dataset or a Space, `None` or `"model"` if listing from a model. Default is `None`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If the machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token can be automatically retrieved from the cache. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If the branch to squash cannot be found. [`~utils.BadRequestError`]: If invalid reference for a branch. You cannot squash history on tags. Example: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() # Create repo >>> repo_id = api.create_repo("test-squash").repo_id # Make a lot of commits. >>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content") >>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content") >>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content") # Squash history >>> api.super_squash_history(repo_id=repo_id) ``` NInvalid repo typerrz/super-squash/rozSuper-squash branch 'z' using huggingface_hubrOrrhrt) rHrIrrBrrsrirrj) rrrrrrcrrhrrrrrsuper_squash_history] sE  zHfApi.super_squash_history) rcrrexist_ok space_sdkspace_hardware space_storagespace_sleep_time space_secretsspace_variablesrrrrOptional[SpaceHardware]rOptional[SpaceStorage]rrOptional[List[Dict[str, str]]]rrc  Cspd|vr |dnd|f\} } |jd}|tvrtd| | |d}|dur+||d<|dkrK|dur;tdtd |tvrGtd td ||d <|durX|dkrXtd gd}gd}||| | | g}|dkry|ddt||Dnddt||D}|rtdd |dt |ddr|j |d<|j |d} t j|||d}|jdkrd|jvrtdq zt|Wngty*}zZ|r|jjdkrnK|r|jjdkrz6|j|||d |dus|tkrt|jd|WWYd}~St|jd|d|WWYd}~StywWYd}~nd}~ww|}t|d!|jd"S)#ab Create an empty repo on the HuggingFace Hub. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) private (`bool`, *optional*, defaults to `False`): Whether the model repo should be private. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. exist_ok (`bool`, *optional*, defaults to `False`): If `True`, do not raise an error if repo already exists. space_sdk (`str`, *optional*): Choice of SDK to use if repo_type is "space". Can be "streamlit", "gradio", "docker", or "static". space_hardware (`SpaceHardware` or `str`, *optional*): Choice of Hardware if repo_type is "space". See [`SpaceHardware`] for a complete list. space_storage (`SpaceStorage` or `str`, *optional*): Choice of persistent storage tier. Example: `"small"`. See [`SpaceStorage`] for a complete list. space_sleep_time (`int`, *optional*): Number of seconds of inactivity to wait before a Space is put to sleep. Set to `-1` if you don't want your Space to sleep (default behavior for upgraded hardware). For free hardware, you can't configure the sleep time (value is fixed to 48 hours of inactivity). See https://huggingface.co/docs/hub/spaces-gpus#sleep-time for more details. space_secrets (`List[Dict[str, str]]`, *optional*): A list of secret keys to set in your Space. Each item is in the form `{"key": ..., "value": ..., "description": ...}` where description is optional. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets. space_variables (`List[Dict[str, str]]`, *optional*): A list of public environment variables to set in your Space. Each item is in the form `{"key": ..., "value": ..., "description": ...}` where description is optional. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables. Returns: [`RepoUrl`]: URL to the newly created repo. Value is a subclass of `str` containing attributes like `endpoint`, `repo_type` and `repo_id`. rNz/api/repos/creater)rD organizationrr2rxzDNo space_sdk provided. `create_repo` expects space_sdk to be one of z when repo_type is 'space'`z(Invalid space_sdk. Please choose one of .r#z=Ignoring provided space_sdk because repo_type is not 'space'.)rrrrr)hardware storageTiersleepTimeSecondssecrets variablescSi|] \}}|dur||qSrrrkvrrr z%HfApi.create_repo..cSsg|] \}}|dur|qSrrrkeyrZrrrr z%HfApi.create_repo..zIgnoring provided , z" because repo_type is not 'space'._lfsmultipartthreshZlfsmultipartthreshroTrhrtz@Cannot create repo: another conflicting operation is in progressz:Create repo failed due to a concurrency issue. Retrying...irrr)rrrIrrOwarningswarnrrXjoinrr-rsrir status_coder4loggerdebugrjrrrrrHrr]rt)rrrcrrrrrrrrrrrDrrtZ function_argsZ json_keysvaluesZprovided_space_argsrhruerrrrrr create_repo sp6        "( zHfApi.create_repo)rcr missing_okr:c Csd|vr |dnd|f\}}|jd}|tvrtd||d}|dur*||d<|j|d} tj|| |d} zt| WdStyM|sJYdSw) a] Delete a repo from the HuggingFace Hub. CAUTION: this is irreversible. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. missing_ok (`bool`, *optional*, defaults to `False`): If `True`, do not raise an error if repo does not exist. Raises: - [`~utils.RepositoryNotFoundError`] If the repository to delete from cannot be found and `missing_ok` is set to False (default). rNz/api/repos/deleter)rDrr2ror.) rrrIrrsrirrjr`) rrrcrr:rrDrrtrhrurrr delete_repo9 s     zHfApi.delete_repoz0.24.0)rrDzUse `repo_id` instead.)rZdeprecated_argsZcustom_message)rcrrrDrrDDict[str, bool]c Cs|tvrtdd|vr|dnd|f\}}|dur#||d}n|}|dur+t}tj|jd|d|d|d|j|dd |id }t || S) aUpdate the visibility setting of a repository. Args: repo_id (`str`, *optional*): A namespace (user or an organization) and a repo name separated by a `/`. private (`bool`, *optional*, defaults to `False`): Whether the model repo should be private. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. Returns: The HTTP response in json. Raises the following errors: - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. rrNrDrrz /settingsrorr) rIrrrwrHriputrrsrjrt) rrrrcrrrDrrurrrupdate_repo_visibilityh s* zHfApi.update_repo_visibilityfrom_idto_idc Cst|ddkrtd|dt|ddkr"td|d|dur(t}|||d}|jd}|j|d}tj|||d }zt|WdSt y\} z| d d} ~ ww) a Moving a repository from namespace1/repo_name1 to namespace2/repo_name2 Note there are certain limitations. For more information about moving repositories, please see https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo. Args: from_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. Original repository identifier. to_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. Final repository identifier. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Raises the following errors: - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. rrzInvalid repo_id: z6. It should have a namespace (:namespace:/:repo_name:)N)ZfromRepoZtoRepor2z/api/repos/moveror.zv For additional documentation please see https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo.) rrrrHrrsrirrjr]append_to_message) rr?r@rrcrtrrhrurvrrr move_repo s&'   zHfApi.move_repo.)rrcrr create_pr num_threads parent_commitrW operationsIterable[CommitOperation]rrDrErrFrWLiteral[False]rc CdSrr rrrGrrrcrrrDrErFrWrrr create_commit zHfApi.create_commit Literal[True]Future[CommitInfo]c CrJrrrKrrrrL rM%Union[CommitInfo, Future[CommitInfo]]c ! s| durt| stdt|dust|dkrtd|dur$|nd}|dur,|nt}|tvr9tdt|p The input list of `CommitOperation` will be mutated during the commit process. Do not reuse the same objects for multiple commits. `create_commit` assumes that the repo already exists on the Hub. If you get a Client error 404, please make sure you are authenticated and that `repo_id` and `repo_type` are set correctly. If repo does not exist, create it first using [`~hf_api.create_repo`]. `create_commit` is limited to 25k LFS files and a 1GB payload for regular files. Args: repo_id (`str`): The repository in which the commit will be created, for example: `"username/custom_transformers"` operations (`Iterable` of [`~hf_api.CommitOperation`]): An iterable of operations to include in the commit, either: - [`~hf_api.CommitOperationAdd`] to upload a file - [`~hf_api.CommitOperationDelete`] to delete a file - [`~hf_api.CommitOperationCopy`] to copy a file Operation objects will be mutated to include information relative to the upload. Do not reuse the same objects for multiple commits. commit_message (`str`): The summary (first line) of the commit that will be created. commit_description (`str`, *optional*): The description of the commit that will be created token (`str`, *optional*): Authentication token, obtained with `HfApi.login` method. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. create_pr (`boolean`, *optional*): Whether or not to create a Pull Request with that commit. Defaults to `False`. If `revision` is not set, PR is opened against the `"main"` branch. If `revision` is set and is a branch, PR is opened against this branch. If `revision` is set and is not a branch name (example: a commit oid), an `RevisionNotFoundError` is returned by the server. num_threads (`int`, *optional*): Number of concurrent threads for uploading files. Defaults to 5. Setting it to 2 means at most 2 files will be uploaded concurrently. parent_commit (`str`, *optional*): The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified and `create_pr` is `False`, the commit will fail if `revision` does not point to `parent_commit`. If specified and `create_pr` is `True`, the pull request will be created from `parent_commit`. Specifying `parent_commit` ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently. run_as_future (`bool`, *optional*): Whether or not to run this method in the background. Background jobs are run sequentially without blocking the main thread. Passing `run_as_future=True` will return a [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) object. Defaults to `False`. Returns: [`CommitInfo`] or `Future`: Instance of [`CommitInfo`] containing information about the newly created commit (commit hash, commit url, pr url, commit message,...). If `run_as_future=True` is passed, returns a Future object which will contain the result when executed. Raises: [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If commit message is empty. [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If parent commit is not a valid commit OID. [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If a README.md file with an invalid metadata section is committed. In this case, the commit will fail early, before trying to upload any file. [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) If `create_pr` is `True` and revision is neither `None` nor `"main"`. [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. NzN`parent_commit` is not a valid commit OID. It must match the following regex: rz5`commit_message` can't be empty, please pass a value.r"Invalid repo type, must be one of rFrocSg|] }t|tr|qSr)rrroprrrrr@z'HfApi.create_commit..cSrRr)rr rSrrrrr@zCommitOperationAdd z has already being committed and cannot be reused. Please create a new CommitOperationAdd object if you want to create a new commit.zAbout to commit to the hub: z addition(s), z copie(s) and z deletion(s).z README.mdz/api/validate-yaml)contentZrepoTypertrh cSg|] }d|dqSz- rOr)rwarningrrrrr+r1z1Warnings while validating metadata in README.md: errorscSrXrYrZ)rerrorrrrrr+zInvalid metadata in README.md. )r additionsrcrrrDrE free_memory)copiesrrrhrr)rG files_to_copyrrrFrrz/commit/r}Iterable[bytes]c3s&D] }t|VdVqdS)N )rtdumpsencoderZcommit_payloadrr_payload_as_ndjsons z/HfApi.create_commit.._payload_as_ndjsonz Content-Typezapplication/x-ndjsonrD1)rrhrrcommit)Z endpoint_namez#A file with this name doesn't existz{ Make sure to differentiate file and folder paths in delete operations with a trailing '/' or using `is_folder=True/False`.TZ commitUrlZ commitOidZpullRequestUrl)rrrrr)r}rb)&rG fullmatchrrrHrIrBrrsr_Z _is_committedr5r6ras_filerirrEreaddecodertr3rr1r2rjrYr&preupload_lfs_filesr"rr$r`rA$_CREATE_COMMIT_NO_REPO_ERROR_MESSAGErZrzr)!rrrGrrrcrrrDrErFrWZunquoted_revisionrhr^r`Z nb_additionsZ nb_copiesZ nb_deletionsadditionrrrZresponse_contentrOrvr\rarrgrrZ commit_respZ commit_datarrfrrLsv            T)rrcrmerge_prrEverboseaddition_commitsList[List[CommitOperationAdd]]deletion_commits!List[List[CommitOperationDelete]]rrrsc  sttd} | r| d| dt|dt|dtdd||Ddtd d |Dd d |Dd } | d | jd|j |||dD]&} | j rr| j dkrr| j| j vrr|j || j||d}| d|jdnqLt||||| ||d}| d|j|jD] }t|tr|}n qtd|jdt|j}t|t| jkrtd|jdt|dt| jd| jD]}||vrtd|jd|dd|dqd d!|j|||td"Dfd#d |j||||jd"D}t|d$kr| d%t|d&t|t| jkr,td|jd't| jd(t|d)d*d+| jD}d,d+| jD}|D]#}|j |vrQ||j }d-|_q>|j |vr`||j }d-|_q>t|d$kr|t|t| jkr|td|jd.t|t|}t|d$kr| |d/t|d0t|d1t |!t |!D]9}|j"||||j|j| |j#d2d3d-|_|d48}| d5|jd6|d7|j$||||j|jt%||| d8d9q| d:|j&||||j|d;|j'||||jd|rhz|j)||||jt*d?| d@W|jSt+yg}z?|j,dAurBdB|j,vrB|j'||||jt-dCdD| .dEn|j/||||jt0j1|j,dFd?tdG|j,|WYdA}~|jSdA}~ww|jS)Ha&Push changes to the Hub in multiple commits. Commits are pushed to a draft PR branch. If the upload fails or gets interrupted, it can be resumed. Progress is tracked in the PR description. At the end of the process, the PR is set as open and the title is updated to match the initial commit message. If `merge_pr=True` is passed, the PR is merged automatically. All deletion commits are pushed first, followed by the addition commits. The order of the commits is not guaranteed as we might implement parallel commits in the future. Be sure that your are not updating several times the same file. `create_commits_on_pr` is experimental. Its API and behavior is subject to change in the future without prior notice. `create_commits_on_pr` assumes that the repo already exists on the Hub. If you get a Client error 404, please make sure you are authenticated and that `repo_id` and `repo_type` are set correctly. If repo does not exist, create it first using [`~hf_api.create_repo`]. Args: repo_id (`str`): The repository in which the commits will be pushed. Example: `"username/my-cool-model"`. addition_commits (`List` of `List` of [`~hf_api.CommitOperationAdd`]): A list containing lists of [`~hf_api.CommitOperationAdd`]. Each sublist will result in a commit on the PR. deletion_commits A list containing lists of [`~hf_api.CommitOperationDelete`]. Each sublist will result in a commit on the PR. Deletion commits are pushed before addition commits. commit_message (`str`): The summary (first line) of the commit that will be created. Will also be the title of the PR. commit_description (`str`, *optional*): The description of the commit that will be created. The description will be added to the PR. token (`str`, *optional*): Authentication token, obtained with `HfApi.login` method. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. merge_pr (`bool`): If set to `True`, the Pull Request is merged at the end of the process. Defaults to `True`. num_threads (`int`, *optional*): Number of concurrent threads for uploading files. Defaults to 5. verbose (`bool`): If set to `True`, process will run on verbose mode i.e. print information about the ongoing tasks. Defaults to `False`. Returns: `str`: URL to the created PR. Example: ```python >>> from huggingface_hub import HfApi, plan_multi_commits >>> addition_commits, deletion_commits = plan_multi_commits( ... operations=[ ... CommitOperationAdd(...), ... CommitOperationAdd(...), ... CommitOperationDelete(...), ... CommitOperationDelete(...), ... CommitOperationAdd(...), ... ], ... ) >>> HfApi().create_commits_on_pr( ... repo_id="my-cool-model", ... addition_commits=addition_commits, ... deletion_commits=deletion_commits, ... (...) ... verbose=True, ... ) ``` Raises: [`MultiCommitException`]: If an unexpected issue occur in the process: empty commits, unexpected commits in a PR, unexpected PR description, etc. z.create_commits_on_prINFOz Will create z deletion commit(s) and z addition commit(s), totalling css|]}t|VqdSr)r)ropsrrr qz-HfApi.create_commits_on_pr..z atomic operations.cSg|]}t|dqSrGr.rrGrrrrtz.HfApi.create_commits_on_pr..cSr|r}rrrrrrur)rtrvzMulti-commits strategy with ID rrZdraft)rdiscussion_numrrczPR already exists: z'. Will resume process where it stopped.)rrrstrategyrcrzNew PR created: zPR #z must have at least 1 commentzCorrupted multi-commit PR #z: got z steps in description but z in strategy.z: expected step z but didn't find it (have r,).cSsh|]}|jqSrrMrrjrrr sz-HfApi.create_commits_on_pr..)rrrcrcg|] }|jvr|qSrrrZcommits_on_main_branchrrrs  rzFound z existing commits on the PR.z : scheduled z steps but z, commits have already been pushed to the PR.cSi|]}|j|qSrrrsteprrrr'rz.HfApi.create_commits_on_pr..cSrrrrrrrr'rTzj: some addition commits have already been pushed to the PR but deletion commits are not all completed yet.z commits remaining (z deletion commits and z addition commits)F)rrrcrrrErGrDrz step z completed (still z to go).)rrr)rrrcr comment_id new_contentzAll commits have been pushed.)rrrcr new_titleopen)rrrcr new_statuscommentzPR is now open for reviews.)rrrcrrz>PR has been automatically merged (`merge_pr=True` was passed).Nzno associated changesclosed)rrrcrrrz-Couldn't merge the PR: no associated changes.) error_messagez-Couldn't merge Pull Request in multi-commit: )2rk get_loggerrsetLevelinforsumr/rget_repo_discussionsis_pull_requestrrget_discussion_detailsnumrr0eventsrr9r-r2rUZ all_stepsr3r rBZ git_referencertrvr completedr_r7rLrGedit_discussion_commentr1rename_discussionchange_discussion_statusr,merge_pull_requestr+rYZserver_messager*r[comment_discussionr)format)rrrtrvrrrcrrrrErsr5r discussionpreventZ pr_commentZdescription_commitsZstep_idZ pr_commitsZremaining_additionsZremaining_deletionsrjrZ nb_remainingr]rrrcreate_commits_on_prsZh               "        zHfApi.create_commits_on_pr)rcrrrDrEr_gitignore_contentr^Iterable[CommitOperationAdd]r_rc Cs|dur|nt}|tvrtdt|durt|ddnt}|dur%|nd}|j|d} t|}| dur[|D]#} | jdkrZ| } | } Wdn 1sUwYq7dd |D} zt | ||| ||j |pnd| d Wnt y}z|td}~wwd d | D}g}|D]} | jrtd | jd q|| qt|t|krtdt|t|dt|||| |j ||s|ndd|D] } d| _|rd| _qdS)a Pre-upload LFS files to S3 in preparation on a future commit. This method is useful if you are generating the files to upload on-the-fly and you don't want to store them in memory before uploading them all at once. This is a power-user method. You shouldn't need to call it directly to make a normal commit. Use [`create_commit`] directly instead. Commit operations will be mutated during the process. In particular, the attached `path_or_fileobj` will be removed after the upload to save memory (and replaced by an empty `bytes` object). Do not reuse the same objects except to pass them to [`create_commit`]. If you don't want to remove the attached content from the commit operation object, pass `free_memory=False`. Args: repo_id (`str`): The repository in which you will commit the files, for example: `"username/custom_transformers"`. operations (`Iterable` of [`CommitOperationAdd`]): The list of files to upload. Warning: the objects in this list will be mutated to include information relative to the upload. Do not reuse the same objects for multiple commits. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): The type of repository to upload to (e.g. `"model"` -default-, `"dataset"` or `"space"`). revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. create_pr (`boolean`, *optional*): Whether or not you plan to create a Pull Request with that commit. Defaults to `False`. num_threads (`int`, *optional*): Number of concurrent threads for uploading files. Defaults to 5. Setting it to 2 means at most 2 files will be uploaded concurrently. gitignore_content (`str`, *optional*): The content of the `.gitignore` file to know which files should be ignored. The order of priority is to first check if `gitignore_content` is passed, then check if the `.gitignore` file is present in the list of files to commit and finally default to the `.gitignore` file already hosted on the Hub (if any). Example: ```py >>> from huggingface_hub import CommitOperationAdd, preupload_lfs_files, create_commit, create_repo >>> repo_id = create_repo("test_preupload").repo_id # Generate and preupload LFS files one by one >>> operations = [] # List of all `CommitOperationAdd` objects that will be generated >>> for i in range(5): ... content = ... # generate binary content ... addition = CommitOperationAdd(path_in_repo=f"shard_{i}_of_5.bin", path_or_fileobj=content) ... preupload_lfs_files(repo_id, additions=[addition]) # upload + free memory ... operations.append(addition) # Create commit >>> create_commit(repo_id, operations=operations, commit_message="Commit all shards") ``` NrQrrFroz .gitignorecSsg|]}|js|qSr) _is_uploadedrrqrrrrrz-HfApi.preupload_lfs_files..)r^rrrhrrrDrcSsg|] }|jdkr|qS)r)Z _upload_moderrrrrr@zSkipping upload for LFS file 'z' (ignored by gitignore file).zSkipped upload for z) LFS file(s) (ignored by gitignore file).)r^rrrhrrErTrh)rHrIrrrBrsr_rrlrmrnr#rr`rArpZ_should_ignorer5r6rrrr%rpath_or_fileobj)rrr^rcrrrDrEr_rrhrqrZ new_additionsrvZnew_lfs_additionsZnew_lfs_additions_to_uploadrrrro.srR          zHfApi.preupload_lfs_files)rcrrrrrDrFrWr!Union[str, Path, bytes, BinaryIO]c CrJrr rrrrrcrrrrrDrFrWrrr upload_filerMzHfApi.upload_filec CrJrrrrrrrrMc  Cs|tvr tdt|dur|nd|d}t||d} |j||| g||||| | d } | jdur:tt| jdd}|tvrDt||}|durJ|nt}t | j | j | j | j | j|jd |d |d |d S) aT Upload a local file (up to 50 GB) to the given repo. The upload is done through a HTTP post request, and doesn't require git or git-lfs to be installed. Args: path_or_fileobj (`str`, `Path`, `bytes`, or `IO`): Path to a file on the local machine or binary data stream / fileobj / buffer. path_in_repo (`str`): Relative filepath in the repo, for example: `"checkpoints/1fec34a/weights.bin"` repo_id (`str`): The repository to which the file will be uploaded, for example: `"username/custom_transformers"` token (`str`, *optional*): Authentication token, obtained with `HfApi.login` method. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. commit_message (`str`, *optional*): The summary / title / first line of the generated commit commit_description (`str` *optional*) The description of the generated commit create_pr (`boolean`, *optional*): Whether or not to create a Pull Request with that commit. Defaults to `False`. If `revision` is not set, PR is opened against the `"main"` branch. If `revision` is set and is a branch, PR is opened against this branch. If `revision` is set and is not a branch name (example: a commit oid), an `RevisionNotFoundError` is returned by the server. parent_commit (`str`, *optional*): The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified and `create_pr` is `False`, the commit will fail if `revision` does not point to `parent_commit`. If specified and `create_pr` is `True`, the pull request will be created from `parent_commit`. Specifying `parent_commit` ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently. run_as_future (`bool`, *optional*): Whether or not to run this method in the background. Background jobs are run sequentially without blocking the main thread. Passing `run_as_future=True` will return a [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) object. Defaults to `False`. Returns: [`CommitInfo`] or `Future`: Instance of [`CommitInfo`] containing information about the newly created commit (commit hash, commit url, pr url, commit message,...). If `run_as_future=True` is passed, returns a Future object which will contain the result when executed. Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. `upload_file` assumes that the repo already exists on the Hub. If you get a Client error 404, please make sure you are authenticated and that `repo_id` and `repo_type` are set correctly. If repo does not exist, create it first using [`~hf_api.create_repo`]. Example: ```python >>> from huggingface_hub import upload_file >>> with open("./local/filepath", "rb") as fobj: ... upload_file( ... path_or_fileobj=fileobj, ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-dataset", ... repo_type="dataset", ... token="my_token", ... ) "https://huggingface.co/datasets/username/my-dataset/blob/main/remote/file/path.h5" >>> upload_file( ... path_or_fileobj=".\\local\\file\\path", ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-model", ... token="my_token", ... ) "https://huggingface.co/username/my-model/blob/main/remote/file/path.h5" >>> upload_file( ... path_or_fileobj=".\\local\\file\\path", ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-model", ... token="my_token", ... create_pr=True, ... ) "https://huggingface.co/username/my-model/blob/refs%2Fpr%2F1/remote/file/path.h5" ``` rQNzUpload  with huggingface_hubrr) rrrGrrrcrrDrFrrrz/blob/rrrrrr)rIrrrLrrrrKrBrrrrrr)rrrrrcrrrrrDrFrWZ operation commit_inforrrrs@~  )rrrrcrrrDrFallow_patternsignore_patternsdelete_patterns multi_commitsmulti_commits_verboserW folder_pathUnion[str, Path]rOptional[Union[List[str], str]]rrrrcCrJrrrrrrrrrcrrrDrFrrrrrrWrrr upload_folderzHfApi.upload_foldercCrJrrrrrrrcCrJrrrrrrrr Future[str]cCrJrrrrrrrr7Union[CommitInfo, str, Future[CommitInfo], Future[str]]c s|tvr tdt|r|dur|tkrtd|durd}| dur&g} nt| tr.| g} | t7} |j||| r:tn|||| d}t||| | d}t|dkrat dd |Dfd d |D}||}|phd }|rt |d \}}|j |||||||| |d }|S|j |||||||| | d }| r|j durtt|j dd}|tvrt||}|dur|nt}t|j|j|j|j|j |jd|d|d|dS)a! Upload a local folder to the given repo. The upload is done through a HTTP requests, and doesn't require git or git-lfs to be installed. The structure of the folder will be preserved. Files with the same name already present in the repository will be overwritten. Others will be left untouched. Use the `allow_patterns` and `ignore_patterns` arguments to specify which files to upload. These parameters accept either a single pattern or a list of patterns. Patterns are Standard Wildcards (globbing patterns) as documented [here](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). If both `allow_patterns` and `ignore_patterns` are provided, both constraints apply. By default, all files from the folder are uploaded. Use the `delete_patterns` argument to specify remote files you want to delete. Input type is the same as for `allow_patterns` (see above). If `path_in_repo` is also provided, the patterns are matched against paths relative to this folder. For example, `upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*")` will delete any remote file under `./experiment/logs/`. Note that the `.gitattributes` file will not be deleted even if it matches the patterns. Any `.git/` folder present in any subdirectory will be ignored. However, please be aware that the `.gitignore` file is not taken into account. Uses `HfApi.create_commit` under the hood. Args: repo_id (`str`): The repository to which the file will be uploaded, for example: `"username/custom_transformers"` folder_path (`str` or `Path`): Path to the folder to upload on the local file system path_in_repo (`str`, *optional*): Relative path of the directory in the repo, for example: `"checkpoints/1fec34a/results"`. Will default to the root folder of the repository. token (`str`, *optional*): Authentication token, obtained with `HfApi.login` method. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. commit_message (`str`, *optional*): The summary / title / first line of the generated commit. Defaults to: `f"Upload {path_in_repo} with huggingface_hub"` commit_description (`str` *optional*): The description of the generated commit create_pr (`boolean`, *optional*): Whether or not to create a Pull Request with that commit. Defaults to `False`. If `revision` is not set, PR is opened against the `"main"` branch. If `revision` is set and is a branch, PR is opened against this branch. If `revision` is set and is not a branch name (example: a commit oid), an `RevisionNotFoundError` is returned by the server. If both `multi_commits` and `create_pr` are True, the PR created in the multi-commit process is kept opened. parent_commit (`str`, *optional*): The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified and `create_pr` is `False`, the commit will fail if `revision` does not point to `parent_commit`. If specified and `create_pr` is `True`, the pull request will be created from `parent_commit`. Specifying `parent_commit` ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently. allow_patterns (`List[str]` or `str`, *optional*): If provided, only files matching at least one pattern are uploaded. ignore_patterns (`List[str]` or `str`, *optional*): If provided, files matching any of the patterns are not uploaded. delete_patterns (`List[str]` or `str`, *optional*): If provided, remote files matching any of the patterns will be deleted from the repo while committing new files. This is useful if you don't know which files have already been uploaded. Note: to avoid discrepancies the `.gitattributes` file is not deleted even if it matches the pattern. multi_commits (`bool`): If True, changes are pushed to a PR using a multi-commit process. Defaults to `False`. multi_commits_verbose (`bool`): If True and `multi_commits` is used, more information will be displayed to the user. run_as_future (`bool`, *optional*): Whether or not to run this method in the background. Background jobs are run sequentially without blocking the main thread. Passing `run_as_future=True` will return a [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) object. Defaults to `False`. Returns: [`CommitInfo`] or `Future`: Instance of [`CommitInfo`] containing information about the newly created commit (commit hash, commit url, pr url, commit message,...). If `run_as_future=True` is passed, returns a Future object which will contain the result when executed. [`str`] or `Future`: If `multi_commits=True`, returns the url of the PR created to push the changes. If `run_as_future=True` is passed, returns a Future object which will contain the result when executed. Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid `upload_folder` assumes that the repo already exists on the Hub. If you get a Client error 404, please make sure you are authenticated and that `repo_id` and `repo_type` are set correctly. If repo does not exist, create it first using [`~hf_api.create_repo`]. `multi_commits` is experimental. Its API and behavior is subject to change in the future without prior notice. Example: ```python # Upload checkpoints folder except the log files >>> upload_folder( ... folder_path="local/checkpoints", ... path_in_repo="remote/experiment/checkpoints", ... repo_id="username/my-dataset", ... repo_type="datasets", ... token="my_token", ... ignore_patterns="**/logs/*.txt", ... ) # "https://huggingface.co/datasets/username/my-dataset/tree/main/remote/experiment/checkpoints" # Upload checkpoints folder including logs while deleting existing logs from the repo # Useful if you don't know exactly which log files have already being pushed >>> upload_folder( ... folder_path="local/checkpoints", ... path_in_repo="remote/experiment/checkpoints", ... repo_id="username/my-dataset", ... repo_type="datasets", ... token="my_token", ... delete_patterns="**/logs/*.txt", ... ) "https://huggingface.co/datasets/username/my-dataset/tree/main/remote/experiment/checkpoints" # Upload checkpoints folder while creating a PR >>> upload_folder( ... folder_path="local/checkpoints", ... path_in_repo="remote/experiment/checkpoints", ... repo_id="username/my-dataset", ... repo_type="datasets", ... token="my_token", ... create_pr=True, ... ) "https://huggingface.co/datasets/username/my-dataset/tree/refs%2Fpr%2F1/remote/experiment/checkpoints" ``` rQNzGCannot use `multi_commit` to commit changes other than the main branch.r)rrrrcrrrrrcss|]}|jVqdSrrrSrrrrzsz&HfApi.upload_folder..crrr)rZ delete_opZ added_pathsrrrsz'HfApi.upload_folder..z#Upload folder using huggingface_hubr~) rrrtrvrrrcrrrs) rrrGrrrcrrDrFrrrr)rIrrBrrzrX _prepare_upload_folder_deletions _prepare_upload_folder_additionsrsetr3rrLrrrrKrrrrrr)rrrrrrrcrrrDrFrrrrrrWZdelete_operationsZadd_operationsZcommit_operationsrtrvrrrrrrs+       )rcrrrrrDrFc Cs@|dur|nd|d}t|dg} |j|||| ||||| d S)a Deletes a file in the given repo. Args: path_in_repo (`str`): Relative filepath in the repo, for example: `"checkpoints/1fec34a/weights.bin"` repo_id (`str`): The repository from which the file will be deleted, for example: `"username/custom_transformers"` token (`str`, *optional*): Authentication token, obtained with `HfApi.login` method. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if the file is in a dataset or space, `None` or `"model"` if in a model. Default is `None`. revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. commit_message (`str`, *optional*): The summary / title / first line of the generated commit. Defaults to `f"Delete {path_in_repo} with huggingface_hub"`. commit_description (`str` *optional*) The description of the generated commit create_pr (`boolean`, *optional*): Whether or not to create a Pull Request with that commit. Defaults to `False`. If `revision` is not set, PR is opened against the `"main"` branch. If `revision` is set and is a branch, PR is opened against this branch. If `revision` is set and is not a branch name (example: a commit oid), an `RevisionNotFoundError` is returned by the server. parent_commit (`str`, *optional*): The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified and `create_pr` is `False`, the commit will fail if `revision` does not point to `parent_commit`. If specified and `create_pr` is `True`, the pull request will be created from `parent_commit`. Specifying `parent_commit` ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently. Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. - [`~utils.EntryNotFoundError`] If the file to download cannot be found. NzDelete rr rrrcrGrrrrDrF)r!rL) rrrrcrrrrrDrFrGrrr delete_filesG zHfApi.delete_filec Cs:|j|||t|ddg||dur|nd|d||| d S)a Deletes a folder in the given repo. Simple wrapper around [`create_commit`] method. Args: path_in_repo (`str`): Relative folder path in the repo, for example: `"checkpoints/1fec34a"`. repo_id (`str`): The repository from which the folder will be deleted, for example: `"username/custom_transformers"` token (`str`, *optional*): Authentication token, obtained with `HfApi.login` method. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if the folder is in a dataset or space, `None` or `"model"` if in a model. Default is `None`. revision (`str`, *optional*): The git revision to commit from. Defaults to the head of the `"main"` branch. commit_message (`str`, *optional*): The summary / title / first line of the generated commit. Defaults to `f"Delete folder {path_in_repo} with huggingface_hub"`. commit_description (`str` *optional*) The description of the generated commit. create_pr (`boolean`, *optional*): Whether or not to create a Pull Request with that commit. Defaults to `False`. If `revision` is not set, PR is opened against the `"main"` branch. If `revision` is set and is a branch, PR is opened against this branch. If `revision` is set and is not a branch name (example: a commit oid), an `RevisionNotFoundError` is returned by the server. parent_commit (`str`, *optional*): The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified and `create_pr` is `False`, the commit will fail if `revision` does not point to `parent_commit`. If specified and `create_pr` is `True`, the pull request will be created from `parent_commit`. Specifying `parent_commit` ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently. TrZ is_folderNzDelete folder rr)rLr!) rrrrcrrrrrDrFrrr delete_folderBs3 zHfApi.delete_folder)rcproxiesrrUnion[bool, str, None]rrrRc Cs*|dur|j}t|||||j|j|jdS)aFetch metadata of a file versioned on the Hub for a given url. Args: url (`str`): File url, for example returned by [`hf_hub_url`]. token (`str` or `bool`, *optional*): A token to be used for the download. - If `True`, the token is read from the HuggingFace config folder. - If `False` or `None`, no token is provided. - If a string, it's used as the authentication token. proxies (`dict`, *optional*): Dictionary mapping protocol to the URL of the proxy passed to `requests.request`. timeout (`float`, *optional*, defaults to 10): How many seconds to wait for the server to send metadata before giving up. Returns: A [`HfFileMetadata`] object containing metadata such as location, etag, size and commit_hash. N)rrcrrrrerf)rcrSrrerf)rrrcrrrrrrSszHfApi.get_hf_file_metadataauto) subfolderrr cache_dir local_dirlocal_dir_use_symlinksforce_downloadforce_filenamer etag_timeoutresume_downloadrclocal_files_onlylegacy_cache_layoutrrUnion[str, Path, None]rrUnion[bool, Literal['auto']]rrrfloatrOptional[Union[str, bool]]rrcCsddlm}|dur |j}|did|d|d|d|d|d |jd |jd |jd |d |d|d|jd| d| d| d| d| d|d|jd|d|S)uDownload a given file if it's not already present in the local cache. The new cache file layout looks like this: - The cache directory contains one subfolder per repo_id (namespaced by repo type) - inside each repo folder: - refs is a list of the latest known revision => commit_hash pairs - blobs contains the actual file blobs (identified by their git-sha or sha256, depending on whether they're LFS files or not) - snapshots contains one subfolder per commit, each "commit" contains the subset of the files that have been resolved at that particular commit. Each filename is a symlink to the blob at that particular commit. If `local_dir` is provided, the file structure from the repo will be replicated in this location. You can configure how you want to move those files: - If `local_dir_use_symlinks="auto"` (default), files are downloaded and stored in the cache directory as blob files. Small files (<5MB) are duplicated in `local_dir` while a symlink is created for bigger files. The goal is to be able to manually edit and save small files without corrupting the cache while saving disk space for binary files. The 5MB threshold can be configured with the `HF_HUB_LOCAL_DIR_AUTO_SYMLINK_THRESHOLD` environment variable. - If `local_dir_use_symlinks=True`, files are downloaded, stored in the cache directory and symlinked in `local_dir`. This is optimal in term of disk usage but files must not be manually edited. - If `local_dir_use_symlinks=False` and the blob files exist in the cache directory, they are duplicated in the local dir. This means disk usage is not optimized. - Finally, if `local_dir_use_symlinks=False` and the blob files do not exist in the cache directory, then the files are downloaded and directly placed under `local_dir`. This means if you need to download them again later, they will be re-downloaded entirely. ``` [ 96] . └── [ 160] models--julien-c--EsperBERTo-small ├── [ 160] blobs │ ├── [321M] 403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd │ ├── [ 398] 7cb18dc9bafbfcf74629a4b760af1b160957a83e │ └── [1.4K] d7edf6bd2a681fb0175f7735299831ee1b22b812 ├── [ 96] refs │ └── [ 40] main └── [ 128] snapshots ├── [ 128] 2439f60ef33a0d46d85da5001d52aeda5b00ce9f │ ├── [ 52] README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812 │ └── [ 76] pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd └── [ 128] bbc77c8132af1cc5cf678da3f1ddf2de43606d48 ├── [ 52] README.md -> ../../blobs/7cb18dc9bafbfcf74629a4b760af1b160957a83e └── [ 76] pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd ``` Args: repo_id (`str`): A user or an organization name and a repo name separated by a `/`. filename (`str`): The name of the file in the repo. subfolder (`str`, *optional*): An optional value corresponding to a folder inside the model repo. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if downloading from a dataset or space, `None` or `"model"` if downloading from a model. Default is `None`. revision (`str`, *optional*): An optional Git revision id which can be a branch name, a tag, or a commit hash. cache_dir (`str`, `Path`, *optional*): Path to the folder where cached files are stored. local_dir (`str` or `Path`, *optional*): If provided, the downloaded file will be placed under this directory, either as a symlink (default) or a regular file (see description for more details). local_dir_use_symlinks (`"auto"` or `bool`, defaults to `"auto"`): To be used with `local_dir`. If set to "auto", the cache directory will be used and the file will be either duplicated or symlinked to the local directory depending on its size. It set to `True`, a symlink will be created, no matter the file size. If set to `False`, the file will either be duplicated from cache (if already exists) or downloaded from the Hub and not cached. See description for more details. force_download (`bool`, *optional*, defaults to `False`): Whether the file should be downloaded even if it already exists in the local cache. proxies (`dict`, *optional*): Dictionary mapping protocol to the URL of the proxy passed to `requests.request`. etag_timeout (`float`, *optional*, defaults to `10`): When fetching ETag, how many seconds to wait for the server to send data before giving up which is passed to `requests.request`. resume_download (`bool`, *optional*, defaults to `False`): If `True`, resume a previously interrupted download. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. local_files_only (`bool`, *optional*, defaults to `False`): If `True`, avoid downloading the file and return the path to the local cached file if it exists. legacy_cache_layout (`bool`, *optional*, defaults to `False`): If `True`, uses the legacy file cache layout i.e. just call [`hf_hub_url`] then `cached_download`. This is deprecated as the new cache layout is more powerful. Returns: Local path (string) of file or if networking is off, last version of file cached on disk. Raises the following errors: - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) if `token=True` and the token cannot be found. - [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) if ETag cannot be determined. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. - [`~utils.RevisionNotFoundError`] If the revision to download from cannot be found. - [`~utils.EntryNotFoundError`] If the file to download cannot be found. - [`~utils.LocalEntryNotFoundError`] If network is disabled or unavailable and file is not found in cache. r)hf_hub_downloadNrrrrrrrrerrrrfrrrrrrcrhrrr) file_downloadrrcrrrerfrh)rrrrrrrrrrrrrrrcrrrrrrrs^      zHfApi.hf_hub_download)rrrrrrrrrrcrrrrm tqdm_classrmrOptional[base_tqdm]cCsddlm}| dur |j} |did|d|d|d|jd|d |d |d |jd |jd |jd|d|d| d| d| d| d| d|d|d|S)a7Download repo files. Download a whole snapshot of a repo's files at the specified revision. This is useful when you want all files from a repo, because you don't know which ones you will need a priori. All files are nested inside a folder in order to keep their actual filename relative to that folder. You can also filter which files to download using `allow_patterns` and `ignore_patterns`. If `local_dir` is provided, the file structure from the repo will be replicated in this location. You can configure how you want to move those files: - If `local_dir_use_symlinks="auto"` (default), files are downloaded and stored in the cache directory as blob files. Small files (<5MB) are duplicated in `local_dir` while a symlink is created for bigger files. The goal is to be able to manually edit and save small files without corrupting the cache while saving disk space for binary files. The 5MB threshold can be configured with the `HF_HUB_LOCAL_DIR_AUTO_SYMLINK_THRESHOLD` environment variable. - If `local_dir_use_symlinks=True`, files are downloaded, stored in the cache directory and symlinked in `local_dir`. This is optimal in term of disk usage but files must not be manually edited. - If `local_dir_use_symlinks=False` and the blob files exist in the cache directory, they are duplicated in the local dir. This means disk usage is not optimized. - Finally, if `local_dir_use_symlinks=False` and the blob files do not exist in the cache directory, then the files are downloaded and directly placed under `local_dir`. This means if you need to download them again later, they will be re-downloaded entirely. An alternative would be to clone the repo but this requires git and git-lfs to be installed and properly configured. It is also not possible to filter which files to download when cloning a repository using git. Args: repo_id (`str`): A user or an organization name and a repo name separated by a `/`. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if downloading from a dataset or space, `None` or `"model"` if downloading from a model. Default is `None`. revision (`str`, *optional*): An optional Git revision id which can be a branch name, a tag, or a commit hash. cache_dir (`str`, `Path`, *optional*): Path to the folder where cached files are stored. local_dir (`str` or `Path`, *optional*): If provided, the downloaded files will be placed under this directory, either as symlinks (default) or regular files (see description for more details). local_dir_use_symlinks (`"auto"` or `bool`, defaults to `"auto"`): To be used with `local_dir`. If set to "auto", the cache directory will be used and the file will be either duplicated or symlinked to the local directory depending on its size. It set to `True`, a symlink will be created, no matter the file size. If set to `False`, the file will either be duplicated from cache (if already exists) or downloaded from the Hub and not cached. See description for more details. proxies (`dict`, *optional*): Dictionary mapping protocol to the URL of the proxy passed to `requests.request`. etag_timeout (`float`, *optional*, defaults to `10`): When fetching ETag, how many seconds to wait for the server to send data before giving up which is passed to `requests.request`. resume_download (`bool`, *optional*, defaults to `False): If `True`, resume a previously interrupted download. force_download (`bool`, *optional*, defaults to `False`): Whether the file should be downloaded even if it already exists in the local cache. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. local_files_only (`bool`, *optional*, defaults to `False`): If `True`, avoid downloading the file and return the path to the local cached file if it exists. allow_patterns (`List[str]` or `str`, *optional*): If provided, only files matching at least one pattern are downloaded. ignore_patterns (`List[str]` or `str`, *optional*): If provided, files matching any of the patterns are not downloaded. max_workers (`int`, *optional*): Number of concurrent threads to download files (1 thread = 1 file download). Defaults to 8. tqdm_class (`tqdm`, *optional*): If provided, overwrites the default behavior for the progress bar. Passed argument must inherit from `tqdm.auto.tqdm` or at least mimic its behavior. Note that the `tqdm_class` is not passed to each individual download. Defaults to the custom HF progress bar that can be disabled by setting `HF_HUB_DISABLE_PROGRESS_BARS` environment variable. Returns: Local folder path (string) of repo snapshot Raises the following errors: - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) if `token=True` and the token cannot be found. - [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) if ETag cannot be determined. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid r)snapshot_downloadNrrrrrrrrrerfrrrrrcrrrrmrr)Z_snapshot_downloadrrcrrrerf)rrrrrrrrrrrrcrrrrmrrrrrrVsX q     zHfApi.snapshot_downloadrdc sjtdr&jtd}tdddd|jDt|idSjtdrjtd}t| }t |}Wdn1sNwY| di} idfd d } t | t | dtdt| ddd| dStddtdtd)ur Parse metadata for a safetensors repo on the Hub. We first check if the repo has a single safetensors file or a sharded safetensors repo. If it's a single safetensors file, we parse the metadata from this file. If it's a sharded safetensors repo, we parse the metadata from the index file and then parse the metadata from each shard. To parse metadata from a single safetensors file, use [`parse_safetensors_file_metadata`]. For more details regarding the safetensors format, check out https://huggingface.co/docs/safetensors/index#format. Args: repo_id (`str`): A user or an organization name and a repo name separated by a `/`. filename (`str`): The name of the file in the repo. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if the file is in a dataset or space, `None` or `"model"` if in a model. Default is `None`. revision (`str`, *optional*): The git revision to fetch the file from. Can be a branch name, a tag, or a commit hash. Defaults to the head of the `"main"` branch. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: [`SafetensorsRepoMetadata`]: information related to safetensors repo. Raises: - [`NotASafetensorsRepoError`]: if the repo is not a safetensors repo i.e. doesn't have either a `model.safetensors` or a `model.safetensors.index.json` file. - [`SafetensorsParsingError`]: if a safetensors file header couldn't be parsed correctly. Example: ```py # Parse repo with single weights file >>> metadata = get_safetensors_metadata("bigscience/bloomz-560m") >>> metadata SafetensorsRepoMetadata( metadata=None, sharded=False, weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...}, files_metadata={'model.safetensors': SafetensorsFileMetadata(...)} ) >>> metadata.files_metadata["model.safetensors"].metadata {'format': 'pt'} # Parse repo with sharded model >>> metadata = get_safetensors_metadata("bigscience/bloom") Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00, 5.78it/s] >>> metadata SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...}) >>> len(metadata.files_metadata) 72 # All safetensors files have been fetched # Parse repo with sharded model >>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5") NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files. ``` rrrrrcNFcSsi|]}|tqSr)rN)rZ tensor_namerrrr'3z2HfApi.get_safetensors_metadata..)metadataZsharded weight_maprrrrzr}rcsj|d|<dS)Nr)parse_safetensors_file_metadata)rrrrrrrcrr_parseEs z.HfApi.get_safetensors_metadata.._parsezParse safetensors files)ZdescrrT'z,' is not a safetensors repo. Couldn't find 'z' or 'z' files.)rrzr}r)rrNrrdtensorskeysrLrrrtloadrrrr7hf_tqdmr_) rrrrrcZ file_metadataZ index_filerindexrrrrrget_safetensors_metadatasNF         zHfApi.get_safetensors_metadatarbc Cst|||||jd}|j|d}tj|i|ddid}t|td|jddd } | t krIt d |d |d |p>t d t d| d | dkrW|jdd| } ntj|i|dd| did}t||j} z t | jdd} Wnt jy} zt d |d |d |pt d| d} ~ wwzt| didd| DdWSttfy} zt d |d |d |pt d| d} ~ ww)a Parse metadata from a safetensors file on the Hub. To parse metadata from all safetensors files in a repo at once, use [`get_safetensors_metadata`]. For more details regarding the safetensors format, check out https://huggingface.co/docs/safetensors/index#format. Args: repo_id (`str`): A user or an organization name and a repo name separated by a `/`. filename (`str`): The name of the file in the repo. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if the file is in a dataset or space, `None` or `"model"` if in a model. Default is `None`. revision (`str`, *optional*): The git revision to fetch the file from. Can be a branch name, a tag, or a commit hash. Defaults to the head of the `"main"` branch. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: [`SafetensorsFileMetadata`]: information related to a safetensors file. Raises: - [`NotASafetensorsRepoError`]: if the repo is not a safetensors repo i.e. doesn't have either a `model.safetensors` or a `model.safetensors.index.json` file. - [`SafetensorsParsingError`]: if a safetensors file header couldn't be parsed correctly. )rrrrrrorangezbytes=0-100000rpz.)rrzb'): header format not recognized. Please make sure this is a correctly formatted safetensors file.)rTrrsrirrjstructunpackrUrMrcrBrtloadsrnJSONDecodeErrorrbr8KeyError IndexError) rrrrrrcr_headersrrZ metadata_sizeZmetadata_as_bytesZmetadata_as_dictrvrrrr]sf(  &  z%HfApi.parse_safetensors_file_metadata)rrcrrc Cs|durt}t|dd}|jd|d|d|}|j|d}i} |dur*|| d<tj||| d } zt| WdStyV} z| jj d krJ|sKWYd} ~ dSd} ~ ww) a Create a new branch for a repo on the Hub, starting from the specified revision (defaults to `main`). To find a revision suiting your needs, you can use [`list_repo_refs`] or [`list_repo_commits`]. Args: repo_id (`str`): The repository in which the branch will be created. Example: `"user/my-cool-model"`. branch (`str`): The name of the branch to create. revision (`str`, *optional*): The git revision to create the branch from. It can be a branch name or the OID/SHA of a commit, as a hexadecimal string. Defaults to the head of the `"main"` branch. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if creating a branch on a dataset or space, `None` or `"model"` if tagging a model. Default is `None`. exist_ok (`bool`, *optional*, defaults to `False`): If `True`, do not raise an error if branch already exists. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.BadRequestError`]: If invalid reference for a branch. Ex: `refs/pr/5` or 'refs/foo/bar'. [`~utils.HfHubHTTPError`]: If the branch already exists on the repo (error 409) and `exist_ok` is set to `False`. Nrrrr/branch/roZ startingPointrr/) rHrrrsrirrjr]rrr4) rrrrrcrr branch_urlrhpayloadrrrvrrr create_branchs"0  zHfApi.create_branchcC\|durt}t|dd}|jd|d|d|}|j|d}tj||d}t|dS) a) Delete a branch from a repo on the Hub. Args: repo_id (`str`): The repository in which a branch will be deleted. Example: `"user/my-cool-model"`. branch (`str`): The name of the branch to delete. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if creating a branch on a dataset or space, `None` or `"model"` if tagging a model. Default is `None`. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.HfHubHTTPError`]: If trying to delete a protected branch. Ex: `main` cannot be deleted. [`~utils.HfHubHTTPError`]: If trying to delete a branch that does not exist. NrrrrrrorrHrrrsrirrj)rrrrcrrrhrrrrr delete_branchs%   zHfApi.delete_branch) tag_messagerrcrrtagrc Cs|durt}|durt|ddnt}|jd|d|d|}|j|d} d|i} |dur2|| d <tj|| | d } zt| WdSty^} z| j j d krR|sSWYd} ~ dSd} ~ ww) a\ Tag a given commit of a repo on the Hub. Args: repo_id (`str`): The repository in which a commit will be tagged. Example: `"user/my-cool-model"`. tag (`str`): The name of the tag to create. tag_message (`str`, *optional*): The description of the tag to create. revision (`str`, *optional*): The git revision to tag. It can be a branch name or the OID/SHA of a commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. Defaults to the head of the `"main"` branch. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if tagging a dataset or space, `None` or `"model"` if tagging a model. Default is `None`. exist_ok (`bool`, *optional*, defaults to `False`): If `True`, do not raise an error if tag already exists. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If revision is not found (error 404) on the repo. [`~utils.HfHubHTTPError`]: If the branch already exists on the repo (error 409) and `exist_ok` is set to `False`. Nrrrr/tag/ror rOrr/) rHrrBrrsrirrjr]rrr4) rrr rrrcrrtag_urlrhrrrrvrrr create_tag5s"4 zHfApi.create_tagcCr) a| Delete a tag from a repo on the Hub. Args: repo_id (`str`): The repository in which a tag will be deleted. Example: `"user/my-cool-model"`. tag (`str`): The name of the tag to delete. token (`str`, *optional*): Authentication token. Will default to the stored token. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if tagging a dataset or space, `None` or `"model"` if tagging a model. Default is `None`. Raises: [`~utils.RepositoryNotFoundError`]: If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repo does not exist. [`~utils.RevisionNotFoundError`]: If tag is not found. Nrrrrr rorr)rrr rcrr rhrrrrr delete_tag|s"   zHfApi.delete_tag)rrcmodel_idcCsL|durd|vr|dd}n|j|dd}|d|S|d|S)a Returns the repository name for a given model ID and optional organization. Args: model_id (`str`): The name of the model. organization (`str`, *optional*): If passed, the repository name will be in the organization namespace instead of the user namespace. token (`bool` or `str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). If `None` or `True` and machine is logged in (through `huggingface-cli login` or [`~huggingface_hub.login`]), token will be retrieved from the cache. If `False`, token is not sent in the request header. Returns: `str`: The repository name in the user's namespace ({username}/{model_id}) if no organization is passed, and under the organization namespace ({organization}/{model_id}) otherwise. NrrrorD)rrw)rrrrcrrrrget_full_repo_names zHfApi.get_full_repo_name)rdiscussion_typediscussion_statusrrcrOptional[DiscussionTypeFilter]r Optional[DiscussionStatusFilter]Iterator[Discussion]c #sX|tvr tdt|durt}|dur!|tvr!tdt|dur0|tvr0tdt|j|d|jd|d|di|durL|d <|durT|d <|dur\|d <dfdd }d\}} |r|| d\} }| D]-} t| d| d| d iddt | d| d | dd| dd | d|jd Vqt| d} |skdSdS)a Fetches Discussions and Pull Requests for the given repo. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. author (`str`, *optional*): Pass a value to filter by discussion author. `None` means no filter. Default is `None`. discussion_type (`str`, *optional*): Set to `"pull_request"` to fetch only pull requests, `"discussion"` to fetch only discussions. Set to `"all"` or `None` to fetch both. Default is `None`. discussion_status (`str`, *optional*): Set to `"open"` (respectively `"closed"`) to fetch only open (respectively closed) discussions. Set to `"all"` or `None` to fetch both. Default is `None`. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if fetching from a dataset or space, `None` or `"model"` if fetching from a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: `Iterator[Discussion]`: An iterator of [`Discussion`] objects. Example: Collecting all discussions of a repo in a list: ```python >>> from huggingface_hub import get_repo_discussions >>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased")) ``` Iterating over discussions of a repo: ```python >>> from huggingface_hub import get_repo_discussions >>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"): ... print(discussion.num, discussion.title) ``` rQNz(Invalid discussion_type, must be one of z*Invalid discussion_status, must be one of rorr /discussionsr2rr page_indexrcsZ|d<tjd}t||}|d}|d}|d}|t||k}||fS)Nprcountstart discussions)rirrjrtr)rrespZpaginated_discussionsrrrhas_nextrhrrrr_fetch_discussion_pagesz:HfApi.get_repo_discussions.._fetch_discussion_page)Tr)rrrrDdeletedrr isPullRequest) rrrrrrrrrr)rr) rIrrHrDrCrsrr8rrm) rrrrrrrcrrrrrrrrrsH8       zHfApi.get_repo_discussionsrr<c Cs@t|tr |dkr td|tvrtdt|durt}|jd|d|d|}|j|d}tj|d d i|d }t || }|d } | rQ|d dnd} | rY|dnd} | re|d ddnd} t |d|d|diddt |d|d|dd|dd|d dd|dD| | | |d |jdS)a8Fetches a Discussion's / Pull Request 's details from the Hub. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionWithDetails`] Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. r2Invalid discussion_num, must be a positive integerrQNrr /discussions/rodiffrirr changesbaseZfilesWithConflictsZ mergeCommitIdrrrrDrrrrr2cSsg|]}t|qSr)r=)rZevtrrrr}rz0HfApi.get_discussion_details..r)rrrrrrrrrconflicting_files target_branchmerge_commit_oidr#r) rrrrIrHrrsrirrjrtr<rm) rrrrrcrrhrZdiscussion_detailsrr'r&r(rrrr9s>(    zHfApi.get_discussion_details)rcr)r pull_requestrr)r)c Cs|tvr tdt|durt}|dur|}|r|n|r!dndd}|j|d}tj|jd|d|d |||d |d }t|| d } |j ||| |d S)aCreates a Discussion or Pull Request. Pull Requests created programmatically will be in `"draft"` status. Creating a Pull Request with changes can also be done at once with [`HfApi.create_commit`]. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. title (`str`): The title of the discussion. It can be up to 200 characters long, and must be at least 3 characters long. Leading and trailing whitespaces will be stripped. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) description (`str`, *optional*): An optional description for the Pull Request. Defaults to `"Discussion opened with the huggingface_hub Python library"` pull_request (`bool`, *optional*): Whether to create a Pull Request or discussion. If `True`, creates a Pull Request. If `False`, creates a discussion. Defaults to `False`. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. Returns: [`DiscussionWithDetails`] Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. rQNz Pull Requestr8z^ opened with the [huggingface_hub Python library](https://huggingface.co/docs/huggingface_hub)rorrr)rr)Z pullRequestrVr)rrrrc) rIrrHstriprsrirrrjrtr) rrrrcr)rr)rhrrrrrcreate_discussions65  zHfApi.create_discussion)rcr)rcCs|j|||||ddS)aCreates a Pull Request . Pull Requests created programmatically will be in `"draft"` status. Creating a Pull Request with changes can also be done at once with [`HfApi.create_commit`]; This is a wrapper around [`HfApi.create_discussion`]. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. title (`str`): The title of the discussion. It can be up to 200 characters long, and must be at least 3 characters long. Leading and trailing whitespaces will be stripped. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) description (`str`, *optional*): An optional description for the Pull Request. Defaults to `"Discussion opened with the huggingface_hub Python library"` repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. Returns: [`DiscussionWithDetails`] Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. T)rrrcr)rr))r+)rrrrcr)rrrrcreate_pull_requests1zHfApi.create_pull_request)bodyrcrresourcer-Optional[dict]requests.Responsec Cst|tr |dkr td|tvrtdt|durt}|d|}|jd|d|d|}|j|d }tj|||d } t | | S) z@Internal utility to POST changes to a Discussion or Pull Requestrr!rQNrrr"rror.) rrrrIrHrrsrequestsrrj) rrrr.r-rcrrrhrrrr_post_discussion_changess  zHfApi._post_discussion_changesrr9cC*|j||||dd|id}t|dS)aCreates a new comment on the given Discussion. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. comment (`str`): The content of the comment to create. Comments support markdown formatting. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionComment`]: the newly created comment Examples: ```python >>> comment = """ ... Hello @otheruser! ... ... # This is a title ... ... **This is bold**, *this is italic* and ~this is strikethrough~ ... And [this](http://url) is a link ... """ >>> HfApi().comment_discussion( ... repo_id="username/repo_name", ... discussion_num=34 ... comment=comment ... ) # DiscussionComment(id='deadbeef0000000', type='comment', ...) ``` Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. rrrrrcr.r-Z newMessager2r=rt)rrrrrcrrrrrr2sBzHfApi.comment_discussionrr;cCr3)aRenames a Discussion. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. new_title (`str`): The new title for the discussion repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionTitleChange`]: the title change event Examples: ```python >>> new_title = "New title, fixing a typo" >>> HfApi().rename_discussion( ... repo_id="username/repo_name", ... discussion_num=34 ... new_title=new_title ... ) # DiscussionTitleChange(id='deadbeef0000000', type='title-change', ...) ``` Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. rr4ZnewTitler5)rrrrrcrrrrrr~s9zHfApi.rename_discussion)rcrrrLiteral['open', 'closed']r:c CsV|dvrtdd|i}|r|r||d<|j||||d|d}t|dS)aCloses or re-opens a Discussion or Pull Request. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. new_status (`str`): The new status for the discussion, either `"open"` or `"closed"`. comment (`str`, *optional*): An optional comment to post with the status change. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionStatusChange`]: the status change event Examples: ```python >>> new_title = "New title, fixing a typo" >>> HfApi().rename_discussion( ... repo_id="username/repo_name", ... discussion_num=34 ... new_title=new_title ... ) # DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...) ``` Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. )rrz7Invalid status, valid statuses are: 'open' and 'closed'rrr4Z newStatus)rr*r2r=rt) rrrrrcrrr-rrrrrs<  zHfApi.change_discussion_statusc Cs2|j||||d|r|rd|indddS)aMerges a Pull Request. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. comment (`str`, *optional*): An optional comment to post with the status change. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionStatusChange`]: the status change event Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. mergerNr4)r2r*)rrrrcrrrrrr s, zHfApi.merge_pull_requestrrcCs6|j||||d|dd|id}t|dS)a Edits a comment on a Discussion / Pull Request. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. comment_id (`str`): The ID of the comment to edit. new_content (`str`): The new content of the comment. Comments support markdown formatting. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionComment`]: the edited comment Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. comment/z/editrUr4updatedComment)r2lowerr=rt)rrrrrrcrrrrrrAs/zHfApi.edit_discussion_commentcCs<tdt|j||||d|dd}t|dS)a!Hides a comment on a Discussion / Pull Request. Hidden comments' content cannot be retrieved anymore. Hiding a comment is irreversible. Args: repo_id (`str`): A namespace (user or an organization) and a repo name separated by a `/`. discussion_num (`int`): The number of the Discussion or Pull Request . Must be a strictly positive integer. comment_id (`str`): The ID of the comment to edit. repo_type (`str`, *optional*): Set to `"dataset"` or `"space"` if uploading to a dataset or space, `None` or `"model"` if uploading to a model. Default is `None`. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token) Returns: [`DiscussionComment`]: the hidden comment Raises the following errors: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) if some parameter value is invalid - [`~utils.RepositoryNotFoundError`] If the repository to download from cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. zWHidden comments' content cannot be retrieved anymore. Hiding a comment is irreversible.r8z/hide)rrrrcr.r9)r1r2 UserWarningr2r:r=rt)rrrrrcrrrrrhide_discussion_commentzs0zHfApi.hide_discussion_comment)r)rcr*rZcCsN||d}|dur ||d<tj|jd|d|j|d|d}t|dS)aAdds or updates a secret in a Space. Secrets allow to set secret keys or tokens to a Space without hardcoding them. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets. Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. key (`str`): Secret key. Example: `"GITHUB_API_KEY"` value (`str`): Secret value. Example: `"your_github_api_key"`. description (`str`, *optional*): Secret description. Example: `"Github API key to access the Github API"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. r*rZNr)r/secretsror.)rirrrsrjrrr*rZr)rcrrurrradd_space_secrets   zHfApi.add_space_secretcCs8tj|jd|d|j|dd|id}t|dS)a.Deletes a secret from a Space. Secrets allow to set secret keys or tokens to a Space without hardcoding them. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets. Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. key (`str`): Secret key. Example: `"GITHUB_API_KEY"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. rr>ror*r.N)rirrrsrjrrr*rcrurrrdelete_space_secrets   zHfApi.delete_space_secretDict[str, SpaceVariable]cCsDtj|jd|d|j|dd}t|dd|DS)aGets all variables from a Space. Variables allow to set environment variables to a Space without hardcoding them. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables Args: repo_id (`str`): ID of the repo to query. Example: `"bigcode/in-the-stack"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. r /variablesrorpcSi|] \}}|t||qSrr7r$rrrr'r+z-HfApi.get_space_variables..)rirrrsrjrtr8rrrcrurrrget_space_variabless   zHfApi.get_space_variablescCs`||d}|dur ||d<tj|jd|d|j|d|d}t|dd |DS) a/Adds or updates a variable in a Space. Variables allow to set environment variables to a Space without hardcoding them. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. key (`str`): Variable key. Example: `"MODEL_REPO_ID"` value (`str`): Variable value. Example: `"the_model_repo_id"`. description (`str`): Description of the variable. Example: `"Model Repo ID of the implemented model"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. r=Nr)rrDror.cSrErrFr$rrrr'r+z,HfApi.add_space_variable..)rirrrsrjrtr8r?rrradd_space_variables  zHfApi.add_space_variablecCsJtj|jd|d|j|dd|id}t|dd|DS)aKDeletes a variable from a Space. Variables allow to set environment variables to a Space without hardcoding them. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. key (`str`): Variable key. Example: `"MODEL_REPO_ID"` token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. rrDror*r.cSrErrFr$rrrr'7r+z/HfApi.delete_space_variable..)rirrrsrjrtr8rArrrdelete_space_variable s zHfApi.delete_space_variabler5cC:tj|jd|d|j|dd}t|t|S)aGets runtime information about a Space. Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`SpaceRuntime`]: Runtime information about a Space including Space stage and hardware. rz/runtimerorp)rirrrsrjr5rtrGrrrget_space_runtime9s   zHfApi.get_space_runtime)rc sleep_timerr4rMcCsr|dur|tjkrtdtd|i}|dur||d<tj|jd|d|j|d|d}t |t | S) arRequest new hardware for a Space. Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. hardware (`str` or [`SpaceHardware`]): Hardware on which to run the Space. Example: `"t4-medium"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. sleep_time (`int`, *optional*): Number of seconds of inactivity to wait before a Space is put to sleep. Set to `-1` if you don't want your Space to sleep (default behavior for upgraded hardware). For free hardware, you can't configure the sleep time (value is fixed to 48 hours of inactivity). See https://huggingface.co/docs/hub/spaces-gpus#sleep-time for more details. Returns: [`SpaceRuntime`]: Runtime information about a Space including Space stage and hardware. It is also possible to request hardware directly when creating the Space repo! See [`create_repo`] for details. N If your Space runs on the default 'cpu-basic' hardware, it will go to sleep if inactive for more than 48 hours. This value is not configurable. If you don't want your Space to deactivate or if you want to set a custom sleep time, you need to upgrade to a paid Hardware.Zflavorr rz /hardwareror.) r4 CPU_BASICr1r2r;rirrrsrjr5rt)rrrrcrMrrurrrrequest_space_hardwareLs   zHfApi.request_space_hardwarecCsftj|jd|d|j|dd|id}t|t|}|jp%|j}|t j kr1t dt |S)aSet a custom sleep time for a Space running on upgraded hardware.. Your Space will go to sleep after X seconds of inactivity. You are not billed when your Space is in "sleep" mode. If a new visitor lands on your Space, it will "wake it up". Only upgraded hardware can have a configurable sleep time. To know more about the sleep stage, please refer to https://huggingface.co/docs/hub/spaces-gpus#sleep-time. Args: repo_id (`str`): ID of the repo to update. Example: `"bigcode/in-the-stack"`. sleep_time (`int`, *optional*): Number of seconds of inactivity to wait before a Space is put to sleep. Set to `-1` if you don't want your Space to pause (default behavior for upgraded hardware). For free hardware, you can't configure the sleep time (value is fixed to 48 hours of inactivity). See https://huggingface.co/docs/hub/spaces-gpus#sleep-time for more details. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`SpaceRuntime`]: Runtime information about a Space including Space stage and hardware. It is also possible to set a custom sleep time when requesting hardware with [`request_space_hardware`]. rz /sleeptimerosecondsr.rN)rirrrsrjr5rtZrequested_hardwarerr4rOr1r2r;)rrrMrcrur$rrrrset_space_sleep_time~s    zHfApi.set_space_sleep_timecCrK)a Pause your Space. A paused Space stops executing until manually restarted by its owner. This is different from the sleeping state in which free Spaces go after 48h of inactivity. Paused time is not billed to your account, no matter the hardware you've selected. To restart your Space, use [`restart_space`] and go to your Space settings page. For more details, please visit [the docs](https://huggingface.co/docs/hub/spaces-gpus#pause). Args: repo_id (`str`): ID of the Space to pause. Example: `"Salesforce/BLIP2"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`SpaceRuntime`]: Runtime information about your Space including `stage=PAUSED` and requested hardware. Raises: [`~utils.RepositoryNotFoundError`]: If your Space is not found (error 404). Most probably wrong repo_id or your space is private but you are not authenticated. [`~utils.HfHubHTTPError`]: 403 Forbidden: only the owner of a Space can pause it. If you want to manage a Space that you don't own, either ask the owner by opening a Discussion or duplicate the Space. [`~utils.BadRequestError`]: If your Space is a static Space. Static Spaces are always running and never billed. If you want to hide a static Space, you can set it to private. r/pauserorprirrrsrjr5rtrGrrr pause_spaces  zHfApi.pause_space)rcfactory_rebootrVcCsLi}|rd|d<tj|jd|d|j|d|d}t|t|S)avRestart your Space. This is the only way to programmatically restart a Space if you've put it on Pause (see [`pause_space`]). You must be the owner of the Space to restart it. If you are using an upgraded hardware, your account will be billed as soon as the Space is restarted. You can trigger a restart no matter the current state of a Space. For more details, please visit [the docs](https://huggingface.co/docs/hub/spaces-gpus#pause). Args: repo_id (`str`): ID of the Space to restart. Example: `"Salesforce/BLIP2"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. factory_reboot (`bool`, *optional*): If `True`, the Space will be rebuilt from scratch without caching any requirements. Returns: [`SpaceRuntime`]: Runtime information about your Space. Raises: [`~utils.RepositoryNotFoundError`]: If your Space is not found (error 404). Most probably wrong repo_id or your space is private but you are not authenticated. [`~utils.HfHubHTTPError`]: 403 Forbidden: only the owner of a Space can restart it. If you want to restart a Space that you don't own, either ask the owner by opening a Discussion or duplicate the Space. [`~utils.BadRequestError`]: If your Space is a static Space. Static Spaces are always running and never billed. If you want to hide a static Space, you can set it to private. truefactoryrz/restartrorrT)rrrcrVrrurrr restart_spaces" zHfApi.restart_space)rrcrrstoragerMr!r"rZr!r"c Cs8|durt|nd} | dur| jdur| jn||d} |dur$| jnt|j} d| d| i}gd}||||| | g}|ddt||D|durZ|tjkrZt dt t j |j d |d |j|d |d }zt|Wnty}z|r|jjd krnWYd}~nd}~wwt|d|j dS)a5Duplicate a Space. Programmatically duplicate a Space. The new Space will be created in your account and will be in the same state as the original Space (running or paused). You can duplicate a Space no matter the current state of a Space. Args: from_id (`str`): ID of the Space to duplicate. Example: `"pharma/CLIP-Interrogator"`. to_id (`str`, *optional*): ID of the new Space. Example: `"dog/CLIP-Interrogator"`. If not provided, the new Space will have the same name as the original Space, but in your account. private (`bool`, *optional*): Whether the new Space should be private or not. Defaults to the same privacy as the original Space. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. exist_ok (`bool`, *optional*, defaults to `False`): If `True`, do not raise an error if repo already exists. hardware (`SpaceHardware` or `str`, *optional*): Choice of Hardware. Example: `"t4-medium"`. See [`SpaceHardware`] for a complete list. storage (`SpaceStorage` or `str`, *optional*): Choice of persistent storage tier. Example: `"small"`. See [`SpaceStorage`] for a complete list. sleep_time (`int`, *optional*): Number of seconds of inactivity to wait before a Space is put to sleep. Set to `-1` if you don't want your Space to sleep (default behavior for upgraded hardware). For free hardware, you can't configure the sleep time (value is fixed to 48 hours of inactivity). See https://huggingface.co/docs/hub/spaces-gpus#sleep-time for more details. secrets (`List[Dict[str, str]]`, *optional*): A list of secret keys to set in your Space. Each item is in the form `{"key": ..., "value": ..., "description": ...}` where description is optional. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets. variables (`List[Dict[str, str]]`, *optional*): A list of public environment variables to set in your Space. Each item is in the form `{"key": ..., "value": ..., "description": ...}` where description is optional. For more details, see https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables. Returns: [`RepoUrl`]: URL to the newly created repo. Value is a subclass of `str` containing attributes like `endpoint`, `repo_type` and `repo_id`. Raises: - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) if the HuggingFace API returned an error - [`~utils.RepositoryNotFoundError`] If one of `from_id` or `to_id` cannot be found. This may be because it doesn't exist, or because it is set to `private` and you do not have access. Example: ```python >>> from huggingface_hub import duplicate_space # Duplicate a Space to your account >>> duplicate_space("multimodalart/dreambooth-training") RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...) # Can set custom destination id and visibility flag. >>> duplicate_space("multimodalart/dreambooth-training", to_id="my-dreambooth", private=True) RepoUrl('https://huggingface.co/spaces/nateraw/my-dreambooth',...) ``` NrD repositoryr)rrrr r!r"cSr#rrr$rrrr'Sr(z)HfApi.duplicate_space..rNrz /duplicateror.r/rr0)rrrwrrrXr4rOr1r2r;rirrrsrjrrrr4rt)rr?r@rrcrrrZrMr!r"Z parsed_to_idZ to_namespaceZ to_repo_namerrr7rur8rrrduplicate_spaces<I    zHfApi.duplicate_spacer6cCsDd|i}tj|jd|d|j|d|d}t|t|S)aRequest persistent storage for a Space. Args: repo_id (`str`): ID of the Space to update. Example: `"HuggingFaceH4/open_llm_leaderboard"`. storage (`str` or [`SpaceStorage`]): Storage tier. Either 'small', 'medium', or 'large'. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`SpaceRuntime`]: Runtime information about a Space including Space stage and hardware. It is not possible to decrease persistent storage after its granted. To do so, you must delete it via [`delete_space_storage`]. Ztierr/storageror.rT)rrrZrcrrurrrrequest_space_storagens  zHfApi.request_space_storagecCrK)aDelete persistent storage for a Space. Args: repo_id (`str`): ID of the Space to update. Example: `"HuggingFaceH4/open_llm_leaderboard"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`SpaceRuntime`]: Runtime information about a Space including Space stage and hardware. Raises: [`BadRequestError`] If space has no persistent storage. rr]rorp)rirrrsrjr5rtrGrrrdelete_space_storages   zHfApi.delete_space_storagerList[InferenceEndpoint]c sdkrK|jd}t|jdd}|dgD]/}z |t|dd7}WqtyH}z|jjdkr>td|d|WYd }~qd }~ww|SpR|jdt jt d |j dd }t |fd d | dDS)aLists all inference endpoints for the given namespace. Args: namespace (`str`, *optional*): The namespace to list endpoints for. Defaults to the current user. Set to `"*"` to list all endpoints from all namespaces (i.e. personal namespace and all orgs the user belongs to). token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: List[`InferenceEndpoint`]: A list of all inference endpoints for the given namespace. Example: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.list_inference_endpoints() [InferenceEndpoint(name='my-endpoint', ...), ...] ``` *ro)rZorgsrDrrciz0Cannot list Inference Endpoints for org '%s': %sN /endpoint/rpcsg|] }tj|dqS)rb)r'from_raw)rrrbrrrsz2HfApi.list_inference_endpoints..r8)rwlist_inference_endpoints_get_namespacerr]rrr4r5r6rirFrsrjrt)rrrcrSZ endpointsorgr]rrrrbrres,       zHfApi.list_inference_endpointsrr) account_id min_replica max_replicarr custom_imager2rrcr[ framework accelerator instance_size instance_typeregionvendorrhrirjrkr2r(r'cCs|p|j|d}|durd|indii}| |||| | dd||| | |d|||d|d }tjtd ||j|d|d }t|tj|||d S) a*Create a new Inference Endpoint. Args: name (`str`): The unique name for the new Inference Endpoint. repository (`str`): The name of the model repository associated with the Inference Endpoint (e.g. `"gpt2"`). framework (`str`): The machine learning framework used for the model (e.g. `"custom"`). accelerator (`str`): The hardware accelerator to be used for inference (e.g. `"cpu"`). instance_size (`str`): The size or type of the instance to be used for hosting the model (e.g. `"large"`). instance_type (`str`): The cloud instance type where the Inference Endpoint will be deployed (e.g. `"c6i"`). region (`str`): The cloud region in which the Inference Endpoint will be created (e.g. `"us-east-1"`). vendor (`str`): The cloud provider or vendor where the Inference Endpoint will be hosted (e.g. `"aws"`). account_id (`str`, *optional*): The account ID used to link a VPC to a private Inference Endpoint (if applicable). min_replica (`int`, *optional*): The minimum number of replicas (instances) to keep running for the Inference Endpoint. Defaults to 0. max_replica (`int`, *optional*): The maximum number of replicas (instances) to scale to for the Inference Endpoint. Defaults to 1. revision (`str`, *optional*): The specific model revision to deploy on the Inference Endpoint (e.g. `"6c0e6080953db56375760c0471a8c5f2929baf11"`). task (`str`, *optional*): The task on which to deploy the model (e.g. `"text-classification"`). custom_image (`Dict`, *optional*): A custom Docker image to use for the Inference Endpoint. This is useful if you want to deploy an Inference Endpoint running on the `text-generation-inference` (TGI) framework (see examples). type ([`InferenceEndpointType]`, *optional*): The type of the Inference Endpoint, which can be `"protected"` (default), `"public"` or `"private"`. namespace (`str`, *optional*): The namespace where the Inference Endpoint will be created. Defaults to the current user's namespace. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: [`InferenceEndpoint`]: information about the updated Inference Endpoint. Example: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> create_inference_endpoint( ... "my-endpoint-name", ... repository="gpt2", ... framework="pytorch", ... task="text-generation", ... accelerator="cpu", ... vendor="aws", ... region="us-east-1", ... type="protected", ... instance_size="medium", ... instance_type="c6i", ... ) >>> endpoint InferenceEndpoint(name='my-endpoint-name', status="pending",...) # Run inference on the endpoint >>> endpoint.client.text_generation(...) "..." ``` ```python # Start an Inference Endpoint running Zephyr-7b-beta on TGI >>> from huggingface_hub import HfApi >>> api = HfApi() >>> create_inference_endpoint( ... "aws-zephyr-7b-beta-0486", ... repository="HuggingFaceH4/zephyr-7b-beta", ... framework="pytorch", ... task="text-generation", ... accelerator="gpu", ... vendor="aws", ... region="us-east-1", ... type="protected", ... instance_size="medium", ... instance_type="g5.2xlarge", ... custom_image={ ... "health_route": "/health", ... "env": { ... "MAX_BATCH_PREFILL_TOKENS": "2048", ... "MAX_INPUT_LENGTH": "1024", ... "MAX_TOTAL_TOKENS": "1512", ... "MODEL_ID": "/repository" ... }, ... "url": "ghcr.io/huggingface/text-generation-inference:1.1.0", ... }, ... ) ``` roNZcustom huggingfaceZ maxReplicaZ minReplicarmZ instanceSizeZ instanceTypeZscalingrlr[rrimage)rprq)Z accountIdcomputervrDproviderr2rcr.rb rfrirrFrsrjr'rdrt)rrDr[rlrmrnrorprqrhrirjrrrkr2rrcrvrrrrrrcreate_inference_endpoints:t   zHfApi.create_inference_endpointrbcCsT|p|j|d}tjtd|d||j|dd}t|tj|||dS)a%Get information about an Inference Endpoint. Args: name (`str`): The name of the Inference Endpoint to retrieve information about. namespace (`str`, *optional*): The namespace in which the Inference Endpoint is located. Defaults to the current user. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: [`InferenceEndpoint`]: information about the requested Inference Endpoint. Example: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> endpoint = api.get_inference_endpoint("my-text-to-image") >>> endpoint InferenceEndpoint(name='my-text-to-image', ...) # Get status >>> endpoint.status 'running' >>> endpoint.url 'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud' # Run inference >>> endpoint.client.text_to_image(...) ``` rorcrrprb) rfrirrFrsrjr'rdrtrrDrrcrrrrrget_inference_endpoints" zHfApi.get_inference_endpoint) rmrnrorirjr[rlrrrrcc Cs| p|j| d} i} tdd|||||fDr$|||||dd| d<tdd||| | fDr=||| | diid | d <tjtd | d ||j| d| d }t|tj| | | dS)a6Update an Inference Endpoint. This method allows the update of either the compute configuration, the deployed model, or both. All arguments are optional but at least one must be provided. For convenience, you can also update an Inference Endpoint using [`InferenceEndpoint.update`]. Args: name (`str`): The name of the Inference Endpoint to update. accelerator (`str`, *optional*): The hardware accelerator to be used for inference (e.g. `"cpu"`). instance_size (`str`, *optional*): The size or type of the instance to be used for hosting the model (e.g. `"large"`). instance_type (`str`, *optional*): The cloud instance type where the Inference Endpoint will be deployed (e.g. `"c6i"`). min_replica (`int`, *optional*): The minimum number of replicas (instances) to keep running for the Inference Endpoint. max_replica (`int`, *optional*): The maximum number of replicas (instances) to scale to for the Inference Endpoint. repository (`str`, *optional*): The name of the model repository associated with the Inference Endpoint (e.g. `"gpt2"`). framework (`str`, *optional*): The machine learning framework used for the model (e.g. `"custom"`). revision (`str`, *optional*): The specific model revision to deploy on the Inference Endpoint (e.g. `"6c0e6080953db56375760c0471a8c5f2929baf11"`). task (`str`, *optional*): The task on which to deploy the model (e.g. `"text-classification"`). namespace (`str`, *optional*): The namespace where the Inference Endpoint will be updated. Defaults to the current user's namespace. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: [`InferenceEndpoint`]: information about the updated Inference Endpoint. rocs|]}|duVqdSrrrrZrrrrzr{z2HfApi.update_inference_endpoint..rsrtrwcsr}rrr~rrrrzr{rrrurvrcrr.rb) rfanyrir=rFrsrjr'rdrt)rrDrmrnrorirjr[rlrrrrcrrrrrrupdate_inference_endpoints0:    zHfApi.update_inference_endpointcCsD|p|j|d}tjtd|d||j|dd}t|dS)aDelete an Inference Endpoint. This operation is not reversible. If you don't want to be charged for an Inference Endpoint, it is preferable to pause it with [`pause_inference_endpoint`] or scale it to zero with [`scale_to_zero_inference_endpoint`]. For convenience, you can also delete an Inference Endpoint using [`InferenceEndpoint.delete`]. Args: name (`str`): The name of the Inference Endpoint to delete. namespace (`str`, *optional*): The namespace in which the Inference Endpoint is located. Defaults to the current user. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). rorcrrpN)rfrirrFrsrjr{rrrdelete_inference_endpoints   zHfApi.delete_inference_endpointcCV|p|j|d}tjtd|d|d|j|dd}t|tj|||dS)aPause an Inference Endpoint. A paused Inference Endpoint will not be charged. It can be resumed at any time using [`resume_inference_endpoint`]. This is different than scaling the Inference Endpoint to zero with [`scale_to_zero_inference_endpoint`], which would be automatically restarted when a request is made to it. For convenience, you can also pause an Inference Endpoint using [`pause_inference_endpoint`]. Args: name (`str`): The name of the Inference Endpoint to pause. namespace (`str`, *optional*): The namespace in which the Inference Endpoint is located. Defaults to the current user. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: [`InferenceEndpoint`]: information about the paused Inference Endpoint. rorcrrSrprbryr{rrrpause_inference_endpoint! zHfApi.pause_inference_endpointcCr)akResume an Inference Endpoint. For convenience, you can also resume an Inference Endpoint using [`InferenceEndpoint.resume`]. Args: name (`str`): The name of the Inference Endpoint to resume. namespace (`str`, *optional*): The namespace in which the Inference Endpoint is located. Defaults to the current user. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: [`InferenceEndpoint`]: information about the resumed Inference Endpoint. rorcrz/resumerprbryr{rrrresume_inference_endpointAs zHfApi.resume_inference_endpointcCr)aScale Inference Endpoint to zero. An Inference Endpoint scaled to zero will not be charged. It will be resume on the next request to it, with a cold start delay. This is different than pausing the Inference Endpoint with [`pause_inference_endpoint`], which would require a manual resume with [`resume_inference_endpoint`]. For convenience, you can also scale an Inference Endpoint to zero using [`InferenceEndpoint.scale_to_zero`]. Args: name (`str`): The name of the Inference Endpoint to scale to zero. namespace (`str`, *optional*): The namespace in which the Inference Endpoint is located. Defaults to the current user. token (`str`, *optional*): An authentication token (See https://huggingface.co/settings/token). Returns: [`InferenceEndpoint`]: information about the scaled-to-zero Inference Endpoint. rorcrz/scale-to-zerorprbryr{rrr scale_to_zero_inference_endpoint]rz&HfApi.scale_to_zero_inference_endpointcCs(|j|d}|ddkr|dStd)z/Get the default namespace for the current user.ror2rSrDzfCannot determine default namespace. You must provide a 'namespace' as input or be logged in as a user.)rwr)rrcrrrrrf}s  zHfApi._get_namespace)r7r?rrrcr7r?8Optional[Literal['lastModified', 'trending', 'upvotes']]Iterable[Collection]c cs|jd}|j|d}i}|dur|d|i|dur%|d|i|dur0|d|i|dur;|d|it|||d} |durKt| |} t| D]\} } td d | i| VqOdS) aSList collections on the Huggingface Hub, given some filters. When listing collections, the item list per collection is truncated to 4 items maximum. To retrieve all items from a collection, you must use [`get_collection`]. Args: owner (`List[str]` or `str`, *optional*): Filter by owner's username. item (`List[str]` or `str`, *optional*): Filter collections containing a particular items. Example: `"models/teknium/OpenHermes-2.5-Mistral-7B"`, `"datasets/squad"` or `"papers/2311.12983"`. sort (`Literal["lastModified", "trending", "upvotes"]`, *optional*): Sort collections by last modified, trending or upvotes. limit (`int`, *optional*): Maximum number of collections to be returned. token (`bool` or `str`, *optional*): An authentication token (see https://huggingface.co/settings/token). Returns: `Iterable[Collection]`: an iterable of [`Collection`] objects. /api/collectionsroNr7r?rrrr/r)rrsrrlr enumerater5) rr7r?rrrcrrhrr8r/Zcollection_datarrrlist_collectionss$ #  zHfApi.list_collectionscollection_slugr5cCsLtj|jd||j|dd}t|tdii|d|jiS)aGets information about a Collection on the Hub. Args: collection_slug (`str`): Slug of the collection of the Hub. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`Collection`] Example: ```py >>> from huggingface_hub import get_collection >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") >>> collection.title 'Recent models' >>> len(collection.items) 37 >>> collection.items[0] CollectionItem( item_object_id='651446103cd773a050bf64c2', item_id='TheBloke/U-Amethyst-20B-AWQ', item_type='model', position=88, note=None ) ``` /api/collections/rorprNr)rirrrsrjr5rt)rrrcrurrrget_collections  zHfApi.get_collection)rr)r exists_okrcrc Cs|dur ||d}|||d}|dur||d<tj|jd|j|d|d}zt|Wn(tyX} z|rS| jjdkrS| d } |j | |dWYd} ~ Sd} ~ wwt d ii| d |jiS) aCreate a new Collection on the Hub. Args: title (`str`): Title of the collection to create. Example: `"Recent models"`. namespace (`str`, *optional*): Namespace of the collection to create (username or org). Will default to the owner name. description (`str`, *optional*): Description of the collection to create. private (`bool`, *optional*): Whether the collection should be private or not. Defaults to `False` (i.e. public collection). exists_ok (`bool`, *optional*): If `True`, do not raise an error if collection already exists. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`Collection`] Example: ```py >>> from huggingface_hub import create_collection >>> collection = create_collection( ... title="ICCV 2023", ... description="Portfolio of models, papers and demos I presented at ICCV 2023", ... ) >>> collection.slug "username/iccv-2023-64f9a55bb3115b4f513ec026" ``` NrD)rrrr)rror.r/r6rr) rwrirrrsrjrrrr4rtrr5) rrrr)rrrcrrur8r6rrrcreate_collections*(   zHfApi.create_collection)rr)r/rr:rcr/r:c Csp|||||d}tj|jd||j|ddd|Dd} t| td ii| dd|jiS) a-Update metadata of a collection on the Hub. All arguments are optional. Only provided metadata will be updated. Args: collection_slug (`str`): Slug of the collection to update. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. title (`str`): Title of the collection to update. description (`str`, *optional*): Description of the collection to update. position (`int`, *optional*): New position of the collection in the list of collections of the user. private (`bool`, *optional*): Whether the collection should be private or not. theme (`str`, *optional*): Theme of the collection on the Hub. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`Collection`] Example: ```py >>> from huggingface_hub import update_collection_metadata >>> collection = update_collection_metadata( ... collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026", ... title="ICCV Oct. 2023" ... description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023", ... private=False, ... theme="pink", ... ) >>> collection.slug "username/iccv-oct-2023-64f9a55bb3115b4f513ec026" # ^collection slug got updated but not the trailing ID ``` )r/rr:rr)rrocSr#rrr)rrrr'dr(z4HfApi.update_collection_metadata..r.rrNr)ripatchrrsr8rjr5rt) rrrr)r/rr:rcrrurrrupdate_collection_metadata(s2 $z HfApi.update_collection_metadata)r:rcc Csltj|jd||j|dd}zt|WdSty5}z|r0|jjdkr0WYd}~dSd}~ww)a(Delete a collection on the Hub. Args: collection_slug (`str`): Slug of the collection to delete. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. missing_ok (`bool`, *optional*): If `True`, do not raise an error if collection doesn't exists. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Example: ```py >>> from huggingface_hub import delete_collection >>> collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True) ``` This is a non-revertible action. A deleted collection cannot be restored. rrorpNrirrrsrjrrrr4)rrr:rcrur8rrrdelete_collectioniszHfApi.delete_collection)r0rrcr-r.r3r0c Csd||di}|dur||d<tj|jd|d|j|d|d}zt|Wn"tyK} z|rF| jjd krF|j||dWYd} ~ Sd} ~ wwt d ii| d |jiS) a} Add an item to a collection on the Hub. Args: collection_slug (`str`): Slug of the collection to update. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_id (`str`): ID of the item to add to the collection. It can be the ID of a repo on the Hub (e.g. `"facebook/bart-large-mnli"`) or a paper id (e.g. `"2307.09288"`). item_type (`str`): Type of the item to add. Can be one of `"model"`, `"dataset"`, `"space"` or `"paper"`. note (`str`, *optional*): A note to attach to the item in the collection. The maximum size for a note is 500 characters. exists_ok (`bool`, *optional*): If `True`, do not raise an error if item already exists. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Returns: [`Collection`] Raises: `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. `HTTPError`: HTTP 404 if the item you try to add to the collection does not exist on the Hub. `HTTPError`: HTTP 409 if the item you try to add to the collection is already in the collection (and exists_ok=False) Example: ```py >>> from huggingface_hub import add_collection_item >>> collection = add_collection_item( ... collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab", ... item_id="pierre-loic/climate-news-articles", ... item_type="dataset" ... ) >>> collection.items[-1].item_id "pierre-loic/climate-news-articles" # ^item got added to the collection on last position # Add item with a note >>> add_collection_item( ... collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab", ... item_id="datasets/climate_fever", ... item_type="dataset" ... note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet." ... ) (...) ``` r?)rr2Nr0rz/itemsror.r/rr) rirrrsrjrrrr4rr5rt) rrr-r.r0rrcrrur8rrradd_collection_items"=   zHfApi.add_collection_item)r0r/rcr,cCsP||d}tj|jd|d||j|ddd|Dd}t|dS) aUpdate an item in a collection. Args: collection_slug (`str`): Slug of the collection to update. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_object_id (`str`): ID of the item in the collection. This is not the id of the item on the Hub (repo_id or paper id). It must be retrieved from a [`CollectionItem`] object. Example: `collection.items[0].item_object_id`. note (`str`, *optional*): A note to attach to the item in the collection. The maximum size for a note is 500 characters. position (`int`, *optional*): New position of the item in the collection. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Example: ```py >>> from huggingface_hub import get_collection, update_collection_item # Get collection first >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") # Update item based on its ID (add note + update position) >>> update_collection_item( ... collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026", ... item_object_id=collection.items[-1].item_object_id, ... note="Newly updated model!" ... position=0, ... ) ``` )r/r0r/items/rocSr#rrr)rrrr' r(z0HfApi.update_collection_item..r.N)rirrrsr8rj)rrr,r0r/rcrrurrrupdate_collection_items )  zHfApi.update_collection_itemc Csrtj|jd|d||j|dd}zt|WdSty8}z|r3|jjdkr3WYd}~dSd}~ww)aDelete an item from a collection. Args: collection_slug (`str`): Slug of the collection to update. Example: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_object_id (`str`): ID of the item in the collection. This is not the id of the item on the Hub (repo_id or paper id). It must be retrieved from a [`CollectionItem`] object. Example: `collection.items[0]._id`. missing_ok (`bool`, *optional*): If `True`, do not raise an error if item doesn't exists. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. Example: ```py >>> from huggingface_hub import get_collection, delete_collection_item # Get collection first >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") # Delete item based on its ID >>> delete_collection_item( ... collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026", ... item_object_id=collection.items[-1].item_object_id, ... ) ``` rrrorprNr)rrr,r:rcrur8rrrdelete_collection_items$ zHfApi.delete_collection_itemList[AccessRequest]cC|j|d||dS)u Get pending access requests for a given gated repo. A pending request means the user has requested access to the repo but the request has not been processed yet. If the approval mode is automatic, this list should be empty. Pending requests can be accepted or rejected using [`accept_access_request`] and [`reject_access_request`]. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to get access requests for. repo_type (`str`, *optional*): The type of the repo to get access requests for. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Returns: `List[AccessRequest]`: A list of [`AccessRequest`] objects. Each time contains a `username`, `email`, `status` and `timestamp` attribute. If the gated repo has a custom form, the `fields` attribute will be populated with user's answers. Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. Example: ```py >>> from huggingface_hub import list_pending_access_requests, accept_access_request # List pending requests >>> requests = list_pending_access_requests("meta-llama/Llama-2-7b") >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='pending', fields=None, ), ... ] # Accept Clem's request >>> accept_access_request("meta-llama/Llama-2-7b", "clem") ``` pendingr_list_access_requestsrrrrlist_pending_access_requestsEs;z"HfApi.list_pending_access_requestscCr)uQ Get accepted access requests for a given gated repo. An accepted request means the user has requested access to the repo and the request has been accepted. The user can download any file of the repo. If the approval mode is automatic, this list should contains by default all requests. Accepted requests can be cancelled or rejected at any time using [`cancel_access_request`] and [`reject_access_request`]. A cancelled request will go back to the pending list while a rejected request will go to the rejected list. In both cases, the user will lose access to the repo. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to get access requests for. repo_type (`str`, *optional*): The type of the repo to get access requests for. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Returns: `List[AccessRequest]`: A list of [`AccessRequest`] objects. Each time contains a `username`, `email`, `status` and `timestamp` attribute. If the gated repo has a custom form, the `fields` attribute will be populated with user's answers. Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. Example: ```py >>> from huggingface_hub import list_accepted_access_requests >>> requests = list_accepted_access_requests("meta-llama/Llama-2-7b") >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='accepted', fields=None, ), ... ] ``` acceptedrrrrrrlist_accepted_access_requests9z#HfApi.list_accepted_access_requestscCr)u Get rejected access requests for a given gated repo. A rejected request means the user has requested access to the repo and the request has been explicitly rejected by a repo owner (either you or another user from your organization). The user cannot download any file of the repo. Rejected requests can be accepted or cancelled at any time using [`accept_access_request`] and [`cancel_access_request`]. A cancelled request will go back to the pending list while an accepted request will go to the accepted list. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to get access requests for. repo_type (`str`, *optional*): The type of the repo to get access requests for. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Returns: `List[AccessRequest]`: A list of [`AccessRequest`] objects. Each time contains a `username`, `email`, `status` and `timestamp` attribute. If the gated repo has a custom form, the `fields` attribute will be populated with user's answers. Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. Example: ```py >>> from huggingface_hub import list_rejected_access_requests >>> requests = list_rejected_access_requests("meta-llama/Llama-2-7b") >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='rejected', fields=None, ), ... ] ``` rejectedrrrrrrlist_rejected_access_requestsrz#HfApi.list_rejected_access_requestsr*Literal['accepted', 'rejected', 'pending']cCsj|tvr tdt|durt}tjtd|d|d||j|dd}t|dd|DS) NrQrrz/user-access-request/rorpc SsJg|]!}t|dd|dd|dd|dt|d|ddqS)rSrrrrr)rrrrrr)rrmr)rrqrrrr s     z/HfApi._list_access_requests..) rIrrHrirrErsrjrt)rrrrrcrrrrrrs  zHfApi._list_access_requestscC|j||d||ddS)a Cancel an access request from a user for a given gated repo. A cancelled request will go back to the pending list and the user will lose access to the repo. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to cancel access request for. user (`str`): The username of the user which access request should be cancelled. repo_type (`str`, *optional*): The type of the repo to cancel access request for. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. `HTTPError`: HTTP 404 if the user does not exist on the Hub. `HTTPError`: HTTP 404 if the user access request cannot be found. `HTTPError`: HTTP 404 if the user access request is already in the pending list. rrN_handle_access_requestrrrSrrcrrrcancel_access_request s#zHfApi.cancel_access_requestcCr)a Accept an access request from a user for a given gated repo. Once the request is accepted, the user will be able to download any file of the repo and access the community tab. If the approval mode is automatic, you don't have to accept requests manually. An accepted request can be cancelled or rejected at any time using [`cancel_access_request`] and [`reject_access_request`]. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to accept access request for. user (`str`): The username of the user which access request should be accepted. repo_type (`str`, *optional*): The type of the repo to accept access request for. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. `HTTPError`: HTTP 404 if the user does not exist on the Hub. `HTTPError`: HTTP 404 if the user access request cannot be found. `HTTPError`: HTTP 404 if the user access request is already in the accepted list. rrNrrrrraccept_access_request: %zHfApi.accept_access_requestcCr)a Reject an access request from a user for a given gated repo. A rejected request will go to the rejected list. The user cannot download any file of the repo. Rejected requests can be accepted or cancelled at any time using [`accept_access_request`] and [`cancel_access_request`]. A cancelled request will go back to the pending list while an accepted request will go to the accepted list. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to reject access request for. user (`str`): The username of the user which access request should be rejected. repo_type (`str`, *optional*): The type of the repo to reject access request for. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. `HTTPError`: HTTP 404 if the user does not exist on the Hub. `HTTPError`: HTTP 404 if the user access request cannot be found. `HTTPError`: HTTP 404 if the user access request is already in the rejected list. rrNrrrrrreject_access_requesta rzHfApi.reject_access_requestcCs`|tvr tdt|durt}tjtd|d|d|j|d||dd}t|dS)NrQrrz/user-access-request/handlero)rSrr.)rIrrHrirrErsrj)rrrSrrrcrrrrrr s   zHfApi._handle_access_requestcCs\|tvr tdt|durt}tjtd|d|j|dd|id}t||S)a Grant access to a user for a given gated repo. Granting access don't require for the user to send an access request by themselves. The user is automatically added to the accepted list meaning they can download the files You can revoke the granted access at any time using [`cancel_access_request`] or [`reject_access_request`]. For more info about gated repos, see https://huggingface.co/docs/hub/models-gated. Args: repo_id (`str`): The id of the repo to grant access to. user (`str`): The username of the user to grant access. repo_type (`str`, *optional*): The type of the repo to grant access to. Must be one of `model`, `dataset` or `space`. Defaults to `model`. token (`str`, *optional*): A valid authentication token (see https://huggingface.co/settings/token). Raises: `HTTPError`: HTTP 400 if the repo is not gated. `HTTPError`: HTTP 400 if the user already has access to the repo. `HTTPError`: HTTP 403 if you only have read-only access to the repo. This can be the case if you don't have `write` or `admin` role in the organization the repo belongs to or if you passed a `read` token. `HTTPError`: HTTP 404 if the user does not exist on the Hub. rQNrz/user-access-request/grantrorSr.) rIrrHrirrErsrjrt)rrrSrrcrrrrr grant_access s# zHfApi.grant_accessis_write_actionDict[str, str]cCs6|dur|j}t|||p|j|p|j|p|j|jdS)z Alias for [`build_hf_headers`] that uses the token from [`HfApi`] client when `token` is not provided. N)rcrrrerfrh)rcrfrrerfrh)rrcrrrerfrrrrs s zHfApi._build_hf_headersList[CommitOperationDelete]csx|durgS|j||||d}r&dvr&ddfdd|Dndd|Dfdd t|d DS) aGenerate the list of Delete operations for a commit to delete files from a repo. List remote files and match them against the `delete_patterns` constraints. Returns a list of [`CommitOperationDelete`] with the matching items. Note: `.gitattributes` file is essential to make a repo work properly on the Hub. This file will always be kept even if it matches the `delete_patterns` constraints. Nr)rz./rcs(i|]}|r|td|qSr)rrrrrrrr'!s  z:HfApi._prepare_upload_folder_deletions..cSsi|]}||qSrrrrrrr'!rcs(g|]}|dkrt|ddqS)z.gitattributesFr)r!rrelpath)relpath_to_abspathrrr !s  z:HfApi._prepare_upload_folder_deletions..)r)rr*rhr)rrrrrcrr filenamesr)rrrr s   z&HfApi._prepare_upload_folder_deletions)NNNNNN)rr|rcrdrr|rer|rfrgrhrir}r)rVrkr}rlr)rcr|r}r)rcr|r}rx)r}r)&rrrr|rrrrrr|rrrrrrrr|rrrrrrrrrrrrrrrcrrr|r}r)rrs)"rrrr|rrrr|rrrrrrrrrrrrrr|rrrrrrrrrcr|r}r)rrr)r}r)rrrr|rr|rrrrrrr&rr%rrrrrrcr|r}r)rrzrcr|rr|r}r)rSr|rcr|r}rR)rrzrr|rcr|r}r)rrzrr|rrrrrrrcrr}r) rrzrr|rrrrrcrr}r) rrzrr|rrrrrcrr}r )rrzrr|rr|rrrrrcrr}r)rrzrr|rcr|r}r) rrzrrzrr|rcr|r}r) rrzrrzrr|rr|rcrdr}r)rrzrrrrrr|rr|rcrr}r) rrzrr|rr|rcrr}r)rrzrr|rrrrrr|rr|rcrr}r) rrzrr|rrrcrr}rH) rrzrr|rcrrr|rrr}r )rrzrr rrrr|rr|rcrr}r ) rrzrr|rr|rr|rcr|r}r)rrzrcr|rrrr|rrrr|rrrrrrrrrrr}r) rrzrcr|rr|r:rr}r)F)rrzrrrcr|rr|rr|rDr|r}r<)r?rzr@rzrr|rcr|)rrzrGrHrrzrr|rcr|rr|rr|rDrrErrFr|rWrIr}r)rrzrGrHrrzrr|rcr|rr|rr|rDrrErrFr|rWrNr}rO)rrzrGrHrrzrr|rcr|rr|rr|rDrrErrFr|rWrr}rP)rrzrtrurvrwrrzrr|rcr|rr|rrrrErrsrr}rz)rrzr^rrcr|rr|rr|rDrrErr_rrr|)rrrrzrrzrcr|rr|rr|rr|rr|rDrrFr|rWrIr}r)rrrrzrrzrcr|rr|rr|rr|rr|rDrrFr|rWrNr}rO)rrrrzrrzrcr|rr|rr|rr|rr|rDrrFr|rWrr}rP)"rrzrrrr|rr|rr|rcr|rr|rr|rDrrFr|rrrrrrrrIrrrWrIr}r)"rrzrrrr|rr|rr|rcr|rr|rr|rDrrFr|rrrrrrrrNrrrWrIr}rz)"rrzrrrr|rr|rr|rcr|rr|rr|rDrrFr|rrrrrrrrIrrrWrNr}rO)"rrzrrrr|rr|rr|rcr|rr|rr|rDrrFr|rrrrrrrrNrrrWrNr}r)"rrzrrrr|rr|rr|rcr|rr|rr|rDrrFr|rrrrrrrrrrrWrr}r)rrzrrzrcr|rr|rr|rr|rr|rDrrFr|r}r) rrzrcrrrrrr}rR)"rrzrrzrr|rr|rr|rrrrrrrrrr|rrrrrrrcrrrrrr}rz)"rrzrr|rr|rrrrrrrrrrrrrrrcrrrrrrrrmrrrr}rz) rrzrr|rr|rcr|r}rd) rrzrrzrr|rr|rcr|r}rb)rrzrrzrr|rcr|rr|rrr}r) rrzrrzrcr|rr|r}r)rrzr rzrr|rr|rcr|rr|rrr}r) rrzr rzrcr|rr|r}r)rrzrr|rcr)rrzrr|rrrrrr|rcr|r}r) rrzrrrr|rcr|r}r<)rrzrrzrcr|r)r|rr|r)rr}r<) rrzrrzrcr|r)r|rr|r}r<)rrzrrr.rzr-r/rcr|rr|r}r0) rrzrrrrzrcr|rr|r}r9) rrzrrrrzrcr|rr|r}r;)rrzrrrr6rcr|rr|rr|r}r:) rrzrrrcr|rr|rr|)rrzrrrrzrrzrcr|rr|r}r9) rrzrrrrzrcr|rr|r}r9) rrzr*rzrZrzr)r|rcr|r}r)rrzr*rzrcr|r}r)rrzrcr|r}rC) rrzr*rzrZrzr)r|rcr|r}rC)rrzr*rzrcr|r}rC)rrzrcr|r}r5) rrzrr4rcr|rMrr}r5)rrzrMrrcr|r}r5)rrzrcr|rVrr}r5)r?rzr@r|rrrcr|rrrrrZrrMrr!rr"rr}r)rrzrZr6rcr|r}r5)rr|rcr|r}r`)$rDrzr[rzrlrzrmrzrnrzrorzrprzrqrzrhr|rirrjrrr|rr|rkrr2r(rr|rcr|r}r')rDrzrr|rcr|r}r')rDrzrmr|rnr|ror|rirrjrr[r|rlr|rr|rr|rr|rcr|r}r')rDrzrr|rcr|r}r)rcr|r}rz) r7rr?rrrrrrcrr}r)rrzrcr|r}r5)rrzrr|r)r|rrrrrcr|r}r5)rrzrr|r)r|r/rrrr:r|rcr|r}r5)rrzr:rrcr|r}r)rrzr-rzr.r3r0r|rrrcr|r}r5) rrzr,rzr0r|r/rrcr|r}r) rrzr,rzr:rrcr|r}r)rrzrr|rcr|r}rr) rrzrrrr|rcr|r}r) rrzrSrzrr|rcr|r}r) rrzrSrzrrrr|rcr|r}r)NFNNN) rcrrrrr|rer|rfrgr}r)rrzrr|rr|rcr|rrzrrr}r)trrrrrWrnrwrzr~rrrrrrrrrrrrrrrrrrrprrrrr r rr9r;ror>rBrrLrargrrorrrrrArSr@rrrrrrr r rrrr+r,r2rrrrrr<r@rBrHrIrJrLrPrRrUrYr\r^r_rer(Z PROTECTEDrzr|rrrrrrfrrrrrrrrrrrrrrrrrrsrrrrrrbs6 )(    @1 1 ) V/.J1C>>C+.9 7#GUKT.@>z1%W@))~dB0F-%hKX?KBJ48<1-#*r# B1Z! 7(EB,T75<:>$&&5rbrrrrrrList[CommitOperationAdd]cs~tstddfddtdD|r,|ddndfdd t ||d DS) zGenerate the list of Add operations for a commit to upload a folder. Files not matching the `allow_patterns` (allowlist) and `ignore_patterns` (denylist) constraints are discarded. zProvided path: 'z' is not a directorycs$i|]}|r||qSr)is_file relative_toas_posix)rr)rrrr'"!s z4_prepare_upload_folder_additions..z**/*rrcs g|] }t||dqS)r)rr)prefixrrrr+!sz4_prepare_upload_folder_additions..r) r expanduserresolveis_dirrsortedglobr*rhr)rrrrr)rrrrr!s     rrcCs2tt|}|durtd|dd|dS)zSafely parse revision number from a PR url. Example: ```py >>> _parse_revision_from_pr_url("https://huggingface.co/bigscience/bloom/discussions/2") "refs/pr/2" ``` NzHUnexpected response from the hub, expected a Pull Request URL but got: 'rzrefs/pr/r)rmatch_REGEX_DISCUSSION_URL RuntimeError)rre_matchrrrr6!s rr)ryrzr{r|r}r~)rVrqr}rqr) rrrrzrrrrr}r)rrzr}rz( __future__rr]rtrrr1concurrent.futuresrr dataclassesrrrr functoolsr itertoolsr pathlibr typingr r rrrrrrrrrrr urllib.parserr1Zrequests.exceptionsrZ tqdm.autorZ base_tqdmZtqdm.contrib.concurrentrZ _commit_apirrr r!r"r#r$r%r&Z_inference_endpointsr'r(Z_multi_commitsr)r*r+r,r-r.r/r0r1r2r3Z _space_apir4r5r6r7Z communityr8r9r:r;r<r= constantsr>r?r@rArBrCrDrErFrGrHrIrJrKrLrMrNrOrPrQrrRrSrTZ repocard_datarUrVrWutilsrXrYrZr[r\r]r^r_r`rarbrcrdrerfrgrhrirjrkrlrmrnrZutils._deprecationrorpZ utils._typingrqZutils.endpoint_helpersrrrsrtrur3ZUSERNAME_PLACEHOLDERcompilerrprrr5rrrrrrrrzrrrrrrrrr r'r+r5rCrHrLrRrTrarbrrapirwrzrrrrrrrrrrrrr rrr rr~rrLr9r;r>rrBrrrrrrorrr r rrrrWrrrrrrr+r,rrrrrr@rBrHrIrJrLrPrRrUrYr\r^r_rerzr|rrrrrrrrrrrrrrrrrrrrrrrrs     <    , 4 Xd     [    E<"6j}">  !t $