a d8@sddlmZddlZddlZddlZddlZddlZddlZddlm Z m Z ddl m Z m Z ddlmZddlmZddlmZddlmZdd lmZmZmZmZmZmZmZmZmZmZm Z m!Z!dd l"m#Z#ddl$Z$dd l%m&Z&dd l'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-d dl.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7d dl8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCd dlDmEZEmFZFd dlGmHZHmIZImJZJmKZKmLZLmMZMd dlNmOZOmPZPmQZQmRZRmSZSmTZTmUZUmVZVd dlWmXZXmYZYmZZZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZad dlbmcZcd dldmeZemfZfmgZgd dlhmiZimjZjmkZkmlZlmmZmmnZnedZodZpeqdZre^setZuGdddZvdOddddd d!ZwGd"d#d#egd$d%Zxe Gd&d'd'ZyGd(d)d)ezZ{Gd*d+d+evZ|Gd,d-d-evZ}Gd.d/d/evZ~Gd0d1d1evZGd2d3d3evZGd4d5d5eiZGd6d7d7eiZe Gd8d9d9Ze Gd:d;d;Ze Gdd?d?Zd@d@dAdBdCZGdDdEdEZdPdFddGdGdHdIdJdKZdddLdMdNZeZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZejZdS)Q) annotationsN)FutureThreadPoolExecutor) dataclassfield)datetime)wraps)islice)Path) AnyBinaryIOCallableDictIterableIteratorListOptionalTupleTypeVarUnionoverload)quote) HTTPError)IGNORE_GIT_FOLDER_PATTERNSEntryNotFoundErrorLocalTokenNotFoundErrorRepositoryNotFoundError experimental get_session) CommitOperationCommitOperationAddCommitOperationCopyCommitOperationDeletefetch_lfs_files_to_copyfetch_upload_modesprepare_commit_payloadupload_lfs_fileswarn_on_overwriting_operations) :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) DiscussionDiscussionCommentDiscussionStatusChangeDiscussionTitleChangeDiscussionWithDetailsdeserialize_event)DEFAULT_REVISIONENDPOINTREGEX_COMMIT_OIDREPO_TYPE_MODEL REPO_TYPESREPO_TYPES_MAPPINGREPO_TYPES_URL_PREFIXESSPACES_SDK_TYPES) BadRequestErrorHfFolderHfHubHTTPErrorbuild_hf_headersfilter_repo_objectshf_raise_for_statusloggingpaginateparse_datetimevalidate_hf_hub_args)_deprecate_arguments) CallableTLiteral TypedDict)AttributeDictionary DatasetFilter DatasetTags ModelFilter ModelTags_filter_emissionsRZhf_userz.*/discussions/(\d+)$c@seZdZdZddZdS) ReprMixinz(Mixin to create the __repr__ for a classcCsLtj|jddd}d|vr6|jjdt|ddS|jjd|SdS) NwT)widthcompact z: { z z }z: )pprintpformat__dict__ __class____name__textwrapindent)selfZformatted_valuerf_/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/huggingface_hub/hf_api.py__repr__}szReprMixin.__repr__N)rb __module__ __qualname____doc__rhrfrfrfrgrYzsrYstr Optional[str]z(Tuple[Optional[str], Optional[str], str])hf_idhub_urlreturnc Cs|}tdd|dur|nt}||vo,d|v}d}||rL|t|d}|d}t|dk}|r|dd\}}||krd}t|d kr||d vr|d } n|tvrt|} d}nd} n|rPt|dkr|d d\} }}nht|d kr>|d tvr"t|d } d}|dd }n|ddd\}}d} n|d }d \}} ntd|| tvrpt| } | dkr~d} | tvrtd| 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:///r)NNz;Unable to retrieve user and repo ID from the passed HF ID: zUnknown `repo_type`: 'z' ('')) resubr= startswithlensplitrA ValueErrorr@) rnroZ input_hf_idZ is_hf_urlZ HFFS_PREFIXZ url_segmentsZis_hf_id namespacerepo_id repo_typerfrfrgrepo_type_and_id_from_hf_idsL          rc@s&eZdZUded<ded<ded<dS) BlobLfsInfointsizerlsha256 pointer_sizeN)rbrirj__annotations__rfrfrfrgrs rF)totalc@sjeZdZUdZded<ded<ded<ded<dZded <ed d Zded <ed d Zded <ddZ dS) CommitInfoaKData structure containing information about a newly created commit. Returned by [`create_commit`]. Args: 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`. rl commit_urlcommit_messagecommit_descriptionoidNrmpr_urlF)init pr_revisionpr_numcCs>|jdur.t|j|_t|jdd|_n d|_d|_dS)zPopulate pr-related fields after initialization. See https://docs.python.org/3.10/library/dataclasses.html#post-init-processing. Nrsrx)r_parse_revision_from_pr_urlrrr~rrerfrfrg __post_init__ s   zCommitInfo.__post_init__) rbrirjrkrrrrrrrfrfrfrgrs  rcsPeZdZdZddddfdd Zddddd fd d Zd d ddZZS)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. Nr rm)urlendpointcstt|||SN)superr__new__)clsrrrarfrgr@szRepoUrl.__new__None)rrrpcsht|pt|_t||jd\}}}||_||_|dur@|n |d||_|pVt|_ t ||_ dS)N)rors) r__init__r=rrr repo_namerr?rrlr)rerrrrrrrfrgrCs   zRepoUrl.__init__rlrpc Cs$d|d|jd|jd|jd S)Nz RepoUrl('z ', endpoint='z', repo_type='z ', repo_id='ry)rrrrrfrfrgrhPszRepoUrl.__repr__)N)N)rbrirjrkrrrh __classcell__rfrfrrgrs' rc@s&eZdZdZd ddddddd ZdS) RepoFilea Data structure that represents a public file inside a repo, accessible from huggingface.co Args: rfilename (str): file name, relative to the repo root. This is the only attribute that's guaranteed to be here, but under certain conditions there can certain other stuff. size (`int`, *optional*): The file's size, in bytes. This attribute is present 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 present 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 present when`files_metadata` argument of [`repo_info`] is set to `True` and the file is stored with Git LFS. It's `None` otherwise. Nrl Optional[int]rmzOptional[BlobLfsInfo] rfilenamerblobIdlfscKs:||_||_||_||_|D]\}}t|||q dSr)rrZblob_idritemssetattr)rerrrrkwargskvrfrfrgrgs zRepoFile.__init__)NNNrbrirjrkrrfrfrfrgrTs rc @sPeZdZdZddddddddddd ddddddddd d d d d Zd d ZdS) ModelInfoaC Info about a model accessible from huggingface.co Attributes: modelId (`str`, *optional*): ID of model repository. sha (`str`, *optional*): repo sha at this particular revision lastModified (`str`, *optional*): date of last commit to repo tags (`List[str]`, *optional*): List of tags. pipeline_tag (`str`, *optional*): Pipeline tag to identify the correct widget. siblings (`List[RepoFile]`, *optional*): list of ([`huggingface_hub.hf_api.RepoFile`]) objects that constitute the model. private (`bool`, *optional*, defaults to `False`): is the repo private author (`str`, *optional*): repo author config (`Dict`, *optional*): Model configuration information securityStatus (`Dict`, *optional*): Security status of the model. Example: `{"containsInfected": False}` kwargs (`Dict`, *optional*): Kwargs that will be become attributes of the class. NF) modelIdsha lastModifiedtags pipeline_tagsiblingsprivateauthorconfigsecurityStatusrmOptional[List[str]]Optional[List[Dict]]boolzOptional[Dict]c Kst||_||_||_||_||_|dur4dd|Dng|_||_||_| |_| |_ | D]\} } t || | qZdS)NcSsg|]}tfi|qSrfr.0xrfrfrg z&ModelInfo.__init__..) rrrrrrrrrrrr)rerrrrrrrrrrrrrrfrfrgrszModelInfo.__init__cCs.d|jd|j}|jr*|d|j7}|S)Nz Model Name: , Tags: z, Task: )rrrrerrfrfrg__str__szModelInfo.__str__rbrirjrkrrrfrfrfrgr|s $rc @sPeZdZdZddddddddddd dddddddddd d d d Zd d ZdS) DatasetInfoa Info about a dataset accessible from huggingface.co Attributes: id (`str`, *optional*): ID of dataset repository. sha (`str`, *optional*): repo sha at this particular revision lastModified (`str`, *optional*): date of last commit to repo tags (`List[str]`, *optional*): List of tags. siblings (`List[RepoFile]`, *optional*): list of [`huggingface_hub.hf_api.RepoFile`] objects that constitute the dataset. private (`bool`, *optional*, defaults to `False`): is the repo private author (`str`, *optional*): repo author description (`str`, *optional*): Description of the dataset citation (`str`, *optional*): Dataset citation cardData (`Dict`, *optional*): Metadata of the model card as a dictionary. kwargs (`Dict`, *optional*): Kwargs that will be become attributes of the class. NF) idrrrrrr descriptioncitationcardDatarmrrrOptional[dict]c Ks||_||_||_||_||_||_||_| |_| |_|durLdd|Dng|_ | dd| D]\} } t || | qfdS)NcSsg|]}tfi|qSrfrrrfrfrgrrz(DatasetInfo.__init__..key) rrrrrrrrrrpoprr)rerrrrrrrrrrrrrrfrfrgrs zDatasetInfo.__init__cCsd|jd|j}|S)NzDataset Name: r)rrrrfrfrgrszDatasetInfo.__str__rrfrfrfrgrs$ rc@s8eZdZdZdddddddddddddddd ZdS) SpaceInfoa Info about a Space accessible from huggingface.co This is a "dataclass" like container that just sets on itself any attribute passed by the server. Attributes: id (`str`, *optional*): id of space sha (`str`, *optional*): repo sha at this particular revision lastModified (`str`, *optional*): date of last commit to repo siblings (`List[RepoFile]`, *optional*): list of [`huggingface_hub.hf_api.RepoFIle`] objects that constitute the Space private (`bool`, *optional*, defaults to `False`): is the repo private author (`str`, *optional*): repo author kwargs (`Dict`, *optional*): Kwargs that will be become attributes of the class. NF)rrrrrrrmrrc Ks\||_||_||_|dur(dd|Dng|_||_||_|D]\}} t||| qBdS)NcSsg|]}tfi|qSrfrrrfrfrgr%rz&SpaceInfo.__init__..)rrrrrrrr) rerrrrrrrrrrfrfrgrs zSpaceInfo.__init__rrfrfrfrgrsrc@s4eZdZdZddddddddddZddZdS) MetricInfozC Info about a public metric accessible from huggingface.co N)rrrrmcKs@||_||_||_|dd|D]\}}t|||q&dS)Nr)rrrrrr)rerrrrrrrfrfrgr1s  zMetricInfo.__init__cCsd|j}|S)Nz Metric Name: rrrfrfrgrCs zMetricInfo.__str__rrfrfrfrgr,s rcs0eZdZdZd ddfdd ZddZZS) ModelSearchArgumentsa A nested namespace object holding all possible values for properties of models currently hosted in the Hub with tab-completion. If a value starts with a number, it will only exist in the dictionary Example: ```python >>> args = ModelSearchArguments() >>> args.author.huggingface 'huggingface' >>> args.language.en 'en' ``` `ModelSearchArguments` is a legacy class meant for exploratory purposes only. Its initialization requires listing all models on the Hub which makes it increasingly slower as the number of repos on the Hub increases. NOptional['HfApi']apics6|dur |nt|_|j}t||dSr)HfApi_apiget_model_tagsrr_process_modelsrerrrrfrgrcs  zModelSearchArguments.__init__cCsddddd}|j}tt}}|D]>}d|jvrX|jd\}}||||<n|j}||||<q,||d<||d<dS)Nrl)srpcSs|ddddddSN rq-_.replacerrfrfrgcleanjsz3ModelSearchArguments._process_models..cleanrs model_namer)r list_modelsrRrr~)rermodels author_dictZmodel_name_dictmodelrnamerfrfrgris  z$ModelSearchArguments._process_models)NrbrirjrkrrrrfrfrrgrHsrcs0eZdZdZd ddfdd ZddZZS) DatasetSearchArgumentsa A nested namespace object holding all possible values for properties of datasets currently hosted in the Hub with tab-completion. If a value starts with a number, it will only exist in the dictionary Example: ```python >>> args = DatasetSearchArguments() >>> args.author.huggingface 'huggingface' >>> args.language.en 'language:en' ``` `DatasetSearchArguments` is a legacy class meant for exploratory purposes only. Its initialization requires listing all datasets on the Hub which makes it increasingly slower as the number of repos on the Hub increases. Nrrcs6|dur |nt|_|j}t||dSr)rrget_dataset_tagsrrrrrrfrgrs  zDatasetSearchArguments.__init__cCs~dddd}|j}tt}}|D]>}d|jvrV|jd\}}||||<n|j}||||<q*||d<||d<dS)NrlrcSs|ddddddSrrrrfrfrgrsz5DatasetSearchArguments._process_models..cleanrs dataset_namer)r list_datasetsrRrr~)rerdatasetsrZdataset_name_dictdatasetrrrfrfrgrs  z&DatasetSearchArguments._process_models)Nrrfrfrrgrzsrc@s:eZdZUdZded<ded<ded<dddd d Zd S) GitRefInfoa Contains information about a git reference for a repo on the Hub. Args: 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"`) rlrref target_commitrrdatarpcCs"|d|_|d|_|d|_dS)NrrZ targetCommit)rrrrerrfrfrgrs  zGitRefInfo.__init__Nrbrirjrkrrrfrfrfrgrs  rc@s*eZdZUdZded<ded<ded<dS)GitRefsa_ Contains information about all git references for a repo on the Hub. Object is returned by [`list_repo_refs`]. Args: 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. zList[GitRefInfo]branchesconvertsrNrbrirjrkrrfrfrfrgrs rc@sZeZdZUdZded<ded<ded<ded<ded <d ed <d ed <d ddddZdS) GitCommitInfoao Contains information about a git commit for a repo on the Hub. Check out [`list_repo_commits`] for more details. Args: 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. rl commit_id List[str]authorsr created_attitlemessagermformatted_titleformatted_messagerrrcCsl|d|_dd|dD|_t|d|_|d|_|d|_|did|_|did|_dS) NrcSsg|] }|dqS)userrf)rrrfrfrgrrz*GitCommitInfo.__init__..rdaterr formatted) rrrLrrrgetrrrrfrfrgrs   zGitCommitInfo.__init__Nrrfrfrfrgrs rc@s:eZdZUdZded<ded<ded<ded<ded <d S) UserLikesa Contains information about a user likes on the Hub. Args: 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). rlrrrrrrspacesNrrfrfrfrgr s r rOfnrpcs<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<n(d}t|D]\}}|dkr(|}qBq(|r`|j|g|Ri|S|g|Ri|S)N run_as_futureF)zipr)reargsrrparamvalueZ args_paramsrrfrg_inner*s z!future_compatible.._innerT)inspect signaturelist parametersrZis_future_compatible)rsigrrfrrgfuture_compatible!s  rc@sl eZdZddddddddddZdd d d d Zeddd dddZddddddZddddZddddZ edddddddddddd dddddd d!d"d#d#d$d%d& d'd(Z d)d*d+d,Z eddddddddd-d.dddd d!d"dd/d0 d1d2Z d3d4d5d6Z d7dd8d9Zedddddddddddd: d;dddd d!d;d;d#d"ddd?Zeddd@dAddddBdCdDZeddd@dAddddBdEdFZedddGdddHdIdJdKZeddddddLdAddMd"d#d$dNdOdPdQZedddddRdAddMd#d$dSdTdUdVZedddddRdAddMd#d$dWdTdXdYZeddddddZdAdddMd#d$d[d\d]d^Zedddddd_dAd`d#ddd$dadbdcddZededfgdgdhedddddidAdddMd$djdkdldmZedddndAdd$dodpdqdrZedddddsdAdd$dd#dtdudvdwZedddddddxdAdd#dd#dddydzd{d|Zeddd@dAddd}d~dZedddddddAd#ddddddddZdddndAdAdddddZe ddddddddddAddAddddd"ddddd ddZ!e ddddddddddAddAddddd"ddddd ddZ!ee"ddddddddddAddAddddd"ddd#dd ddZ!e#eddddddddAdddAdddd#dd#dAd ddZ$e dddddddddddAdAdddddd"dddAd ddZ%e dddddddddddAdAdddddd"dddd ddZ%ee"dddddddddddAdAdddddd"dd#dd ddZ%e ddddddddddddddddAdddddddd"ddddd#d#ddAdddZ&e ddddddddddddddddAdddddddd"ddddd#d#dddddZ&ee"ddddddddddddddddAdddddddd"ddddd#d#d#ddddZ&edddddddddAdAdddddd"ddd ddZ'edddddddddAdAdddddd"ddd ddZ(eddddddAdAdddd#ddddZ)eddd@dAdAddddddZ*edddddddAdAddddd#ddddZ+eddd@dAdAdddddd„Z,edddÜdAdd$dĜddƄZ-edddndAddddpddɄZ.edddndAddddd˜dd̈́Z/edddddΜdAdAdddd#ddϜddфZ0eddddҜdAdAdddddӜddՄZ1dddd֜dAddAdddddٜddۄZ2eddd@dAddAddddݜdd߄Z3eddd@dAddAddddddZ4edddddAdddddddddZ5edddddAdddddddZ6eddd@dAddAdAddddddZ7eddd@dAddAddddddZ8eddGdAdAdAdddddZ9eddGdAdAdddddZ:eddGdAdddddZ;eddddAddd!ddddZeddGdAdddddZ?eddddd dAdd"dd#dyd d d Z@dd$d#dddd dddZAdAddddAdddddZBdS(rNrmzUnion[Dict, str, None]r)rtoken library_namelibrary_version user_agentrpcCs4|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: endpoint (`str`, *optional*): Hugging Face Hub base url. Will default to https://huggingface.co/. To be set if you are using a private hub. Otherwise, one can set the `HF_ENDPOINT` environment variable. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. 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. N)r=rrrrr  _thread_pool)rerrrrr rfrfrgrCs !zHfApi.__init__zCallable[..., R]z Future[R]rcOs6|jdurtdd|_|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)r!rZsubmit)rerrrrfrfrgrks#  zHfApi.run_as_futurer)rrpc Csntj|jd|j|p |jp ddd}z t|Wn.tyd}ztd|WYd}~n d}~00|S)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-v2TrheaderszInvalid 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.N)rr r_build_hf_headersrrIrjson)rerrerfrfrgwhoamis    z HfApi.whoamizLiteral['read', 'write', None]c Cs8z|j|ddddWSttfy2YdS0dS)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. r#authZ accessTokenroleN)r)rr)rerrfrfrgget_token_permissionszHfApi.get_token_permissionrVrcCs0|jd}t|}t||}t|S)zH List all valid model tags as a nested namespace object z/api/models-tags-by-type)rrr rIr'rVrepathrdrfrfrgrs   zHfApi.get_model_tagsrTcCs0|jd}t|}t||}t|S)zK List all valid dataset tags as a nested namespace object. z/api/datasets-tags-by-type)rrr rIr'rTr-rfrfrgrs   zHfApi.get_dataset_tagsF) filterrsearchemissions_thresholdssort directionlimitfullr fetch_configrz,Union[ModelFilter, str, Iterable[str], None]zOptional[Tuple[float, float]]z)Union[Literal['lastModified'], str, None]zOptional[Literal[-1]]rzOptional[bool]rzOptional[Union[bool, str]]zIterable[ModelInfo]) r0rr1r2r3r4r5r6rr7rrpc cs|dur| durtd|jd} |j| d} i}|durnt|trR||}n|d|i|ddi|dur|d|i|dur|d |i|dur|d |i|dur|d |i|dur|d |i|dur |r|ddind|vr |d=| r|d di| r2|ddit| || d}|durTt||}|durnt |g|R}|D]}t fi|VqrdS)a3 List models hosted on the Huggingface Hub, given some filters. Args: filter ([`ModelFilter`] or `str` or `Iterable`, *optional*): A string or [`ModelFilter`] which can be used to identify models on the Hub. author (`str`, *optional*): A string which identify the author (user or organization) of the returned models search (`str`, *optional*): A string that will be contained in the returned model ids. emissions_thresholds (`Tuple`, *optional*): A tuple of two ints or floats representing a minimum and maximum carbon footprint to filter the resulting models with in grams. sort (`Literal["lastModified"]` or `str`, *optional*): The key with which to sort the resulting models. Possible values are the properties of the [`huggingface_hub.hf_api.ModelInfo`] 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 models fetched. Leaving this option to `None` fetches all models. full (`bool`, *optional*): Whether to fetch all model data, including the `lastModified`, the `sha`, the files and the `tags`. This is set to `True` by default when using a filter. cardData (`bool`, *optional*): Whether to grab the metadata for the model as well. Can contain useful information such as carbon emissions, metrics, and datasets trained on. fetch_config (`bool`, *optional*): Whether to fetch the model configs as well. This is not included in `full` due to its size. 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[ModelInfo]`: an iterable of [`huggingface_hub.hf_api.ModelInfo`] objects. Example usage with the `filter` argument: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> # List all models >>> api.list_models() >>> # Get all valid search arguments >>> args = ModelSearchArguments() >>> # List only the text classification models >>> api.list_models(filter="text-classification") >>> # Using the `ModelFilter` >>> filt = ModelFilter(task="text-classification") >>> # With `ModelSearchArguments` >>> filt = ModelFilter(task=args.pipeline_tags.TextClassification) >>> api.list_models(filter=filt) >>> # Using `ModelFilter` and `ModelSearchArguments` to find text classification in both PyTorch and TensorFlow >>> filt = ModelFilter( ... task=args.pipeline_tags.TextClassification, ... library=[args.library.PyTorch, args.library.TensorFlow], ... ) >>> api.list_models(filter=filt) >>> # List only models from the AllenNLP library >>> api.list_models(filter="allennlp") >>> # Using `ModelFilter` and `ModelSearchArguments` >>> filt = ModelFilter(library=args.library.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/modelsr#r0r6Trr1r3r4r5rrparamsr%) rrr& isinstancerU_unpack_model_filterupdaterKr rWr)rer0rr1r2r3r4r5r6rr7rr.r%r9ritemrfrfrgrsHl         zHfApi.list_modelsrU) model_filtercCsjd}g}|jdur|jd}|jdur2||j7}g}|jdur`|t|jtrX|jgn|j|jdurt|jttfs|jg|_|jD] }d|vrd|}| |q|j r|t|j tr|j gn|j |j r|t|j tr|j gn|j i}|dur||d<t |dkr$||d<t|j tr@||j nt|j trZ| |j t||d<|S) zU Unpacks a [`ModelFilter`] into something readable for `list_models` rqNrszdataset:r1rrr0)rrZtaskextendr:rlZtrained_datasetrtupleappendZlibraryrr}language)rer>Z model_strr filter_listr query_dictrfrfrgr;ksB               zHfApi._unpack_model_filter)r0rr1r3r4r5r6rz.Union[DatasetFilter, str, Iterable[str], None]zIterable[DatasetInfo]) r0rr1r3r4r5r6rrpccs|jd} |j|d} i} |durHt|tr:||} n| d|i|dur^| d|i|durt| d|i|dur| d|i|dur| d|i|dur| d |i|r| d d it| | | d } |durt| |} | D]} tfi| VqdS) a 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. search (`str`, *optional*): A string that will be contained in the returned datasets. sort (`Literal["lastModified"]` or `str`, *optional*): The key with which to sort the resulting datasets. Possible values are the properties of the [`huggingface_hub.hf_api.DatasetInfo`] 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 datasets fetched. Leaving this option to `None` fetches all datasets. full (`bool`, *optional*): Whether to fetch all dataset data, including the `lastModified` and the `cardData`. Can contain useful information such as the PapersWithCode ID. 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[DatasetInfo]`: an iterable of [`huggingface_hub.hf_api.DatasetInfo`] objects. Example usage with the `filter` argument: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> # List all datasets >>> api.list_datasets() >>> # Get all valid search arguments >>> args = DatasetSearchArguments() >>> # List only the text classification datasets >>> api.list_datasets(filter="task_categories:text-classification") >>> # Using the `DatasetFilter` >>> filt = DatasetFilter(task_categories="text-classification") >>> # With `DatasetSearchArguments` >>> filt = DatasetFilter(task=args.task_categories.text_classification) >>> api.list_models(filter=filt) >>> # List only the datasets in russian for language modeling >>> api.list_datasets( ... filter=("language:ru", "task_ids:language-modeling") ... ) >>> # Using the `DatasetFilter` >>> filt = DatasetFilter(language="ru", task_ids="language-modeling") >>> # With `DatasetSearchArguments` >>> filt = DatasetFilter( ... language=args.language.ru, ... task_ids=args.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/datasetsr#Nr0rr1r3r4r5r6Tr8) rr&r:rS_unpack_dataset_filterr<rKr r)rer0rr1r3r4r5r6rr.r%r9rr=rfrfrgrs0_     zHfApi.list_datasetsrS)dataset_filterc Csd}|jdur|jd}|jdur.||j7}g}gd}|D]Z}t||}|dur>t|ttfsh|g}|D]*}|d|vr|d|}||qlq>i}|dur||d<t||d<|S)zY Unpacks a [`DatasetFilter`] into something readable for `list_datasets` rqNrs)Z benchmarkZlanguage_creatorsrBZmultilingualityZsize_categoriesZtask_categoriesZtask_ids:r1r0)rrgetattrr:rr@rA) rerFZ dataset_strrCZdata_attributesattrZ curr_attrrrDrfrfrgrEs*       zHfApi._unpack_dataset_filterzList[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/metricscSsg|]}tfi|qSrf)rrrfrfrgrMrz&HfApi.list_metrics..)rrr rIr'r-rfrfrg list_metricsBs   zHfApi.list_metrics) r0rr1r3r4r5rrlinkedr6rzUnion[str, Iterable[str], None]zIterable[SpaceInfo]) r0rr1r3r4r5rrrKr6rrpc cs2|jd} |j| d} i}|dur2|d|i|durH|d|i|dur^|d|i|durt|d|i|dur|d|i|dur|d |i| r|d d i| r|d d i|dur|d |i|dur|d|it| || d}|durt||}|D]}tfi|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["lastModified"]` 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 `lastModified` and the `cardData`. 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/spacesr#Nr0rr1r3r4r5r6TrKrrr8)rr&r<rKr r)rer0rr1r3r4r5rrrKr6rr.r%r9rr=rfrfrg list_spacesOs87    zHfApi.list_spaces)rrrl)rrrrpcCsD|dur t}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//liker#rr%)r?rpostrr&rIrerrrresponserfrfrglikes( z HfApi.likecCsD|dur t}tj|jd|d|d|j|dd}t|dS)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 ``` NrMrNrOr#rP)r?rdeleterr&rIrRrfrfrgunlikes ( z HfApi.unliker#r )rrrpcCs|dur2|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", ...] ``` Nr#typerrzVCannot list liked repos. You must provide a 'user' as input or be logged in as a user.z /api/users/z/likesr8cSs(g|] }|dddkr|ddqS)reporWrrrfrrTrfrfrgrIrz*HfApi.list_liked_repos..cSs(g|] }|dddkr|ddqS)rXrWrrrfrYrfrfrgrJrcSs(g|] }|dddkr|ddqS)rXrWspacerrfrYrfrfrgrKr)rrrrr )r)rrr&rrKr r})rerrmer.r%Zlikesrfrfrglist_liked_reposs"-        zHfApi.list_liked_repos)revisiontimeoutrfiles_metadatarzOptional[float]r)rr]r^rr_rrpc Cs|j|d}|dur$|jd|n|jd|dt|dd}i} |rRd| d<|r^d| d <tj|||| d } t| | } tfi| 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. r#Nz /api/models/ /revision/rqsafeTrblobsr%r^r9)r&rrrr rIr'r) rerr]r^rr_rr%r.r9rr/rfrfrg model_infoNs4 zHfApi.model_info)r]r^r_rr)rr]r^r_rrpc Cs|j|d}|dur$|jd|n|jd|dt|dd}i}|rRd|d<tj||||d } t| | } tfi| 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. r#Nz/api/datasets/r`rqraTrcrd)r&rrrr rIr'r rerr]r^r_rr%r.r9rr/rfrfrg dataset_infos0 zHfApi.dataset_inforc Cs|j|d}|dur$|jd|n|jd|dt|dd}i}|rRd|d<tj||||d } t| | } tfi| S) 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. r#N /api/spaces/r`rqraTrcrd)r&rrrr rIr'rrfrfrfrg space_infos0 zHfApi.space_info)r]rr^r_rz(Union[ModelInfo, DatasetInfo, SpaceInfo])rr]rr^r_rrpcCsR|dus|dkr|j}n(|dkr(|j}n|dkr8|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. NrrrZzUnsupported repo type.)r]rr^r_)rergrir)rerr]rr^r_rmethodrfrfrg repo_infos4zHfApi.repo_info)expandr]rrzUnion[List[str], str, None]zIterable[RepoFile])rpathsrlr]rrrpc csZ|pt}|durt|ddnt}|j|d}ddddd }g} |durT| dn|gkr`dStj|jd |d |d |t|t r|n|gd d|d} t | | } | D]*} | ddkr|| Vq| | dq| D]p} | rdt| ddnd}|jd |d |d||}t ||d |ddD]}|ddkr4||Vq4qdS)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: {"blob_id": "43bd404b159de6fba7c2f4d3264347668d43af25", "lfs": None, "rfilename": "README.md", "size": 391}, RepoFile: {"blob_id": "2f9618c3a19b9a61add74f70bfb121335aeef666", "lfs": None, "rfilename": "config.json", "size": 554}, ] ``` 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: { {'blob_id': '815004af1a321eaed1d93f850b2e94b0c0678e42', 'lastCommit': {'date': '2023-03-21T09:05:27.000Z', 'id': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)'}, 'lfs': None, 'rfilename': 'model_index.json', 'security': {'avScan': {'virusFound': False, 'virusNames': None}, 'blobId': '815004af1a321eaed1d93f850b2e94b0c0678e42', 'name': 'model_index.json', 'pickleImportScan': None, 'repositoryId': 'models/prompthero/openjourney-v4', 'safe': True}, 'size': 584} }, RepoFile: { {'blob_id': 'd2343d78b33ac03dade1d525538b02b130d0a3a0', 'lastCommit': {'date': '2023-03-21T09:05:27.000Z', 'id': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)'}, 'lfs': {'pointer_size': 134, 'sha256': 'dcf4507d99b88db73f3916e2a20169fe74ada6b5582e9af56cfa80f5f3141765', 'size': 334711857}, 'rfilename': 'vae/diffusion_pytorch_model.bin', 'security': {'avScan': {'virusFound': False, 'virusNames': None}, 'blobId': 'd2343d78b33ac03dade1d525538b02b130d0a3a0', 'name': 'vae/diffusion_pytorch_model.bin', 'pickleImportScan': {'highestSafetyLevel': 'innocuous', 'imports': [{'module': 'torch._utils', 'name': '_rebuild_tensor_v2', 'safety': 'innocuous'}, {'module': 'collections', 'name': 'OrderedDict', 'safety': 'innocuous'}, {'module': 'torch', 'name': 'FloatStorage', 'safety': 'innocuous'}]}, 'repositoryId': 'models/prompthero/openjourney-v4', 'safe': True}, 'size': 334711857} }, (...) ] ``` List LFS files from the "vae/" folder in "stabilityai/stable-diffusion-2" repository. ```py >>> from huggingface_hub import list_files_info >>> [info.rfilename 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.rfilename for info in list_files_info("glue", repo_type="dataset")] ['.gitattributes', 'README.md', 'dataset_infos.json', 'glue.py'] ``` Nrqrar#rr)inforpcSsp|d}|d}|d}|dd}|dd|durXt|d|d|dd}tf||||d|S) Nr.rrrrWZ pointerSize)rrrr)rrr)rnrrrrrfrfrg_format_as_repo_files     z3HfApi.list_files_info.._format_as_repo_filerMrNz /paths-info/T)rmrl)rr%rWfiler.rs/tree/) recursiverl)r.r%r9) r?rr<r&rArrQrr:rrIr'rK)rerrmrlr]rrr%roZ folder_pathsrSZ paths_infoZ path_infor.Z encoded_pathZtree_urlZ subpath_inforfrfrglist_files_infoTs:      zHfApi.list_files_infoz0.17r^ztimeout is not used anymore.)versionZdeprecated_argsZcustom_message)r]rr^rr)rr]rr^rrpcCsdd|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|] }|jqSrf)r)rfrfrfrgr)sz)HfApi.list_repo_files..N)rrmr]rr)rs)rerr]rr^rrfrfrglist_repo_files s  zHfApi.list_repo_files)rrr)rrrrpcCs||pt}tj|jd|d|d|j|dd}t||}tdd|dDd d|d Dd d|d Dd S)a6 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`. 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. rMrNz/refsr#r$cSsg|] }t|qSrfrrr=rfrfrgrgrz(HfApi.list_repo_refs..rcSsg|] }t|qSrfrwrxrfrfrgrhrrcSsg|] }t|qSrfrwrxrfrfrgrirr)rrr)r?rr rr&rIr'r)rerrrrSrrfrfrglist_repo_refs0s0 zHfApi.list_repo_refs)rrr]r zList[GitCommitInfo])rrrr]r rpc Csd|pt}|durt|ddnt}ddt|jd|d|d||j|d |rXd 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. NrqracSsg|] }t|qSrf)rrxrfrfrgrsz+HfApi.list_repo_commits..rMrNz /commits/r#zexpand[]r )r%r9)r?rr<rKrr&)rerrrr]r rfrfrglist_repo_commitslsA zHfApi.list_repo_commits)rrrexist_ok space_sdkspace_hardwarer)rrrrr{r|r}rpc Cs d|vr|dnd|f\}} |jd} |tvr:td| ||d} |durV|| d<|dkr|durvtdtd |tvrtd td || d <|dur|dkrtd |dur|dkr|| d<n tdt|ddr|j| d<|j |dd} t j | | | d} z t | Wnt y}z|r>|jjdkr>n|r|jjdkrzn|j|||d|dusx|tkrt|jd|WWYd}~St|jd|d|WWYd}~StyYn0nWYd}~n d}~00| }t|d|jdS)a$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. Returns: [`RepoUrl`]: URL to the newly created repo. Value is a subclass of `str` containing attributes like `endpoint`, `repo_type` and `repo_id`. rsNz/api/repos/createInvalid repo type)r organizationrrWrZzDNo 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 rZsdkz=Ignoring provided space_sdk because repo_type is not 'space'.hardwarezBIgnoring provided space_hardware because repo_type is not 'space'._lfsmultipartthreshZlfsmultipartthreshTris_write_actionr%r'irrrrr)r~rr@rrCwarningswarnrHrr&rrQrIrrS status_coderkr?rrFr')rerrrrr{r|r}rrr.r'r%rerrr/rfrfrg create_reposV%        "( zHfApi.create_repo)rrrc Csd|vr|dnd|f\}}|jd}|tvr:td||d}|durT||d<|j|dd}tj|||d } t| dS) aP 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. 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. rsNz/api/repos/deleter~)rrrWTrr)r~rr@rr&rrUrI) rerrrrrr.r'r%rrfrfrg delete_repo s  zHfApi.delete_repo)rrrrzDict[str, bool])rrrrrrrpc Cs|tvrtdd|vr"|dnd|f\}}|durF||d}n|}|durVt}tj|jd|d|d|d|j|dd d |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. r~rsNrrMrNz /settingsTrrrr%r') r@rr~r)r?rputrr&rIr') rerrrrrrrrrfrfrgupdate_repo_visibilityF s' zHfApi.update_repo_visibility)from_idto_idrrc Cst|ddkr"td|dt|ddkrDtd|d|durPt}|||d}|jd}|j|dd }tj|||d }z t|Wn0t y} z| d WYd} ~ n d} ~ 00dS) 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. rsrvzInvalid repo_id: z6. It should have a namespace (:namespace:/:repo_name:)N)ZfromRepoZtoReporWz/api/repos/moveTrrzv For additional documentation please see https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo.) r}r~rr?rr&rrQrIrFappend_to_message) rerrrrr'r.r%rr(rfrfrg move_repo s"'   zHfApi.move_repo.)rrrr] create_pr num_threads parent_commitrzIterable[CommitOperation]rzLiteral[False]r) r operationsrrrrr]rrrrrpc CsdSrrf rerrrrrrr]rrrrrfrfrg create_commit szHfApi.create_commitz Literal[True]zFuture[CommitInfo]c CsdSrrfrrfrfrgr sz%Union[CommitInfo, Future[CommitInfo]]c  sd} | dur$t| s$tdt|dus8t|dkr@td|durL|nd}|dur\|nt}|tvrvtdt|durt|ddnt}|dur|nd }t|}d d |D} d d |D}t| }t|}t|||}t d t| dt|d|dt |z$t | |||p$|j ||j|dWn2tyf}z|| WYd}~n d}~00t||||pz|j ||jd}tfdd | D|||p|j |j| dt||||| d|jd|d|d|}ddfdd }ddi|j|dd }d!|}|r$d"d#ind}z$tj||||d$}t|d%d&Wnzty~}z|| WYd}~nRd}~0ty}z0|dkrd't|vr|d(WYd}~n d}~00|}t|d)|||d*|r|d+ndd,S)-az Creates a commit in the given repo, deleting & uploading files as needed. 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 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 the Hub API returns an HTTP 400 error (bad request) [`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. `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. 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.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.rq"Invalid repo type, must be one of raFcSsg|]}t|tr|qSrf)r:r!roprfrfrgrd rz'HfApi.create_commit..cSsg|]}t|tr|qSrf)r:r"rrfrfrgre rzAbout to commit to the hub: z addition(s), z copie(s) and z deletion(s).) additionsrrrr]rr)copiesrrrr]rcsg|]}|jdkr|qS)r path_in_repo)rZaddition) upload_modesrfrgr r)rrrrrr)rr files_to_copyrrrrMrNz/commit/zIterable[bytes]rc3s$D]}t|VdVqdS)N )r'dumpsencode)r=)commit_payloadrfrg_payload_as_ndjson sz/HfApi.create_commit.._payload_as_ndjsonz Content-Typezapplication/x-ndjsonTrrr1)rr%rr9commit)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`.Z commitUrlZ commitOidZpullRequestUrl)rrrrr)r> fullmatchrr}r?r@rr<rloggerdebugr(r%rrrrr$r'r&r&joinrrQrIrrlr'r)rerrrrrrr]rrrrZ$_CREATE_COMMIT_NO_REPO_ERROR_MESSAGErrZ nb_additionsZ nb_copiesZ nb_deletionsr(rrrr%rr9Z commit_respZ commit_datarf)rrrgr sl        T)rrrmerge_prrverbosezList[List[CommitOperationAdd]]z!List[List[CommitOperationDelete]]) raddition_commitsdeletion_commitsrrrrrrrrpc  sttd} | r| d| dt|dt|dtdd||Ddtd d |Dd d |Dd } | d | jd|j |||dD]N} | j r| j dkr| j| j vr|j || j||d}| d|jdqqt||||| ||d}| d|j|jD]}t|tr|}qFqtd|jdt|j}t|t| jkrtd|jdt|dt| jd| jD]4}||vrtd|jd|dd|dqd d!|j|||td"Dfd#d |j||||jd"D}t|d$kr*| d%t|d&t|t| jkrftd|jd't| jd(t|d)d*d+| jD}d,d+| jD}|D]D}|j |vr||j }d-|_n|j |vr||j }d-|_qt|d$krt|t| jkrtd|jd.t|t|}t|d$krF| |d/t|d0t|d1t |!t |!D]r}|j"||||j|j| |j#d2d3d-|_|d48}| d5|jd6|d7|j$||||j|jt%||| d8d9q^| d:|j&||||j|d;|j'||||jd|rz$|j)||||jt*d?| d@Wnt+y}zz|j,dAurdB|j,vr|j'||||jt-dCdD| .dEn2|j/||||jt0j1|j,dFd?tdG|j,|WYdA}~n dA}~00|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. 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. `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`]. z.create_commits_on_prINFOz Will create z deletion commit(s) and z addition commit(s), totalling css|]}t|VqdSr)r})ropsrfrfrg , rz-HfApi.create_commits_on_pr..z atomic operations.cSsg|]}t|dqSrr.rrrfrfrgr/ rz.HfApi.create_commits_on_pr..cSsg|]}t|dqSrrrrfrfrgr0 r)rrzMulti-commits strategy with ID rrZdraft)rdiscussion_numrrzPR already exists: z'. Will resume process where it stopped.)rrrstrategyrrzNew 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 z, z).cSsh|] }|jqSrfrrrrfrfrg ` sz-HfApi.create_commits_on_pr..)rrrr]csg|]}|jvr|qSrfrrZcommits_on_main_branchrfrgrf s rzFound z existing commits on the PR.z : scheduled z steps but z, commits have already been pushed to the PR.cSsi|] }|j|qSrfrrsteprfrfrg y rz.HfApi.create_commits_on_pr..cSsi|] }|j|qSrfrrrfrfrgrz 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)rrrrr]rrrrz step z completed (still z to go).)rrr)rrrr comment_id new_contentzAll commits have been pushed.)rrrr new_titleopen)rrrr new_statuscommentzPR is now open for reviews.)rrrrrz>PR has been automatically merged (`merge_pr=True` was passed).Nzno associated changesclosed)rrrrrrz-Couldn't merge the PR: no associated changes.) error_messagez-Couldn't merge Pull Request in multi-commit: )2rJ get_loggerrbsetLevelrnr}sumr/rget_repo_discussionsis_pull_requeststatusrget_discussion_detailsnumrr0eventsr:r7r-r2contentZ all_stepsrrzr<Z git_referencerrrZ completedrvaluesrredit_discussion_commentr1rename_discussionchange_discussion_statusr,merge_pull_requestr+rDZserver_messager*warningcomment_discussionr)format)rerrrrrrrrrrrr discussionpreventZ pr_commentZdescription_commitsZstep_idZ pr_commitsZremaining_additionsZremaining_deletionsrrZ nb_remainingerrorrfrrgcreate_commits_on_pr sHh                  "       zHfApi.create_commits_on_pr)rrr]rrrrrz!Union[str, Path, bytes, BinaryIO]) path_or_fileobjrrrrr]rrrrrrpc CsdSrrf rerrrrrr]rrrrrrfrfrg upload_file szHfApi.upload_filez Future[str]c CsdSrrfrrfrfrgr szUnion[str, Future[str]]c  Cs|tvrtdt|dur"|n d|d}t||d} |j||| g||||| | d } | jdurttt| jdd}|tvrt||}|dur|nt}|j d |d |d |S) a 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: `str` or `Future`: The URL to visualize the uploaded file on the hub. 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" ``` rNzUpload  with huggingface_hubrr) rrrrrrr]rrrqrarsz/blob/) r@rr!rrrrrBr<r)rerrrrrr]rrrrrZ operation commit_inforfrfrgr s2}  )rrrrrr]rrallow_patternsignore_patternsdelete_patterns multi_commitsmulti_commits_verboserUnion[str, Path]Optional[Union[List[str], str]])r folder_pathrrrrrr]rrrrrrrrrpcCsdSrrfrerrrrrrrr]rrrrrrrrrfrfrg upload_folder szHfApi.upload_foldercCsdSrrfrrfrfrgr sc s|tvrtdt|r2|dur2|tkr2td|dur>d}| durLg} nt| tr\| g} | t7} |j||| rttn|||| d}t||| | d}t|dkrt dd |Dfd d |D}||}|pd }|rt |d \}}|j |||||||| |d }n"|j |||||||| | d }|j }| rH|durHtt|dd}|tvr^t||}|durl|nt}|jd|d|d|S)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: `str` or `Future[str]`: A URL to visualize the uploaded folder on the hub. 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" ``` rNzGCannot use `multi_commit` to commit changes other than the main branch.rq)rrr]rrrrrrcss|] }|jVqdSrrrrfrfrgr rz&HfApi.upload_folder..csg|]}|jvr|qSrfr)rZ delete_opZ added_pathsrfrgr sz'HfApi.upload_folder..z#Upload folder using huggingface_hubr) rrrrrrrrr) rrrrrrr]rrrarsrq)r@rr<r:rlr _prepare_upload_folder_deletions _prepare_upload_folder_additionsr}setr3rrrrrrBr)rerrrrrrrr]rrrrrrrrZdelete_operationsZadd_operationsZcommit_operationsrrrrrfrrgr s&        )rrr]rrrr) rrrrr]rrrrrpc Cs@|dur |n d|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 rrrrr]rrrr)r#r) rerrrrr]rrrrrrfrfrg delete_file sG zHfApi.delete_filec Cs:|j|||t|ddg||dur$|n d|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)rr#) rerrrrr]rrrrrfrfrg delete_folder"s3 zHfApi.delete_folder)r]rrr{)rbranchr]rrr{rpc Cs|dur t}t|dd}|jd|d|d|}|j|dd}i} |durV|| d <tj||| d } z t| Wn6ty} z| jj d kr|sWYd} ~ n d} ~ 00dS) 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`. NrqrarMrN/branch/TrZ startingPointrr) r?rrr&rrQrIrFrSr) rerrr]rrr{ branch_urlr%payloadrSr(rfrfrg create_branchcs0  zHfApi.create_branch)rrrrrpcCs^|dur t}t|dd}|jd|d|d|}|j|dd}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. NrqrarMrNrTrrPr?rrr&rrUrI)rerrrrrr%rSrfrfrg delete_branchs% zHfApi.delete_branch) tag_messager]rrr{)rtagrr]rrr{rpc Cs|dur t}|dur t|ddnt}|jd|d|d|}|j|dd} d |i} |durf|| d <tj|| | d } z t| Wn6ty} z| j j d kr|sWYd} ~ n d} ~ 00dS) 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`. NrqrarMrN/tag/Trrrrr) r?rr<rr&rrQrIrFrSr) rerrrr]rrr{tag_urlr%rrSr(rfrfrg create_tags4 zHfApi.create_tag)rrrrrpcCs^|dur t}t|dd}|jd|d|d|}|j|dd}tj||d }t|dS) 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. NrqrarMrNrTrrPr)rerrrrrr%rSrfrfrg delete_tags" zHfApi.delete_tag)rr)model_idrrcCsP|dur>d|vr |dd}n|j|dd}|d|S|d|SdS)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. Nrsrr#r)r~r))rer rrusernamerfrfrgget_full_repo_nameLs zHfApi.get_full_repo_namezIterator[Discussion]c #stvrtdtdur"tj|dddfdd }d\}}|r||d\}}|D]Z}t|d |d |d id d t|d|d|dd |dd|djd Vqd|d}qNdS)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 `/`. 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) ``` rNr#r) page_indexcsljddd|}tj|d}t||}|d}|d}|d}|t||k}||fS)NrMrNz/discussions?p=r$countstart discussions)rrr rIr'r})r r.respZpaginated_discussionsrrrhas_nextr%rrrerfrg_fetch_discussion_pagesz:HfApi.get_repo_discussions.._fetch_discussion_page)Trrrrrdeleted createdAtrrXrW isPullRequest) rrrrrrrrrr)r@rr?r&r6r rLr) rerrrrrr rrrfrrgrrs,)      zHfApi.get_repo_discussionsr:)rrrrrpc Cs@t|tr|dkrtd|tvr0tdt|dur 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 integerrNrMrN /discussions/r#diffrr8rchangesbaseZfilesWithConflictsZ mergeCommitIdrrrrrrrrXrWcSsg|] }t|qSrf)r;)rZevtrfrfrgrrz0HfApi.get_discussion_details..r)rrrrrrrrrconflicting_files target_branchmerge_commit_oidrr) r:rrr@r?rr&rr rIr'r:rL) rerrrrr.r%rZdiscussion_detailsrrrrrfrfrgrs>(    zHfApi.get_discussion_details)rrr pull_request)rrrrrrrpc Cs|tvrtdt|dur"t}|dur2|}|r:|n|rBdndd}|j|dd}tj|jd|d |d |||d |d }t|| d } |j ||| |dS)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. rNz Pull Requestr6z^ opened with the [huggingface_hub Python library](https://huggingface.co/docs/huggingface_hub)TrrMrNz /discussions)rrZ pullRequest)r'r%r)rrrr) r@rr?stripr&rrQrrIr'r) rerrrrrrr%rrrfrfrgcreate_discussion s65   zHfApi.create_discussion)rrr)rrrrrrpcCs|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)rrrrrr)r!)rerrrrrrfrfrgcreate_pull_requestds1zHfApi.create_pull_request)bodyrrrzrequests.Response)rrresourcer#rrrpc Cst|tr|dkrtd|tvr0tdt|dur>> 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. rrrrrr$r#Z newMessager&r;r')rerrrrrrrfrfrgrsBzHfApi.comment_discussionr9)rrrrrrpcCs*|j||||dd|id}t|dS)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. rr'ZnewTitler()rerrrrrrrfrfrgrs9zHfApi.rename_discussion)rrrzLiteral['open', 'closed']r8)rrrrrrrpc CsV|dvrtdd|i}|r0|r0||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'rrr'Z newStatus)rr r&r;r') rerrrrrrr#rrfrfrgrGs<  zHfApi.change_discussion_status)rrrrrc Cs2|j||||d|r&|r&d|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. mergerNr')r&r )rerrrrrrfrfrgrs,zHfApi.merge_pull_request)rrrrrrrpcCs6|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/editrr'updatedComment)r&lowerr;r')rerrrrrrrrfrfrgrs/zHfApi.edit_discussion_comment)rrrrrrpcCs<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.r*z/hide)rrrrr$r+)rr UserWarningr&r,r;r')rerrrrrrrfrfrghide_discussion_comments0zHfApi.hide_discussion_comment)rrrrrpcCs:tj|jd|d|j|d||dd}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"`. token (`str`, *optional*): Hugging Face token. Will default to the locally saved token if not provided. rh/secretsr#)rrrN)rrQrr&rI)rerrrrrrfrfrgadd_space_secret=s  zHfApi.add_space_secret)rrrrpcCs8tj|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. rhr/r#rrN)rrUrr&rI)rerrrrrfrfrgdelete_space_secretUs  zHfApi.delete_space_secretr5)rrrpcCs: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. rhz/runtimer#r$)rr rr&rIr5r'rerrrrfrfrgget_space_runtimeks zHfApi.get_space_runtime)r sleep_timer4)rrrr4rpcCsr|dur|tjkrtdtd|i}|dur6||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.ZflavorZsleepTimeSecondsrhz /hardwarer#r) r4 CPU_BASICrrr-rrQrr&rIr5r')rerrrr4rrrfrfrgrequest_space_hardware~s  zHfApi.request_space_hardware)rr4rrpcCsftj|jd|d|j|dd|id}t|t|}|jpJ|j}|t j krbt 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`]. rhz /sleeptimer#secondsrr5)rrQrr&rIr5r'Zrequested_hardwarerr4r6rrr-)rerr4rrZruntimerrfrfrgset_space_sleep_times    zHfApi.set_space_sleep_timecCs:tj|jd|d|j|dd}t|t|S)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. rhz/pauser#r$rrQrr&rIr5r'r2rfrfrg pause_spaces zHfApi.pause_spacecCs:tj|jd|d|j|dd}t|t|S)aRestart 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. 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. rhz/restartr#r$r:r2rfrfrg restart_spaces zHfApi.restart_space)rrr{)rrrrr{rpc Cs|durt|nd}|dur,|jdur,|jn ||d}|durH|jnt|j}d|d|i} |durt|| d<tj|jd|d|j|dd | d } z t| Wn8t y} z |r| j j d krnWYd} ~ n d} ~ 00t| d |jd S)akDuplicate 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. 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',...) ``` Nr repositoryrsrrhz /duplicateTrrrrr) rrr)rrrQrr&rIrrSrr') rerrrrr{Z parsed_to_idZ to_namespaceZ to_repo_namerrrrfrfrgduplicate_space*s.5   zHfApi.duplicate_spacezDict[str, str])rrrrr rpcCs2|dur|j}t|||p|j|p$|j|p,|jdS)z Alias for [`build_hf_headers`] that uses the token from [`HfApi`] client when `token` is not provided. N)rrrrr )rrGrrr )rerrrrr rfrfrgr&s zHfApi._build_hf_headerszList[CommitOperationDelete])rrr]rrrrpcsp|dur gS|j||||d}rDddfdd|Dndd|Dfddt|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. N)rr]rrrscs(i|] }|r|td|qSr)r|r}rrprrfrgrsz:HfApi._prepare_upload_folder_deletions..cSsi|] }||qSrfrfr?rfrfrgrrcs(g|] }|dkrt|ddqS)z.gitattributesFr)r#rrelpath)relpath_to_abspathrfrgrs z:HfApi._prepare_upload_folder_deletions..)r)rvr rHkeys)rerrr]rrr filenamesrf)rrBrgrs  z&HfApi._prepare_upload_folder_deletions)NNNNN)N)N)N)N)F)N)NFNNN)CrbrirjrrrMr)r,rrrr;rrErJrLrTrVr\rergrirkrsrNrvryrzrrrrrrrrrrrrrrrrrr rrr!r"r&rrrrrr.r0r1r3r7r9r;r<r>r&rrfrfrfrgrBs((  *4$y) *T/.J C>> C 7 #;M"]- @>**,X*,**,446r&W&@ B0"F-%LK X?KB J4 8< 3"/##&X"rrrzList[CommitOperationAdd])rrrrrpcs~ts(tddfddtdD|rX|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||qSrf)is_file relative_toas_posix)rr.)rrfrgrsz4_prepare_upload_folder_additions..z**/*rsrqcs g|]}t||dqS)r)r!r@)prefixrBrfrgrs z4_prepare_upload_folder_additions..r) r expanduserresolveis_dirrsortedglobr rHrC)rrrrrf)rrHrBrgrs     r)rrpcCs2tt|}|dur$td|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: ''zrefs/pr/r)rzmatch_REGEX_DISCUSSION_URL RuntimeError)rre_matchrfrfrgrs r)N)NN) __future__rrr'r^rzrcrconcurrent.futuresrrZ dataclassesrrr functoolsr itertoolsr pathlibr typingr r r rrrrrrrrr urllib.parserr%Zrequests.exceptionsrZhuggingface_hub.utilsrrrrrrZ _commit_apir r!r"r#r$r%r&r'r(Z_multi_commitsr)r*r+r,r-r.r/r0r1r2r3Z _space_apir4r5Z communityr6r7r8r9r:r; constantsr<r=r>r?r@rArBrCutilsrDrErFrGrHrIrJrKrLrMZutils._deprecationrNZ utils._typingrOrPrQZutils.endpoint_helpersrRrSrTrUrVrWrXZUSERNAME_PLACEHOLDERcompilerPrrbrrYrrrrlrrrrrrrrrrrr rrrrrr)r,rrerrgrLrirkrvryrzrsrJrrrrrrrrrrrrrrrrr rr\rTrVrrr!r"rrrrrr0r1r3r7r9r;r<r>rfrfrfrgs     8   , 4  ( 0     U7<(AB-22*!#$