Parameters

• repo_id (str) —The id of the repo to accept access request for.
• user (str) —The username of the user which access request should be accepted.
• repo_type (str,optional) —The type of the repo to accept access request for. Must be one ofmodel,dataset orspace.Defaults tomodel.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

• HfHubHTTPError —HTTP 400 if the repo is not gated.
• HfHubHTTPError —HTTP 403 if you only have read-only access to the repo. This can be the case if you don’t havewriteoradmin role in the organization the repo belongs to or if you passed aread token.
• HfHubHTTPError —HTTP 404 if the user does not exist on the Hub.
• HfHubHTTPError —HTTP 404 if the user access request cannot be found.
• HfHubHTTPError —HTTP 404 if the user access request is already in the accepted list.

Parameters

• collection_slug (str) —Slug of the collection to update. Example:"TheBloke/recent-models-64f9a55bb3115b4f513ec026".
• item_id (str) —Id of the item to add to the collection. Use the repo_id for repos/spaces/datasets,the paper id for papers, or the slug of another collection (e.g."moonshotai/kimi-k2").
• item_type (str) —Type of the item to add. Can be one of"model","dataset","space","paper" or"collection".
• note (str,optional) —A note to attach to the item in the collection. The maximum size for a note is 500 characters.
• exists_ok (bool,optional) —IfTrue, do not raise an error if item already exists.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

• HfHubHTTPError —HTTP 403 if you only have read-only access to the repo. This can be the case if you don’t havewriteoradmin role in the organization the repo belongs to or if you passed aread token.
• HfHubHTTPError —HTTP 404 if the item you try to add to the collection does not exist on the Hub.
• HfHubHTTPError —HTTP 409 if the item you try to add to the collection is already in the collection (and exists_ok=False)

>>>from huggingface_hubimport add_collection_item>>>collection = add_collection_item(...    collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",...    item_id="pierre-loic/climate-news-articles",...    item_type="dataset"...)>>>collection.items[-1].item_id"pierre-loic/climate-news-articles"# ^item got added to the collection on last position# Add item with a note>>>add_collection_item(...    collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",...    item_id="datasets/climate_fever",...    item_type="dataset"...    note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet."...)(...)

Parameters

• repo_id (str) —ID of the repo to update. Example:"bigcode/in-the-stack".
• key (str) —Secret key. Example:"GITHUB_API_KEY"
• value (str) —Secret value. Example:"your_github_api_key".
• description (str,optional) —Secret description. Example:"Github API key to access the Github API".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• repo_id (str) —ID of the repo to update. Example:"bigcode/in-the-stack".
• key (str) —Variable key. Example:"MODEL_REPO_ID"
• value (str) —Variable value. Example:"the_model_repo_id".
• description (str) —Description of the variable. Example:"Model Repo ID of the implemented model".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• repo_id (str) —The repository to check for access. Format should be"user/repo_name".Example:"user/my-cool-model".
• repo_type (str,optional) —The type of the repository. Should be one of"model","dataset", or"space".If not specified, the default is"model".
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

• RepositoryNotFoundError —Raised if the repository does not exist, is private, or the user does not have access. This canoccur if therepo_id orrepo_type is incorrect or if the repository is private but the useris not authenticated.

• GatedRepoError —Raised if the repository exists but is gated and the user is not authorized to access it.

>>>from huggingface_hubimport auth_check>>>from huggingface_hub.utilsimport GatedRepoError, RepositoryNotFoundErrortry:    auth_check("user/my-cool-model")except GatedRepoError:# Handle gated repository errorprint("You do not have permission to access this gated repository.")except RepositoryNotFoundError:# Handle repository not found errorprint("The repository was not found or you do not have access.")

Parameters

• repo_id (str) —The id of the repo to cancel access request for.
• user (str) —The username of the user which access request should be cancelled.
• repo_type (str,optional) —The type of the repo to cancel access request for. Must be one ofmodel,dataset orspace.Defaults tomodel.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

• HfHubHTTPError —HTTP 400 if the repo is not gated.
• HfHubHTTPError —HTTP 403 if you only have read-only access to the repo. This can be the case if you don’t havewriteoradmin role in the organization the repo belongs to or if you passed aread token.
• HfHubHTTPError —HTTP 404 if the user does not exist on the Hub.
• HfHubHTTPError —HTTP 404 if the user access request cannot be found.
• HfHubHTTPError —HTTP 404 if the user access request is already in the pending list.

Parameters

• job_id (str) —ID of the Job.
• namespace (str,optional) —The namespace where the Job is running. Defaults to the current user’s namespace.
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby 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 orspace,None or"model" if uploading to a model. Default isNone.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

the status change event

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

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• discussion_num (int) —The number of the Discussion or Pull Request . Must be a strictly positive integer.
• comment (str) —The content of the comment to create. Comments support markdown formatting.
• repo_type (str,optional) —Set to"dataset" or"space" if uploading to a dataset orspace,None or"model" if uploading to a model. Default isNone.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

the newly created comment

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

Parameters

• 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 orthe OID/SHA of a commit, as a hexadecimal string. Defaults to the headof the"main" branch.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if creating a branch on a dataset orspace,None or"model" if tagging a model. Default isNone.
• exist_ok (bool,optional, defaults toFalse) —IfTrue, do not raise an error if branch already exists.

• RepositoryNotFoundError —If repository is not found (error 404): wrong repo_id/repo_type, privatebut not authenticated or repo does not exist.
• BadRequestError —If invalid reference for a branch. Ex:refs/pr/5 or ‘refs/foo/bar’.
• HfHubHTTPError —If the branch already exists on the repo (error 409) andexist_ok isset toFalse.

Parameters

• title (str) —Title of the collection to create. Example:"Recent models".
• namespace (str,optional) —Namespace of the collection to create (username or org). Will default to the owner name.
• description (str,optional) —Description of the collection to create.
• private (bool,optional) —Whether the collection should be private or not. Defaults toFalse (i.e. public collection).
• exists_ok (bool,optional) —IfTrue, do not raise an error if collection already exists.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

>>>from huggingface_hubimport create_collection>>>collection = create_collection(...    title="ICCV 2023",...    description="Portfolio of models, papers and demos I presented at ICCV 2023",...)>>>collection.slug"username/iccv-2023-64f9a55bb3115b4f513ec026"

Parameters

• repo_id (str) —The repository in which the commit will be created, for example:"username/custom_transformers"
• operations (Iterable ofCommitOperation()) —An iterable of operations to include in the commit, either:
  • CommitOperationAdd to upload a file
  • CommitOperationDelete to delete a file
  • CommitOperationCopy to copy a file

  Operation objects will be mutated to include information relative to the upload. Do not reuse thesame objects for multiple commits.

• commit_message (str) —The summary (first line) of the commit that will be created.
• commit_description (str,optional) —The description of the commit that will be created
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if uploading to a dataset orspace,None or"model" if uploading to a model. Default isNone.
• 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 toFalse.Ifrevision is not set, PR is opened against the"main" branch. Ifrevision is set and is a branch, PR is opened against this branch. Ifrevision is set and is not a branch name (example: a commit oid), anRevisionNotFoundError 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 andcreate_pr isFalse,the commit will fail ifrevision does not point toparent_commit. If specified andcreate_prisTrue, the pull request will be created fromparent_commit. Specifyingparent_commitensures the repo has not changed before committing the changes, and can be especially usefulif 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 withoutblocking the main thread. Passingrun_as_future=True will return aFutureobject. Defaults toFalse.

Instance ofCommitInfo containing information about the newly created commit (commit hash, commiturl, pr url, commit message,…). Ifrun_as_future=True is passed, returns a Future object which willcontain the result when executed.

• ValueError —If commit message is empty.
• ValueError —If parent commit is not a valid commit OID.
• ValueError —If a README.md file with an invalid metadata section is committed. In this case, the commit will failearly, before trying to upload any file.
• ValueError —Ifcreate_pr isTrue and revision is neitherNone nor"main".
• RepositoryNotFoundError —If repository is not found (error 404): wrong repo_id/repo_type, privatebut not authenticated or repo does not exist.

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby 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 whitespaceswill be stripped.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• 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. IfTrue, creates a Pull Request.IfFalse, creates a discussion. Defaults toFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if uploading to a dataset orspace,None or"model" if uploading to a model. Default isNone.

Parameters

• name (str) —The unique name for the new Inference Endpoint.
• repository (str) —The name of the model repository associated with the Inference Endpoint (e.g."gpt2").
• framework (str) —The machine learning framework used for the model (e.g."custom").
• accelerator (str) —The hardware accelerator to be used for inference (e.g."cpu").
• instance_size (str) —The size or type of the instance to be used for hosting the model (e.g."x4").
• instance_type (str) —The cloud instance type where the Inference Endpoint will be deployed (e.g."intel-icl").
• region (str) —The cloud region in which the Inference Endpoint will be created (e.g."us-east-1").
• vendor (str) —The cloud provider or vendor where the Inference Endpoint will be hosted (e.g."aws").
• account_id (str,optional) —The account ID used to link a VPC to a private Inference Endpoint (if applicable).
• min_replica (int,optional) —The minimum number of replicas (instances) to keep running for the Inference Endpoint. To enablescaling to zero, set this value to 0 and adjustscale_to_zero_timeout accordingly. Defaults to 1.
• max_replica (int,optional) —The maximum number of replicas (instances) to scale to for the Inference Endpoint. Defaults to 1.
• scaling_metric (str orInferenceEndpointScalingMetric,optional) —The metric reference for scaling. Either “pendingRequests” or “hardwareUsage” when provided. Defaults toNone (meaning: let the HF Endpoints service specify the metric).
• scaling_threshold (float,optional) —The scaling metric threshold used to trigger a scale up. Ignored when scaling metric is not provided.Defaults to None (meaning: let the HF Endpoints service specify the threshold).
• scale_to_zero_timeout (int,optional) —The duration in minutes before an inactive endpoint is scaled to zero, or no scaling to zero ifset to None andmin_replica is not 0. Defaults to None.
• revision (str,optional) —The specific model revision to deploy on the Inference Endpoint (e.g."6c0e6080953db56375760c0471a8c5f2929baf11").
• task (str,optional) —The task on which to deploy the model (e.g."text-classification").
• custom_image (dict,optional) —A custom Docker image to use for the Inference Endpoint. This is useful if you want to deploy anInference Endpoint running on thetext-generation-inference (TGI) framework (see examples).
• env (dict[str, str],optional) —Non-secret environment variables to inject in the container environment.
• secrets (dict[str, str],optional) —Secret values to inject in the container environment.
• type ([`InferenceEndpointType], *optional*) -- The type of the Inference Endpoint, which can be“protected”(default),“public”or“private”`.
• domain (str,optional) —The custom domain for the Inference Endpoint deployment, if setup the inference endpoint will be available at this domain (e.g."my-new-domain.cool-website.woof").
• path (str,optional) —The custom path to the deployed model, should start with a/ (e.g."/models/google-bert/bert-base-uncased").
• cache_http_responses (bool,optional) —Whether to cache HTTP responses from the Inference Endpoint. Defaults toFalse.
• tags (list[str],optional) —A list of tags to associate with the Inference Endpoint.
• namespace (str,optional) —The namespace where the Inference Endpoint will be created. Defaults to the current user’s namespace.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

information about the updated Inference Endpoint.

>>>from huggingface_hubimport HfApi>>>api = HfApi()>>>endpoint = api.create_inference_endpoint(..."my-endpoint-name",...    repository="gpt2",...    framework="pytorch",...    task="text-generation",...    accelerator="cpu",...    vendor="aws",...    region="us-east-1",...type="protected",...    instance_size="x2",...    instance_type="intel-icl",...)>>>endpointInferenceEndpoint(name='my-endpoint-name', status="pending",...)# Run inference on the endpoint>>>endpoint.client.text_generation(...)"..."

# Start an Inference Endpoint running Zephyr-7b-beta on TGI>>>from huggingface_hubimport HfApi>>>api = HfApi()>>>endpoint = api.create_inference_endpoint(..."aws-zephyr-7b-beta-0486",...    repository="HuggingFaceH4/zephyr-7b-beta",...    framework="pytorch",...    task="text-generation",...    accelerator="gpu",...    vendor="aws",...    region="us-east-1",...type="protected",...    instance_size="x1",...    instance_type="nvidia-a10g",...    env={..."MAX_BATCH_PREFILL_TOKENS":"2048",..."MAX_INPUT_LENGTH":"1024",..."MAX_TOTAL_TOKENS":"1512",..."MODEL_ID":"/repository"...        },...    custom_image={..."health_route":"/health",..."url":"ghcr.io/huggingface/text-generation-inference:1.1.0",...    },...   secrets={"MY_SECRET_KEY":"secret_value"},...   tags=["dev","text-generation"],...)

# Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes>>>from huggingface_hubimport HfApi>>>api = HfApi()>>>endpoint = api.create_inference_endpoint(..."finbert-classifier",...    repository="ProsusAI/finbert",...    framework="pytorch",...    task="text-classification",...    min_replica=0,...    scale_to_zero_timeout=15,...    accelerator="cpu",...    vendor="aws",...    region="us-east-1",...type="protected",...    instance_size="x2",...    instance_type="intel-icl",...)>>>endpoint.wait(timeout=300)# Run inference on the endpoint>>>endpoint.client.text_generation(...)TextClassificationOutputElement(label='positive', score=0.8983615040779114)

Parameters

• repo_id (str) —The ID of the model in the catalog to deploy as an Inference Endpoint.
• name (str,optional) —The unique name for the new Inference Endpoint. If not provided, a random name will be generated.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).
• namespace (str,optional) —The namespace where the Inference Endpoint will be created. Defaults to the current user’s namespace.

information about the new Inference Endpoint.

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby 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 whitespaceswill be stripped.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• 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 orspace,None or"model" if uploading to a model. Default isNone.

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• private (bool,optional) —Whether to make the repo private. IfNone (default), the repo will be public unless the organization’s default is private. This value is ignored if the repo already exists.
• repo_type (str,optional) —Set to"dataset" or"space" if uploading to a dataset orspace,None or"model" if uploading to a model. Default isNone.
• exist_ok (bool,optional, defaults toFalse) —IfTrue, do not raise an error if repo already exists.
• resource_group_id (str,optional) —Resource group in which to create the repo. Resource groups is only available for Enterprise Hub organizations andallow to define which members of the organization can access the resource. The ID of a resource groupcan be found in the URL of the resource’s page on the Hub (e.g."66670e5163145ca562cb1988").To learn more about resource groups, seehttps://huggingface.co/docs/hub/en/security-resource-groups.
• space_sdk (str,optional) —Choice of SDK to use if repo_type is “space”. Can be “streamlit”, “gradio”, “docker”, or “static”.
• space_hardware (SpaceHardware orstr,optional) —Choice of Hardware if repo_type is “space”. SeeSpaceHardware for a complete list.
• space_storage (SpaceStorage orstr,optional) —Choice of persistent storage tier. Example:"small". SeeSpaceStorage for a complete list.
• space_sleep_time (int,optional) —Number of seconds of inactivity to wait before a Space is put to sleep. Set to-1 if you don’t wantyour Space to sleep (default behavior for upgraded hardware). For free hardware, you can’t configurethe sleep time (value is fixed to 48 hours of inactivity).Seehttps://huggingface.co/docs/hub/spaces-gpus#sleep-time for more details.
• space_secrets (list[dict[str, str]],optional) —A list of secret keys to set in your Space. Each item is in the form{"key": ..., "value": ..., "description": ...} where description is optional.For more details, seehttps://huggingface.co/docs/hub/spaces-overview#managing-secrets.
• space_variables (list[dict[str, str]],optional) —A list of public environment variables to set in your Space. Each item is in the form{"key": ..., "value": ..., "description": ...} where description is optional.For more details, seehttps://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.

URL to the newly created repo. Value is a subclass ofstr containingattributes likeendpoint,repo_type andrepo_id.

Parameters

• image (str) —The Docker image to use.Examples:"ubuntu","python:3.12","pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel".Example with an image from a Space:"hf.co/spaces/lhoestq/duckdb".
• command (list[str]) —The command to run. Example:["echo", "hello"].
• schedule (str) —One of “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, or aCRON schedule expression (e.g., ‘0 9 * * 1’ for 9 AM every Monday).
• suspend (bool,optional) —If True, the scheduled Job is suspended (paused). Defaults to False.
• concurrency (bool,optional) —If True, multiple instances of this Job can run concurrently. Defaults to False.
• env (dict[str, Any],optional) —Defines the environment variables for the Job.
• secrets (dict[str, Any],optional) —Defines the secret environment variables for the Job.
• flavor (str,optional) —Flavor for the hardware, as in Hugging Face Spaces. SeeSpaceHardware for possible values.Defaults to"cpu-basic".
• timeout (Union[int, float, str],optional) —Max duration for the Job: int/float with s (seconds, default), m (minutes), h (hours) or d (days).Example:300 or"5m" for 5 minutes.
• labels (dict[str, str],optional) —Labels to attach to the job (key-value pairs).
• namespace (str,optional) —The namespace where the Job will be created. Defaults to the current user’s namespace.
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

>>>from huggingface_hubimport create_scheduled_job>>>create_scheduled_job(image="python:3.12", command=["python","-c" ,"print('Hello from HF compute!')"], schedule="@hourly")

>>>from huggingface_hubimport create_scheduled_job>>>create_scheduled_job(image="python:3.12", command=["python","-c" ,"print('this runs every 5min')"], schedule="*/5 * * * *")

>>>from huggingface_hubimport create_scheduled_job>>>image ="pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel">>>command = ["python","-c","import torch; print(f"This code ranwith the following GPU: {torch.cuda.get_device_name()}")"]>>>create_scheduled_job(image, command, flavor="a10g-small", schedule="@hourly")

Parameters

• script (str) —Path or URL of the UV script, or a command.
• script_args (list[str],optional) —Arguments to pass to the script, or a command.
• schedule (str) —One of “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, or aCRON schedule expression (e.g., ‘0 9 * * 1’ for 9 AM every Monday).
• suspend (bool,optional) —If True, the scheduled Job is suspended (paused). Defaults to False.
• concurrency (bool,optional) —If True, multiple instances of this Job can run concurrently. Defaults to False.
• dependencies (list[str],optional) —Dependencies to use to run the UV script.
• python (str,optional) —Use a specific Python version. Default is 3.12.
• image (str,optional, defaults to “ghcr.io/astral-sh/uv —python3.12-bookworm”):Use a custom Docker image withuv installed.
• env (dict[str, Any],optional) —Defines the environment variables for the Job.
• secrets (dict[str, Any],optional) —Defines the secret environment variables for the Job.
• flavor (str,optional) —Flavor for the hardware, as in Hugging Face Spaces. SeeSpaceHardware for possible values.Defaults to"cpu-basic".
• timeout (Union[int, float, str],optional) —Max duration for the Job: int/float with s (seconds, default), m (minutes), h (hours) or d (days).Example:300 or"5m" for 5 minutes.
• labels (dict[str, str],optional) —Labels to attach to the job (key-value pairs).
• namespace (str,optional) —The namespace where the Job will be created. Defaults to the current user’s namespace.
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

>>>from huggingface_hubimport create_scheduled_uv_job>>>script ="https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py">>>script_args = ["--model_name_or_path","Qwen/Qwen2-0.5B","--dataset_name","trl-lib/Capybara","--push_to_hub"]>>>create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

>>>from huggingface_hubimport create_scheduled_uv_job>>>script ="my_sft.py">>>script_args = ["--model_name_or_path","Qwen/Qwen2-0.5B","--dataset_name","trl-lib/Capybara","--push_to_hub"]>>>create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

>>>from huggingface_hubimport create_scheduled_uv_job>>>script ="lighteval">>>script_args= ["endpoint","inference-providers","model_name=openai/gpt-oss-20b,provider=auto","lighteval|gsm8k|0|0"]>>>create_scheduled_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small", schedule="@weekly")

Parameters

• 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 acommit, as a hexadecimal string. Shorthands (7 first characters) arealso supported. Defaults to the head of the"main" branch.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if tagging a dataset orspace,None or"model" if tagging a model. Default isNone.
• exist_ok (bool,optional, defaults toFalse) —IfTrue, do not raise an error if tag already exists.

• RepositoryNotFoundError —If repository is not found (error 404): wrong repo_id/repo_type, privatebut not authenticated or repo does not exist.
• RevisionNotFoundError —If revision is not found (error 404) on the repo.
• HfHubHTTPError —If the branch already exists on the repo (error 409) andexist_ok isset toFalse.

Parameters

• url (str) —URL to send the payload to.
• job_id (str) —ID of the source Job to trigger with the webhook payload in the environment variable WEBHOOK_PAYLOAD.Additional environment variables are available for convenience: WEBHOOK_REPO_ID, WEBHOOK_REPO_TYPE and WEBHOOK_SECRET.
• watched (list[WebhookWatchedItem]) —List ofWebhookWatchedItem to be watched by the webhook. It can be users, orgs, models, datasets or spaces.Watched items can also be provided as plain dictionaries.
• domains (list[Literal["repo", "discussion"]], optional) —List of domains to watch. It can be “repo”, “discussion” or both.
• secret (str, optional) —A secret to sign the payload with.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally saved token, which is the recommendedmethod for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Info about the newly created webhook.

>>>from huggingface_hubimport create_webhook>>>payload = create_webhook(...    watched=[{"type":"user","name":"julien-c"}, {"type":"org","name":"HuggingFaceH4"}],...    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",...    domains=["repo","discussion"],...    secret="my-secret",...)>>>print(payload)WebhookInfo(id="654bbbc16f2ec14d77f109cc",    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",    job=None,    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],    domains=["repo","discussion"],    secret="my-secret",    disabled=False,)

>>>from huggingface_hubimport create_webhook, run_job>>>job = run_job(...    image="ubuntu",...    command=["bash","-c",r"echo An event occured in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD"],...)>>>payload = create_webhook(...    watched=[{"type":"user","name":"julien-c"}, {"type":"org","name":"HuggingFaceH4"}],...    job_id=job.id,...    domains=["repo","discussion"],...    secret="my-secret",...)>>>print(payload)WebhookInfo(id="654bbbc16f2ec14d77f109cc",    url=None,    job=JobSpec(        docker_image='ubuntu',        space_id=None,        command=['bash','-c','echo An event occured in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD'],        arguments=[],        environment={},        secrets=[],        flavor='cpu-basic',        timeout=None,        tags=None,        arch=None    ),    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],    domains=["repo","discussion"],    secret="my-secret",    disabled=False,)

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• revision (str,optional) —The revision of the dataset repository from which to get theinformation.
• 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 toFalse.
• expand (list[ExpandDatasetProperty_T],optional) —List properties to return in the response. When used, only the properties in the list will be returned.This parameter cannot be used iffiles_metadata is passed.Possible values are"author","cardData","citation","createdAt","disabled","description","downloads","downloadsAllTime","gated","lastModified","likes","paperswithcode_id","private","siblings","sha","tags","trendingScore","usedStorage", and"resourceGroup".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

The dataset repository information.

Parameters

• 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 (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if creating a branch on a dataset orspace,None or"model" if tagging a model. Default isNone.

• RepositoryNotFoundError —If repository is not found (error 404): wrong repo_id/repo_type, privatebut not authenticated or repo does not exist.
• HfHubHTTPError —If trying to delete a protected branch. Ex:main cannot be deleted.
• HfHubHTTPError —If trying to delete a branch that does not exist.

Parameters

• collection_slug (str) —Slug of the collection to delete. Example:"TheBloke/recent-models-64f9a55bb3115b4f513ec026".
• missing_ok (bool,optional) —IfTrue, do not raise an error if collection doesn’t exists.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

>>>from huggingface_hubimport delete_collection>>>collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True)

Parameters

• collection_slug (str) —Slug of the collection to update. Example:"TheBloke/recent-models-64f9a55bb3115b4f513ec026".
• item_object_id (str) —ID of the item in the collection. This is not the id of the item on the Hub (repo_id or paper id).It must be retrieved from aCollectionItem object. Example:collection.items[0].item_object_id.
• missing_ok (bool,optional) —IfTrue, do not raise an error if item doesn’t exists.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

>>>from huggingface_hubimport get_collection, delete_collection_item# Get collection first>>>collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")# Delete item based on its ID>>>delete_collection_item(...    collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",...    item_object_id=collection.items[-1].item_object_id,...)

Parameters

• 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 (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if the file is in a dataset orspace,None or"model" if in a model. Default isNone.
• 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 tof"Delete {path_in_repo} with huggingface_hub".
• commit_description (stroptional) —The description of the generated commit
• create_pr (boolean,optional) —Whether or not to create a Pull Request with that commit. Defaults toFalse.Ifrevision is not set, PR is opened against the"main" branch. Ifrevision is set and is a branch, PR is opened against this branch. Ifrevision is set and is not a branch name (example: a commit oid), anRevisionNotFoundError 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 andcreate_pr isFalse, the commit will fail ifrevision does not point toparent_commit.If specified andcreate_pr isTrue, the pull request will be created fromparent_commit.Specifyingparent_commit ensures the repo has not changed before committing the changes, and can beespecially useful if the repo is updated / committed to concurrently.

Parameters

• repo_id (str) —The repository from which the folder will be deleted, for example:"username/custom_transformers"
• delete_patterns (list[str]) —List of files or folders to delete. Each string can either bea file path, a folder path, or a wildcard pattern. Patterns are StandardWildcards (globbing patterns) as documentedhere.The pattern matching is based onfnmatch.Note thatfnmatch matches* across path boundaries, unlike traditional Unix shell globbing.E.g.["file.txt", "folder/", "data/*.parquet"]
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.to the stored token.
• repo_type (str,optional) —Type of the repo to delete files from. Can be"model","dataset" or"space". Defaults to"model".
• revision (str,optional) —The git revision to commit from. Defaults to the head of the"main" branch.
• commit_message (str,optional) —The summary (first line) of the generated commit. Defaults tof"Delete files using huggingface_hub".
• commit_description (stroptional) —The description of the generated commit.
• create_pr (boolean,optional) —Whether or not to create a Pull Request with that commit. Defaults toFalse.Ifrevision is not set, PR is opened against the"main" branch. Ifrevision is set and is a branch, PR is opened against this branch. Ifrevision is set and is not a branch name (example: a commit oid), anRevisionNotFoundError 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 andcreate_pr isFalse, the commit will fail ifrevision does not point toparent_commit.If specified andcreate_pr isTrue, the pull request will be created fromparent_commit.Specifyingparent_commit ensures the repo has not changed before committing the changes, and can beespecially useful if the repo is updated / committed to concurrently.

Parameters

• 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 (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.to the stored token.
• repo_type (str,optional) —Set to"dataset" or"space" if the folder is in a dataset orspace,None or"model" if in a model. Default isNone.
• 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 tof"Delete folder {path_in_repo} with huggingface_hub".
• commit_description (stroptional) —The description of the generated commit.
• create_pr (boolean,optional) —Whether or not to create a Pull Request with that commit. Defaults toFalse.Ifrevision is not set, PR is opened against the"main" branch. Ifrevision is set and is a branch, PR is opened against this branch. Ifrevision is set and is not a branch name (example: a commit oid), anRevisionNotFoundError 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 andcreate_pr isFalse, the commit will fail ifrevision does not point toparent_commit.If specified andcreate_pr isTrue, the pull request will be created fromparent_commit.Specifyingparent_commit ensures the repo has not changed before committing the changes, and can beespecially useful if the repo is updated / committed to concurrently.

Parameters

• name (str) —The name of the Inference Endpoint to delete.
• namespace (str,optional) —The namespace in which the Inference Endpoint is located. Defaults to the current user.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if uploading to a dataset orspace,None or"model" if uploading to a model.
• missing_ok (bool,optional, defaults toFalse) —IfTrue, do not raise an error if repo does not exist.

• RepositoryNotFoundError —If the repository to delete from cannot be found andmissing_ok is set to False (default).

Parameters

• scheduled_job_id (str) —ID of the scheduled Job.
• namespace (str,optional) —The namespace where the scheduled Job is. Defaults to the current user’s namespace.
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Parameters

• repo_id (str) —ID of the repo to update. Example:"bigcode/in-the-stack".
• key (str) —Secret key. Example:"GITHUB_API_KEY".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• repo_id (str) —ID of the Space to update. Example:"open-llm-leaderboard/open_llm_leaderboard".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Runtime information about a Space including Space stage and hardware.

• BadRequestError —If space has no persistent storage.

Parameters

• repo_id (str) —ID of the repo to update. Example:"bigcode/in-the-stack".
• key (str) —Variable key. Example:"MODEL_REPO_ID"
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• 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 (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• repo_type (str,optional) —Set to"dataset" or"space" if tagging a dataset or space,None or"model" if tagging a model. Default isNone.

• RepositoryNotFoundError —If repository is not found (error 404): wrong repo_id/repo_type, privatebut not authenticated or repo does not exist.
• RevisionNotFoundError —If tag is not found.

Parameters

• webhook_id (str) —The unique identifier of the webhook to delete.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally saved token, which is the recommendedmethod for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

>>>from huggingface_hubimport delete_webhook>>>delete_webhook("654bbbc16f2ec14d77f109cc")

Parameters

• webhook_id (str) —The unique identifier of the webhook to disable.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally saved token, which is the recommendedmethod for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Info about the disabled webhook.

>>>from huggingface_hubimport disable_webhook>>>disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc")>>>disabled_webhookWebhookInfo(id="654bbbc16f2ec14d77f109cc",    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",    jon=None,    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],    domains=["repo","discussion"],    secret="my-secret",    disabled=True,)

Parameters

• 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 samename 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 (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• exist_ok (bool,optional, defaults toFalse) —IfTrue, do not raise an error if repo already exists.
• hardware (SpaceHardware orstr,optional) —Choice of Hardware. Example:"t4-medium". SeeSpaceHardware for a complete list.
• storage (SpaceStorage orstr,optional) —Choice of persistent storage tier. Example:"small". SeeSpaceStorage for a complete list.
• sleep_time (int,optional) —Number of seconds of inactivity to wait before a Space is put to sleep. Set to-1 if you don’t wantyour Space to sleep (default behavior for upgraded hardware). For free hardware, you can’t configurethe sleep time (value is fixed to 48 hours of inactivity).Seehttps://huggingface.co/docs/hub/spaces-gpus#sleep-time for more details.
• secrets (list[dict[str, str]],optional) —A list of secret keys to set in your Space. Each item is in the form{"key": ..., "value": ..., "description": ...} where description is optional.For more details, seehttps://huggingface.co/docs/hub/spaces-overview#managing-secrets.
• variables (list[dict[str, str]],optional) —A list of public environment variables to set in your Space. Each item is in the form{"key": ..., "value": ..., "description": ...} where description is optional.For more details, seehttps://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.

URL to the newly created repo. Value is a subclass ofstr containingattributes likeendpoint,repo_type andrepo_id.

• RepositoryNotFoundError —If one offrom_id orto_id cannot be found. This may be because it doesn’t exist,or because it is set toprivate and you do not have access.
• HfHubHTTPError —If the HuggingFace API returned an error

>>>from huggingface_hubimport 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',...)

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby 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 orspace,None or"model" if uploading to a model. Default isNone.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

the edited comment

Parameters

• webhook_id (str) —The unique identifier of the webhook to enable.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally saved token, which is the recommendedmethod for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Info about the enabled webhook.

>>>from huggingface_hubimport enable_webhook>>>enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc")>>>enabled_webhookWebhookInfo(id="654bbbc16f2ec14d77f109cc",    job=None,    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],    domains=["repo","discussion"],    secret="my-secret",    disabled=False,)

Parameters

• job_id (str) —ID of the Job.
• namespace (str,optional) —The namespace where the Job is running. Defaults to the current user’s namespace.
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

>>>from huggingface_hubimport fetch_job_logs, run_job>>>job = run_job(image="python:3.12", command=["python","-c" ,"print('Hello from HF compute!')"])>>>for login fetch_job_logs(job_id=job.id):...print(log)Hellofrom HF compute!

Parameters

• job_id (str) —ID of the Job.
• namespace (str,optional) —The namespace where the Job is running. Defaults to the current user’s namespace.
• token(Union[bool, str, None],optional) —A valid user access token. If not provided, the locally saved token will be used, which is therecommended authentication method. Set toFalse to disable authentication.Refer to:https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

>>>from huggingface_hubimport fetch_job_metrics, run_job>>>job = run_job(image="python:3.12", command=["python","-c" ,"print('Hello from HF compute!')"], flavor="a10g-small")>>>for metricsin fetch_job_metrics(job_id=job.id):...print(metrics){"cpu_usage_pct":0,"cpu_millicores":3500,"memory_used_bytes":1306624,"memory_total_bytes":15032385536,"rx_bps":0,"tx_bps":0,"gpus": {"882fa930": {"utilization":0,"memory_used_bytes":0,"memory_total_bytes":22836000000        }    },"replica":"57vr7"}

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• filename (str) —The name of the file to check, for example:"config.json"
• repo_type (str,optional) —Set to"dataset" or"space" if getting repository info from a dataset or a space,None or"model" if getting repository info from a model. Default isNone.
• revision (str,optional) —The revision of the repository from which to get the information. Defaults to"main" branch.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

>>>from huggingface_hubimport file_exists>>>file_exists("bigcode/starcoder","config.json")True>>>file_exists("bigcode/starcoder","not-a-file")False>>>file_exists("bigcode/not-a-repo","config.json")False

Parameters

• collection_slug (str) —Slug of the collection of the Hub. Example:"TheBloke/recent-models-64f9a55bb3115b4f513ec026".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

>>>from huggingface_hubimport get_collection>>>collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")>>>collection.title'Recent models'>>>len(collection.items)37>>>collection.items[0]CollectionItem(    item_object_id='651446103cd773a050bf64c2',    item_id='TheBloke/U-Amethyst-20B-AWQ',    item_type='model',    position=88,    note=None)

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• discussion_num (int) —The number of the Discussion or Pull Request . Must be a strictly positive integer.
• repo_type (str,optional) —Set to"dataset" or"space" if uploading to a dataset orspace,None or"model" if uploading to a model. Default isNone.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• model_id (str) —The name of the model.
• organization (str,optional) —If passed, the repository name will be in the organizationnamespace instead of the user namespace.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

The repository name in the user’s namespace({username}/{model_id}) if no organization is passed, and under theorganization namespace ({organization}/{model_id}) otherwise.

Parameters

• url (str) —File url, for example returned byhf_hub_url().
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.
• timeout (float,optional, defaults to 10) —How many seconds to wait for the server to send metadata before giving up.

Parameters

• name (str) —The name of the Inference Endpoint to retrieve information about.
• namespace (str,optional) —The namespace in which the Inference Endpoint is located. Defaults to the current user.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

information about the requested Inference Endpoint.

>>>from huggingface_hubimport HfApi>>>api = HfApi()>>>endpoint = api.get_inference_endpoint("my-text-to-image")>>>endpointInferenceEndpoint(name='my-text-to-image', ...)# Get status>>>endpoint.status'running'>>>endpoint.url'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud'# Run inference>>>endpoint.client.text_to_image(...)

Parameters

• organization (str) —Name of the organization to get an overview of.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally saved token, which is the recommended methodfor authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

AnOrganization object with the organization’s overview.

• HTTPError —HTTP 404 If the organization does not exist on the Hub.

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separated by a/.
• paths (Union[list[str], str],optional) —The paths to get information about. If a path do not exist, it is ignored without raisingan exception.
• expand (bool,optional, defaults toFalse) —Whether to fetch more information about the paths (e.g. last commit and files’ security scan results). Thisoperation is more expensive for the server so only 50 results are returned per page (instead of 1000).As pagination is implemented inhuggingface_hub, this is transparent for you except for the time ittakes 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 orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

The information about the paths, as a list ofRepoFile andRepoFolder objects.

• RepositoryNotFoundError —If repository is not found (error 404): wrong repo_id/repo_type, private but not authenticated or repodoes not exist.
• RevisionNotFoundError —If revision is not found (error 404) on the repo.

>>>from huggingface_hubimport get_paths_info>>>paths_info = get_paths_info("allenai/c4", ["README.md","en"], repo_type="dataset")>>>paths_info[    RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None),    RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None)]

Parameters

• repo_id (str) —A namespace (user or an organization) and a repo name separatedby a/.
• author (str,optional) —Pass a value to filter by discussion author.None means no filter.Default isNone.
• discussion_type (str,optional) —Set to"pull_request" to fetch only pull requests,"discussion"to fetch only discussions. Set to"all" orNone to fetch both.Default isNone.
• discussion_status (str,optional) —Set to"open" (respectively"closed") to fetch only open(respectively closed) discussions. Set to"all" orNoneto fetch both.Default isNone.
• repo_type (str,optional) —Set to"dataset" or"space" if fetching from a dataset orspace,None or"model" if fetching from a model. Default isNone.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

An iterator ofDiscussion objects.

>>>from huggingface_hubimport get_repo_discussions>>>discussions_list =list(get_repo_discussions(repo_id="bert-base-uncased"))

>>>from huggingface_hubimport get_repo_discussions>>>for discussionin get_repo_discussions(repo_id="bert-base-uncased"):...print(discussion.num, discussion.title)

Parameters

• repo_id (str) —A user or an organization name and a repo name separated by a/.
• repo_type (str,optional) —Set to"dataset" or"space" if the file is in a dataset or space,None or"model" if in amodel. Default isNone.
• revision (str,optional) —The git revision to fetch the file from. Can be a branch name, a tag, or a commit hash. Defaults to thehead of the"main" branch.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

information related to safetensors repo.

• NotASafetensorsRepoError —If the repo is not a safetensors repo i.e. doesn’t have either amodel.safetensors or amodel.safetensors.index.json file.
• SafetensorsParsingError —If a safetensors file header couldn’t be parsed correctly.

# Parse repo with single weights file>>>metadata = get_safetensors_metadata("bigscience/bloomz-560m")>>>metadataSafetensorsRepoMetadata(    metadata=None,    sharded=False,    weight_map={'h.0.input_layernorm.bias':'model.safetensors', ...},    files_metadata={'model.safetensors': SafetensorsFileMetadata(...)})>>>metadata.files_metadata["model.safetensors"].metadata{'format':'pt'}# Parse repo with sharded model>>>metadata = get_safetensors_metadata("bigscience/bloom")Parse safetensors files:100%|██████████████████████████████████████████|72/72 [00:12<00:00,5.78it/s]>>>metadataSafetensorsRepoMetadata(metadata={'total_size':352494542848}, sharded=True, weight_map={...}, files_metadata={...})>>>len(metadata.files_metadata)72# All safetensors files have been fetched# Parse repo with sharded model>>>get_safetensors_metadata("runwayml/stable-diffusion-v1-5")NotASafetensorsRepoError:'runwayml/stable-diffusion-v1-5'isnot a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files.

Parameters

• repo_id (str) —ID of the repo to update. Example:"bigcode/in-the-stack".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Runtime information about a Space including Space stage and hardware.

Parameters

• repo_id (str) —ID of the repo to query. Example:"bigcode/in-the-stack".
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Parameters

• username (str) —Username of the user to get an overview of.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

AUser object with the user’s overview.

• HfHubHTTPError —HTTP 404 If the user does not exist on the Hub.

Parameters

• webhook_id (str) —The unique identifier of the webhook to get.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally saved token, which is the recommendedmethod for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

Info about the webhook.

>>>from huggingface_hubimport get_webhook>>>webhook = get_webhook("654bbbc16f2ec14d77f109cc")>>>print(webhook)WebhookInfo(id="654bbbc16f2ec14d77f109cc",    job=None,    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",    secret="my-secret",    domains=["repo","discussion"],    disabled=False,)

Parameters

• repo_id (str) —The id of the repo to grant access to.
• user (str) —The username of the user to grant access.
• repo_type (str,optional) —The type of the repo to grant access to. Must be one ofmodel,dataset orspace.Defaults tomodel.
• token (bool orstr,optional) —A valid user access token (string). Defaults to the locally savedtoken, which is the recommended method for authentication (seehttps://huggingface.co/docs/huggingface_hub/quick-start#authentication).To disable authentication, passFalse.

• HfHubHTTPError —HTTP 400 if the repo is not gated.
• HfHubHTTPError —HTTP 400 if the user already has access to the repo.
• HfHubHTTPError —HTTP 403 if you only have read-only access to the repo. This can be the case if you don’t havewriteoradmin role in the organization the repo belongs to or if you passed aread token.
• HfHubHTTPError —HTTP 404 if the user does not exist on the Hub.