# Cliente HfApi A continuación se muestra la documentación de la clase `HfApi`, que actúa como un envoltorio de Python para la API del Hugging Face Hub. Todos los métodos de `HfApi` también son accesibles directamente desde la raíz del paquete. Ambos enfoques se detallan a continuación. Usar el método raíz es más directo, pero la clase [HfApi](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi) te ofrece más flexibilidad. En particular, puedes pasar un token que se reutilizará en todas las llamadas HTTP. Esto es diferente de `hf auth login` o [login()](/docs/huggingface_hub/v2.4.0/es/package_reference/authentication#huggingface_hub.login), ya que el token no se persiste en la máquina. También es posible proporcionar un endpoint diferente o configurar un user-agent personalizado. ```python from huggingface_hub import HfApi, list_models # Use root method models = list_models() # Or configure a HfApi client hf_api = HfApi( endpoint="https://huggingface.co", # Can be a Private Hub endpoint. token="hf_xxx", # Token is not persisted on the machine. ) models = hf_api.list_models() ``` ## HfApi[[huggingface_hub.HfApi]] #### huggingface_hub.HfApi[[huggingface_hub.HfApi]] ```python huggingface_hub.HfApi(endpoint: str | None = None, token: str | bool | None = None, library_name: str | None = None, library_version: str | None = None, user_agent: dict | str | None = None, headers: dict[str, str] | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2127) **Parámetros:** endpoint (`str`, *opcional*) : Punto de acceso del Hub. El valor predeterminado es . token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. library_name (`str`, *opcional*) : El nombre de la biblioteca que está realizando la solicitud HTTP. Se añadirá a la cabecera user-agent. Ejemplo: `"transformers"`. library_version (`str`, *opcional*) : La versión de la biblioteca que está realizando la solicitud HTTP. Se añadirá al encabezado user-agent. Ejemplo: `"4.24.0"`. user_agent (`str`, `dict`, *opcional*) : La información del agente de usuario en forma de un diccionario o una sola cadena de caracteres. Se completará con información sobre los paquetes instalados. headers (`dict`, *opcional*) : Encabezados adicionales que se enviarán con cada solicitud. Ejemplo: `{"X-My-Header": "value"}`. Los encabezados pasados aquí tienen prioridad sobre los encabezados predeterminados. Cliente para interactuar con el Hugging Face Hub a través de HTTP. El cliente se inicializa con algunas configuraciones de alto nivel que se utilizan en todas las solicitudes realizadas al Hub (punto de acceso de HF, autenticación, agentes de usuario...). Se prefiere usar el cliente `HfApi`, aunque no es obligatorio, ya que todos sus métodos públicos se exponen directamente en la raíz de `huggingface_hub`. #### accept_access_request[[huggingface_hub.HfApi.accept_access_request]] ```python accept_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10873) **Parámetros:** repo_id (`str`) : El id del repositorio para el cual se acepta la solicitud de acceso. user (`str`, *opcional*) : El nombre de usuario del usuario cuya solicitud de acceso debe aceptarse. Debe proporcionarse exactamente uno de `user` o `request_id`. request_id (`str`, *opcional*) : El identificador de la solicitud de acceso a aceptar (ver `AccessRequest`). Obligatorio cuando el repositorio está configurado para no compartir los nombres de usuario de los solicitantes. Debe proporcionarse exactamente uno de `user` o `request_id`. repo_type (`str`, *opcional*) : El tipo de repositorio para el que se acepta la solicitud de acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. - `HfHubHTTPError` -- HTTP 404 si el usuario no existe en el Hub. - `HfHubHTTPError` -- HTTP 404 si no se puede encontrar la solicitud de acceso del usuario. - `HfHubHTTPError` -- HTTP 404 si la solicitud de acceso del usuario ya está en la lista de aceptados. Aceptar una solicitud de acceso de un usuario para un repositorio con control de acceso determinado. Una vez que la solicitud se acepta, el usuario podrá descargar cualquier archivo del repositorio y acceder a la pestaña de la comunidad. Si el modo de aprobación es automático, no es necesario aceptar las solicitudes manualmente. Una solicitud aceptada puede cancelarse o rechazarse en cualquier momento mediante [cancel_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) y [reject_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. #### add_collection_item[[huggingface_hub.HfApi.add_collection_item]] ```python add_collection_item(collection_slug: str, item_id: str, item_type: CollectionItemType_T, note: str | None = None, exists_ok: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10411) **Parámetros:** collection_slug (`str`) : Slug de la colección a actualizar. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_id (`str`) : Id del elemento que se va a añadir a la colección. Utilice el repo_id para repos/spaces/datasets, el id del paper para papers, el slug de otra colección (p. ej. `"moonshotai/kimi-k2"`) o un bucket id (p. ej. `"namespace/bucket-name"`). item_type (`str`) : Tipo del elemento a añadir. Puede ser uno de `"model"`, `"dataset"`, `"space"`, `"paper"`, `"collection"` o `"bucket"`. note (`str`, *opcional*) : Una nota para adjuntar al elemento en la colección. El tamaño máximo de una nota es de 500 caracteres. exists_ok (`bool`, *opcional*) : Si `True`, no se lanza un error si el elemento ya existe. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. - `HfHubHTTPError` -- HTTP 404 si el elemento que intentas añadir a la colección no existe en el Hub. - `HfHubHTTPError` -- HTTP 409 si el elemento que intentas añadir a la colección ya está en la colección (y exists_ok=False) Añade un elemento a una colección en el Hub. Devuelve: [Collection](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.Collection) Ejemplo: ```py >>> from huggingface_hub import add_collection_item >>> collection = add_collection_item( ... collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab", ... item_id="pierre-loic/climate-news-articles", ... item_type="dataset" ... ) >>> collection.items[-1].item_id "pierre-loic/climate-news-articles" # ^item got added to the collection on last position # Add item with a note >>> add_collection_item( ... collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab", ... item_id="datasets/climate_fever", ... item_type="dataset", ... note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet." ... ) (...) ``` #### add_space_secret[[huggingface_hub.HfApi.add_space_secret]] ```python add_space_secret(repo_id: str, key: str, value: str, description: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8043) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. key (`str`) : Clave secreta. Ejemplo: `"GITHUB_API_KEY"` value (`str`) : Valor secreto. Ejemplo: `"your_github_api_key"`. description (`str`, *opcional*) : Descripción del secreto. Ejemplo: `"Github API key to access the Github API"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Añade o actualiza un secreto en un Space. Los secretos permiten establecer claves o tokens secretos en un Space sin codificarlos directamente. Para más detalles, consulte https://huggingface.co/docs/hub/spaces-overview#managing-secrets. #### add_space_variable[[huggingface_hub.HfApi.add_space_variable]] ```python add_space_variable(repo_id: str, key: str, value: str, description: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8169) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. key (`str`) : Clave de variable. Ejemplo: `"MODEL_REPO_ID"` value (`str`) : Valor de la variable. Ejemplo: `"the_model_repo_id"`. description (`str`) : Descripción de la variable. Ejemplo: `"Model Repo ID of the implemented model"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Añade o actualiza una variable en un Space. Las variables permiten establecer variables de entorno en un Space sin codificarlas directamente. Para más detalles, consulte https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables #### auth_check[[huggingface_hub.HfApi.auth_check]] ```python auth_check(repo_id: str, repo_type: str | None = None, token: bool | str | None = None, write: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12047) **Parámetros:** repo_id (`str`) : El repositorio para el que se debe verificar el acceso. El formato debe ser `"user/repo_name"`. Ejemplo: `"user/my-cool-model"`. repo_type (`str`, *opcional*) : El tipo de repositorio. Debe ser uno de `"model"`, `"dataset"` o `"space"`. Si no se especifica, el valor predeterminado es `"model"`. token (`Union[bool, str, None]`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. write (`bool`, *opcional*) : Si es `True`, comprueba si el usuario tiene permiso de escritura de contenido en el repositorio. Si es `False` (predeterminado), solo comprueba el acceso de lectura. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [GatedRepoError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.GatedRepoError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Se lanza si el repositorio no existe, es privado o el usuario no tiene acceso. Esto puede ocurrir si `repo_id` o `repo_type` son incorrectos, o si el repositorio es privado pero el usuario no está autenticado. - [GatedRepoError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.GatedRepoError) -- Se lanza si el repositorio existe pero está restringido y el usuario no está autorizado para acceder a él. Comprueba si el token de usuario proporcionado tiene acceso a un repositorio específico en el Hugging Face Hub. Este método verifica si el usuario, autenticado mediante el token proporcionado, tiene acceso al repositorio especificado. Si el repositorio no se encuentra o si el usuario carece de los permisos necesarios para acceder a él, el método lanza una excepción apropiada. Ejemplo: Comprueba si el usuario tiene acceso a un repositorio: ```python >>> from huggingface_hub import auth_check >>> from huggingface_hub.utils import GatedRepoError, RepositoryNotFoundError try: auth_check("user/my-cool-model") except GatedRepoError: # Handle gated repository error print("You do not have permission to access this gated repository.") except RepositoryNotFoundError: # Handle repository not found error print("The repository was not found or you do not have access.") ``` En este ejemplo: - Si el usuario tiene acceso, el método se completa correctamente. - Si el repositorio está restringido o no existe, se lanzan las excepciones correspondientes, lo que permite al usuario para tratarlos en consecuencia. #### batch_bucket_files[[huggingface_hub.HfApi.batch_bucket_files]] ```python batch_bucket_files(bucket_id: str, add: list[tuple[str | Path | bytes, str]] | None = None, copy: list[tuple[str, str, str, str]] | None = None, delete: list[str] | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14729) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). add (`list` de `tuple`, *opcional*) : Archivos para subir. Cada elemento es una tupla `(source, destination)` donde `source` es una ruta a un archivo local (`str` o `Path`) o contenido en `bytes` crudo, y `destination` es la ruta en el bucket. copy (`list` de `tuple`, *opcional*) : Archivos para copiar por hash de xet. Cada elemento es una tupla `(source_repo_type, source_repo_id, xet_hash, destination)` donde: - `source_repo_type` es el tipo de repositorio de origen: `"model"`, `"dataset"`, `"space"` o `"bucket"`. - `source_repo_id` es el ID del repositorio o bucket de origen (p. ej. `"username/my-model"`). - `xet_hash` es el hash de xet del archivo a copiar. - `destination` es la ruta de destino en el bucket. Esta es una operación del lado del servidor: no se descarga ni se vuelve a subir ningún dato. delete (`list` de `str`, *opcional*) : Rutas de los archivos que se eliminarán del bucket. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `BucketBatchError` - `BucketBatchError` -- Si el servidor informa de que algunas operaciones fallaron. El error se lanza una vez que se ha enviado cada operación, por lo que las demás operaciones del lote se han aplicado. Agrega, copia y/o elimina archivos en un bucket. Esta es una operación no transaccional. Si se produce un error durante el proceso, es posible que algunos archivos se hayan subido, copiado o eliminado, mientras que otros no. Ejemplo: ```python >>> from huggingface_hub import batch_bucket_files # Upload files >>> batch_bucket_files( ... "username/my-bucket", ... add=[ ... ("./model.safetensors", "models/model.safetensors"), ... (b'{{"key": "value"}}', "config.json"), ... ], ... ) # Copy xet files from another bucket or repo (server-side, no data transfer) >>> batch_bucket_files( ... "username/my-bucket", ... copy=[ ... ("bucket", "username/source-bucket", "", "models/model.safetensors"), ... ("model", "username/my-model", "", "models/config.safetensors"), ... ], ... ) # Delete files >>> batch_bucket_files("username/my-bucket", delete=["old-model.bin"]) # Upload and delete in one batch >>> batch_bucket_files( ... "username/my-bucket", ... add=[("./new.txt", "new.txt")], ... delete=["old.txt"], ... ) ``` #### bucket_info[[huggingface_hub.HfApi.bucket_info]] ```python bucket_info(bucket_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14058) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [BucketInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketInfo) La información del cubo. **Excepciones:** `BucketNotFoundError` o ``or`` - `BucketNotFoundError` -- Si no se puede encontrar el bucket. Esto puede deberse a que no existe, - ``or`` -- porque está configurado como `private` y no tienes acceso. Obtén información sobre un bucket específico en el Hub. Ejemplo: ```python >>> from huggingface_hub import bucket_info >>> info = bucket_info(bucket_id="Wauplin/first-bucket") >>> info.id 'Wauplin/first-bucket' >>> info.private False >>> info.created_at datetime.datetime(2026, 2, 6, 17, 37, 57, tzinfo=datetime.timezone.utc) >>> info.size 551879671 >>> info.total_files 12 ``` #### cancel_access_request[[huggingface_hub.HfApi.cancel_access_request]] ```python cancel_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10823) **Parámetros:** repo_id (`str`) : El id del repositorio para el que se debe cancelar la solicitud de acceso. user (`str`, *opcional*) : El nombre de usuario del usuario cuya solicitud de acceso debe cancelarse. Debe proporcionarse exactamente uno de `user` o `request_id`. request_id (`str`, *opcional*) : El identificador de la solicitud de acceso a cancelar (ver `AccessRequest`). Obligatorio cuando el repositorio está configurado para no compartir los nombres de usuario de los solicitantes. Debe proporcionarse exactamente uno de `user` o `request_id`. repo_type (`str`, *opcional*) : El tipo de repositorio para el que se cancela la solicitud de acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. - `HfHubHTTPError` -- HTTP 404 si el usuario no existe en el Hub. - `HfHubHTTPError` -- HTTP 404 si no se puede encontrar la solicitud de acceso del usuario. - `HfHubHTTPError` -- HTTP 404 si la solicitud de acceso del usuario ya está en la lista de pendientes. Cancelar una solicitud de acceso de un usuario para un repositorio con acceso restringido dado. Una solicitud cancelada volverá a la lista de pendientes y el usuario perderá el acceso al repositorio. Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. #### cancel_job[[huggingface_hub.HfApi.cancel_job]] ```python cancel_job(job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12757) **Parámetros:** job_id (`str`) : ID del trabajo. namespace (`str`, *opcional*) : El espacio de nombres donde se está ejecutando el Job. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Cancelar un Job de cómputo en la infraestructura de Hugging Face. #### change_discussion_status[[huggingface_hub.HfApi.change_discussion_status]] ```python change_discussion_status(repo_id: str, discussion_num: int, new_status: Literal['open', 'closed'], token: bool | str | None = None, comment: str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7756) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. new_status (`str`) : El nuevo estado de la discusión, ya sea `"open"` o `"closed"`. comment (`str`, *opcional*) : Un comentario opcional para publicar junto con el cambio de estado. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [DiscussionStatusChange](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionStatusChange) el evento de cambio de estado Cierra o vuelve a abrir una Discusión o una Pull Request. Ejemplos: ```python >>> HfApi().change_discussion_status( ... repo_id="username/repo_name", ... discussion_num=34, ... new_status="closed" ... ) # DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...) ``` > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### comment_discussion[[huggingface_hub.HfApi.comment_discussion]] ```python comment_discussion(repo_id: str, discussion_num: int, comment: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7613) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. comment (`str`) : El contenido del comentario a crear. Los comentarios admiten formato markdown. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionComment) el comentario recién creado Crea un nuevo comentario en la Discusión indicada. Ejemplos: ```python >>> comment = """ ... Hello @otheruser! ... ... # This is a title ... ... **This is bold**, *this is italic* and ~this is strikethrough~ ... And [this](http://url) is a link ... """ >>> HfApi().comment_discussion( ... repo_id="username/repo_name", ... discussion_num=34, ... comment=comment ... ) # DiscussionComment(id='deadbeef0000000', type='comment', ...) ``` > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### copy_files[[huggingface_hub.HfApi.copy_files]] ```python copy_files(source: str, destination: str, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14410) **Parámetros:** source (`str`) : Ubicación de origen como un URI `hf://`. Puede ser una ruta de bucket (p. ej. `"hf://buckets/my-bucket/path/to/file"`) o una ruta de repositorio (p. ej. `"hf://username/my-model/weights.bin"`, `"hf://datasets/username/my-dataset/data/"`). destination (`str`) : Ubicación de destino como un URI `hf://` que apunta a un bucket (p. ej. `"hf://buckets/my-bucket/target/path"`) o a un repositorio (p. ej. `"hf://username/my-model/target/path"`). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si las URI de origen/destino no son válidas o si se intenta copiar desde un bucket a un repositorio. Copiar archivos entre ubicaciones en el Hub. Copiar archivos de un bucket o de un repositorio (modelo, dataset, space) a un bucket o a otro repositorio. Se admiten tanto archivos individuales como carpetas completas. Al copiar carpetas, una barra final `/` en la ruta de origen utiliza semánticas de estilo rsync: copia el *contenido* de la carpeta en el destino, sin anidar la propia carpeta de origen. Sin una barra final `/`, la carpeta de origen se anida dentro del destino (como `cp -r`). Al copiar de un repositorio a un bucket, los archivos `.gitattributes` se excluyen automáticamente, ya que son metadatos específicos de git y no son relevantes en el contexto de un bucket. Las copias de repositorio a repositorio utilizan [CommitOperationCopy](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitOperationCopy) internamente y crean un commit en el repositorio de destino. No se admiten copias de bucket a repositorio. > [!WARNING] > Las copias del lado del servidor solo funcionan dentro de la misma [región de almacenamiento](https://huggingface.co/docs/hub/storage-regions). Ejemplo: ```python >>> from huggingface_hub import copy_files # Copy a single file between buckets >>> copy_files("hf://buckets/my-bucket/data.bin", "hf://buckets/other-bucket/data.bin") # Copy a folder into another bucket (nests: backup/models/...) >>> copy_files("hf://buckets/my-bucket/models", "hf://buckets/other-bucket/backup/") # Copy folder contents (trailing /): files go directly into backup/ >>> copy_files("hf://buckets/my-bucket/models/", "hf://buckets/other-bucket/backup/") # Copy a file from a model repo to a bucket >>> copy_files("hf://username/my-model/model.safetensors", "hf://buckets/my-bucket/") # Copy an entire dataset to a bucket >>> copy_files("hf://datasets/username/my-dataset/", "hf://buckets/my-bucket/datasets/") # Copy files between repositories >>> copy_files("hf://username/source-model/", "hf://username/dest-model/") # Copy a file from one repo to another >>> copy_files("hf://username/source-model/config.json", "hf://username/dest-model/config.json") ``` #### create_branch[[huggingface_hub.HfApi.create_branch]] ```python create_branch(repo_id: str, branch: str, revision: str | None = None, token: bool | str | None = None, repo_type: str | None = None, exist_ok: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6963) **Parámetros:** repo_id (`str`) : El repositorio en el que se creará la rama. Ejemplo: `"user/my-cool-model"`. branch (`str`) : El nombre de la rama a crear. revision (`str`, *opcional*) : La revisión de git desde la que se creará la rama. Puede ser el nombre de una rama o el OID/SHA de un commit, como una cadena hexadecimal. El valor predeterminado es el final de la rama `"main"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está creando una rama en un dataset o space, `None` o `"model"` si está etiquetando un modelo. El valor predeterminado es `None`. exist_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanza un error si la rama ya existe. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Si la referencia de la rama no es válida. Ej.: `refs/pr/5` o 'refs/foo/bar'. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Si la rama ya existe en el repositorio (error 409) y `exist_ok` está establecido en `False`. Crea una nueva rama para un repositorio en el Hub, a partir de la revisión especificada (por defecto, `main`). Para encontrar una revisión adecuada a tus necesidades, puedes usar [list_repo_refs()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_repo_refs) o [list_repo_commits()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_repo_commits). #### create_bucket[[huggingface_hub.HfApi.create_bucket]] ```python create_bucket(bucket_id: str, private: bool | None = None, visibility: Literal['public', 'private'] | None = None, resource_group_id: str | None = None, region: REPO_REGIONS | None = None, exist_ok: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13950) **Parámetros:** bucket_id (`str`) : Un espacio de nombres (de usuario u organización) y un nombre de cubo separados por `/`. Si no se proporciona un espacio de nombres, el cubo se creará en el espacio de nombres del usuario actual. private (`bool`, *opcional*) : Si se debe hacer el bucket privado. Si es `None` (predeterminado), el bucket será público a menos que el valor predeterminado de la organización sea privado. No se puede pasar junto con `visibility`. visibility (`Literal["public", "private"]`, *opcional*) : Visibilidad del bucket. Puede ser `"public"` o `"private"`. Si es `None` (predeterminado), el bucket será público a menos que el valor predeterminado de la organización sea privado. resource_group_id (`str`, *opcional*) : Grupo de recursos en el que se creará el bucket. Los grupos de recursos solo están disponibles para organizaciones Enterprise Hub y permiten definir qué miembros de la organización pueden acceder al recurso. El ID de un grupo de recursos se puede encontrar en la URL de la página del recurso en el Hub (p. ej. `"66670e5163145ca562cb1988"`). Para obtener más información sobre los grupos de recursos, consulte https://huggingface.co/docs/hub/en/security-resource-groups. region (`Literal["us", "eu"]`, *opcional*) : Región de la nube en la que se creará el bucket. Puede ser `"us"` o `"eu"`. Si no se especifica, el bucket se creará en la región predeterminada. Requiere el plan Team o superior. exist_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanzará un error si el bucket ya existe. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [BucketUrl](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketUrl) URL del bucket recién creado que contiene atributos como `endpoint`, `namespace` y `bucket_id`. Crea un bucket en el Hub. Ejemplo: ```python >>> from huggingface_hub import create_bucket >>> url = create_bucket(bucket_id="my-bucket") >>> url.bucket_id 'user/my-bucket' >>> url.url 'https://huggingface.co/buckets/user/my-bucket' >>> url.uri.to_uri() 'hf://buckets/user/my-bucket' >>> create_bucket(bucket_id="my-bucket", private=True, exist_ok=True) BucketUrl(...) >>> create_bucket(bucket_id="my-bucket", region="us") BucketUrl(...) ``` #### create_collection[[huggingface_hub.HfApi.create_collection]] ```python create_collection(title: str, namespace: str | None = None, description: str | None = None, private: bool = False, resource_group_id: str | None = None, exists_ok: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10191) **Parámetros:** title (`str`) : Título de la colección a crear. Ejemplo: `"Recent models"`. namespace (`str`, *opcional*) : Espacio de nombres de la colección a crear (nombre de usuario u organización). Por defecto, se usará el nombre del propietario. description (`str`, *opcional*) : Descripción de la colección a crear. El tamaño máximo para una descripción es de 150 caracteres. private (`bool`, *opcional*) : Si la colección debe ser privada o no. El valor predeterminado es `False` (es decir, colección pública). resource_group_id (`str`, *opcional*) : Asigna la colección a un grupo de recursos de la organización propietaria. Solo es válido para colecciones propiedad de la organización. El ID del grupo de recursos es una cadena hexadecimal de 24 caracteres. exists_ok (`bool`, *opcional*) : Si `True`, no se lanza un error si la colección ya existe. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Crea una nueva Collection en el Hub. Devuelve: [Collection](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.Collection) Ejemplo: ```py >>> from huggingface_hub import create_collection >>> collection = create_collection( ... title="ICCV 2023", ... description="Portfolio of models, papers and demos I presented at ICCV 2023", ... ) >>> collection.slug "username/iccv-2023-64f9a55bb3115b4f513ec026" ``` #### create_commit[[huggingface_hub.HfApi.create_commit]] ```python create_commit(repo_id: str, operations: Iterable[CommitOperation], commit_message: str, commit_description: str | None = None, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, num_threads: int = 5, parent_commit: str | None = None, run_as_future: bool = False, _hot_reload: bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5016) **Parámetros:** repo_id (`str`) : El repositorio en el que se creará el commit, por ejemplo: `"username/custom_transformers"` operations (`Iterable` de `~hf_api.CommitOperation`) : Un iterable de operaciones para incluir en el commit, ya sea: - `~hf_api.CommitOperationAdd` para subir un archivo - `~hf_api.CommitOperationDelete` para eliminar un archivo - `~hf_api.CommitOperationCopy` para copiar un archivo Los objetos de operación se modificarán para incluir información relativa a la subida. No reutilice los mismos objetos para varios commits. commit_message (`str`) : El resumen (primera línea) del commit que se creará. commit_description (`str`, *opcional*) : La descripción del commit que se creará token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"`, `"space"` o `"kernel"` si se sube a un repositorio de dataset, space o kernel, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. create_pr (`boolean`, *opcional*) : Si se debe o no crear una Pull Request con ese commit. El valor predeterminado es `False`. Si `revision` no está establecido, la PR se abre contra la rama `"main"`. Si `revision` está establecido y es una rama, la PR se abre contra esta rama. Si `revision` está establecido y no es el nombre de una rama (por ejemplo, un oid de commit), el servidor devuelve un `RevisionNotFoundError`. num_threads (`int`, *opcional*) : Número de hilos concurrentes para la carga de archivos. El valor predeterminado es 5. Establecerlo en 2 significa que se cargarán como máximo 2 archivos de forma concurrente. parent_commit (`str`, *opcional*) : El OID / SHA del commit padre, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). Si se especifica y `create_pr` es `False`, el commit fallará si `revision` no apunta a `parent_commit`. Si se especifica y `create_pr` es `True`, la pull request se creará desde `parent_commit`. Especificar `parent_commit` garantiza que el repositorio no haya cambiado antes de confirmar los cambios, y puede ser especialmente útil si el repositorio se actualiza / confirma de forma concurrente. run_as_future (`bool`, *opcional*) : Indica si se debe ejecutar este método en segundo plano. Las tareas en segundo plano se ejecutan de forma secuencial sin bloquear el hilo principal. Si se pasa `run_as_future=True`, se devolverá un objeto [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects). El valor predeterminado es `False`. **Devuelve:** [CommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitInfo) o `Future` Instancia de [CommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitInfo) que contiene información sobre el commit recién creado (hash del commit, url del commit, url del pr, mensaje del commit, ...). Si se pasa `run_as_future=True`, devuelve un objeto Future que contendrá el resultado cuando se ejecute. **Excepciones:** ``ValueError`` o [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si el mensaje de commit está vacío. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si el commit padre no es un OID de commit válido. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si se envía un archivo README.md con una sección de metadatos no válida. En este caso, el envío fallará de forma temprana, antes de intentar subir ningún archivo. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si `create_pr` es `True` y la revisión no es ni `None` ni `"main"`. - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. Crea un commit en el repositorio dado, eliminando y subiendo archivos según sea necesario. > [!WARNING] > La lista de entrada de `CommitOperation` se mutará durante el proceso de commit. No reutilice los mismos objetos para varios commits. > [!WARNING] > `create_commit` asume que el repositorio ya existe en el Hub. Si obtienes un error de cliente 404, asegúrate de que estás autenticado, de que tu token tiene los permisos necesarios y de que `repo_id` y `repo_type` están configurados correctamente. Si el repositorio no existe, créalo primero usando [create_repo()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_repo). > [!WARNING] > `create_commit` está limitado a 25k archivos LFS y a una carga de 1 GB para archivos regulares. #### create_discussion[[huggingface_hub.HfApi.create_discussion]] ```python create_discussion(repo_id: str, title: str, token: bool | str | None = None, description: str | None = None, repo_type: str | None = None, pull_request: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7440) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. title (`str`) : El título de la discusión. Puede tener hasta 200 caracteres y debe tener al menos 3 caracteres. Se eliminarán los espacios en blanco iniciales y finales. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. description (`str`, *opcional*) : Una descripción opcional para la Pull Request. El valor predeterminado es `"Discussion opened with the huggingface_hub Python library"` pull_request (`bool`, *opcional*) : Si se debe crear una Pull Request o una discusión. Si es `True`, crea una Pull Request. Si es `False`, crea una discusión. El valor predeterminado es `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. Crea una Discusión o una Pull Request. Los Pull Requests creados de forma programática estarán en estado `"draft"`. También es posible crear una Pull Request con los cambios de una sola vez con [HfApi.create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit). Devuelve: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionWithDetails) > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### create_inference_endpoint[[huggingface_hub.HfApi.create_inference_endpoint]] ```python create_inference_endpoint(name: str, repository: str, framework: str, accelerator: str, instance_size: str, instance_type: str, region: str, vendor: str, account_id: str | None = None, private_link_account_id: str | None = None, private_link_region: str | None = None, min_replica: int = 1, max_replica: int = 1, scaling_metric: InferenceEndpointScalingMetric | None = None, scaling_threshold: float | None = None, scale_to_zero_timeout: int | None = None, revision: str | None = None, task: str | None = None, custom_image: dict | None = None, container_registry_username: str | None = None, container_registry_password: str | None = None, container_command: list[str] | None = None, container_args: list[str] | None = None, env: dict[str, str] | None = None, secrets: dict[str, str] | None = None, type: InferenceEndpointType | str = , domain: str | None = None, path: str | None = None, cache_http_responses: bool | None = None, tags: list[str] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9205) **Parámetros:** name (`str`) : El nombre único para el nuevo Inference Endpoint. repository (`str`) : El nombre del repositorio de modelos asociado con el Inference Endpoint (p. ej. `"gpt2"`). framework (`str`) : El marco de aprendizaje automático utilizado para el modelo (p. ej. `"custom"`). accelerator (`str`) : El acelerador de hardware que se utilizará para la inferencia (p. ej. `"cpu"`). instance_size (`str`) : El tamaño o tipo de la instancia que se utilizará para alojar el modelo (p. ej. `"x4"`). instance_type (`str`) : El tipo de instancia en la nube donde se desplegará el Inference Endpoint (p. ej. `"intel-icl"`). region (`str`) : La región de la nube en la que se creará el Inference Endpoint (p. ej. `"us-east-1"`). vendor (`str`) : El proveedor de nube o editor donde se alojará el Inference Endpoint (p. ej. `"aws"`). account_id (`str`, *opcional*) : Obsoleto e ignorado. Use `private_link_account_id` y `private_link_region` para configurar AWS PrivateLink. private_link_account_id (`str`, *opcional*) : El ID de la cuenta de AWS autorizado para acceder al Inference Endpoint a través de AWS PrivateLink. Requiere `private_link_region`. private_link_region (`str`, *opcional*) : La región de AWS del punto de entrada de PrivateLink (`"us-east-1"` o `"eu-west-1"`), donde se conectará el endpoint de VPC de `private_link_account_id`. Independiente de la `region` y el `vendor` de cómputo. min_replica (`int`, *opcional*) : El número mínimo de réplicas (instancias) que deben mantenerse en ejecución para el Inference Endpoint. Para habilitar el escalado a cero, establezca este valor en 0 y ajuste `scale_to_zero_timeout` en consecuencia. El valor predeterminado es 1. max_replica (`int`, *opcional*) : El número máximo de réplicas (instancias) al que escalar el Inference Endpoint. El valor predeterminado es 1. scaling_metric (`str` o `InferenceEndpointScalingMetric `, *opcional*) : La referencia de la métrica para el escalado. Puede ser "pendingRequests" o "hardwareUsage" cuando se proporciona. El valor predeterminado es None (lo que significa: dejar que el servicio HF Endpoints especifique la métrica). scaling_threshold (`float`, *opcional*) : Umbral de la métrica de escalado utilizado para activar un aumento de escala. Se ignora cuando no se proporciona la métrica de escalado. El valor predeterminado es None (lo que significa: dejar que el servicio HF Endpoints especifique el umbral). scale_to_zero_timeout (`int`, *opcional*) : La duración en minutos antes de que un punto de acceso inactivo se escale a cero, o sin escala a cero si se establece en None y `min_replica` no es 0. El valor predeterminado es None. revision (`str`, *opcional*) : La revisión específica del modelo que se desplegará en el Inference Endpoint (p. ej. `"6c0e6080953db56375760c0471a8c5f2929baf11"`). task (`str`, *opcional*) : La tarea en la que se desplegará el modelo (p. ej. `"text-classification"`). custom_image (`dict`, *opcional*) : La imagen de contenedor que se ejecutará. Puede ser un diccionario con claves por variante de imagen (p. ej. `{"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}}`, también `sGLang`, `tgi`, `tei`, `llamacpp`, `hfServe`, ...), que se reenvía tal cual, o un diccionario plano que describe un contenedor personalizado (p. ej. `{"url": ..., "port": ...}`), que se envía como `{"custom": ...}` (véase los ejemplos). Por defecto, se utiliza la imagen gestionada por Hugging Face. container_registry_username (`str`, *opcional*) : Nombre de usuario utilizado para autenticarse con el registro que aloja una imagen de contenedor personalizada. container_registry_password (`str`, *opcional*) : Contraseña utilizada para autenticarse con el registro que aloja una imagen de contenedor personalizada. Requiere `container_registry_username`. Se omite del payload de la API cuando no se proporciona. container_command (`list[str]`, *opcional*) : Anula el comando de punto de entrada del contenedor (se corresponde con `model.command` en la carga de la API). Funciona tanto con imágenes de motor administradas (p. ej., vLLM, SGLang) como con imágenes personalizadas. container_args (`list[str]`, *opcional*) : Argumentos añadidos al punto de entrada del contenedor (corresponde a `model.args` en la carga de la API). Funciona tanto con imágenes de motor administradas (p. ej., vLLM, SGLang) como con imágenes personalizadas. env (`dict[str, str]`, *opcional*) : Variables de entorno no secretas para inyectar en el entorno del contenedor. secrets (`dict[str, str]`, *opcional*) : Valores secretos para inyectar en el entorno del contenedor. type ([`InferenceEndpointType]`, *opcional*) : El tipo del Inference Endpoint, que puede ser `"authenticated"` (predeterminado), `"public"` o `"private"`. domain (`str`, *opcional*) : El dominio personalizado para la implementación del Inference Endpoint; si se configura, el punto de inferencia estará disponible en este dominio (p. ej., `"my-new-domain.cool-website.woof"`). path (`str`, *opcional*) : La ruta personalizada del modelo desplegado, debe comenzar con `/` (p. ej. `"/models/google-bert/bert-base-uncased"`). cache_http_responses (`bool`, *opcional*) : Si se deben cachear las respuestas HTTP del Inference Endpoint. El valor predeterminado es `False`. tags (`list[str]`, *opcional*) : Una lista de etiquetas para asociar con el Inference Endpoint. namespace (`str`, *opcional*) : El espacio de nombres donde se creará el Inference Endpoint. Por defecto, se utiliza el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el Inference Endpoint actualizado. Cree un nuevo Inference Endpoint. Los valores de `accelerator`, `instance_size`, `instance_type`, `region` y `vendor` dependen entre sí; use [list_inference_endpoints_hardware()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_inference_endpoints_hardware) para listar las combinaciones válidas. Ejemplo: ```python >>> from huggingface_hub import 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="authenticated", ... instance_size="x2", ... instance_type="intel-icl", ... ) >>> endpoint InferenceEndpoint(name='my-endpoint-name', status="pending",...) # Run inference on the endpoint >>> endpoint.client.text_generation(...) "..." ``` ```python # Start an Inference Endpoint running Zephyr-7b-beta on TGI >>> from huggingface_hub import HfApi >>> api = HfApi() >>> 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="authenticated", ... 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={ ... "healthRoute": "/health", ... "url": "ghcr.io/huggingface/text-generation-inference:1.1.0", ... }, ... secrets={"MY_SECRET_KEY": "secret_value"}, ... tags=["dev", "text-generation"], ... ) ``` ```python # Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes >>> from huggingface_hub import 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="authenticated", ... 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) ``` #### create_inference_endpoint_from_catalog[[huggingface_hub.HfApi.create_inference_endpoint_from_catalog]] ```python create_inference_endpoint_from_catalog(repo_id: str | None = None, recipe_id: str | None = None, name: str | None = None, accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = None, gguf_file: str | None = None, token: bool | str | None = None, namespace: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9502) **Parámetros:** repo_id (`str`, *opcional*) : El ID del modelo en el catálogo para desplegar como un Inference Endpoint. Mutuamente excluyente con `recipe_id`. recipe_id (`str`, *opcional*) : El ID de la receta del catálogo a desplegar (ver [InferenceCatalogRecipe](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceCatalogRecipe)). Mutuamente excluyente con `repo_id`. name (`str`, *opcional*) : El nombre único para el nuevo Inference Endpoint. Si no se proporciona, se generará un nombre aleatorio. accelerator (`str`, *opcional*) : El acelerador de hardware que se utilizará para la inferencia. Los valores posibles incluyen `"cpu"`, `"gpu"` y `"neuron"`. Si no se proporciona, el servidor utilizará un valor predeterminado adecuado para el modelo. Solo es válido con `repo_id`. gguf_file (`str`, *opcional*) : El archivo GGUF para desplegar, para modelos que tienen una receta por cuantización (p. ej. `"Qwen2.5-Coder-32B-Instruct-Q4_K_M.gguf"`). Solo válido con `repo_id`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). namespace (`str`, *opcional*) : El espacio de nombres donde se creará el Inference Endpoint. Por defecto, se utiliza el espacio de nombres del usuario actual. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el nuevo Inference Endpoint. Cree un nuevo Inference Endpoint desde el Inference Catalog de Hugging Face. El objetivo del Inference Catalog es proporcionar una lista curada de modelos optimizados para inferencia y para los cuales se han probado configuraciones predeterminadas. Consulte https://endpoints.huggingface.co/catalog para ver la lista de modelos disponibles en el catálogo. Cada modelo del catálogo se despliega mediante una *receta*: una combinación de hardware y motor que ha sido probada para él. Pasa `repo_id` para desplegar la receta predeterminada de un modelo, opcionalmente restringida con `accelerator` y `gguf_file`, o pasa `recipe_id` para desplegar una receta exacta listada por [list_inference_catalog()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_inference_catalog). > [!WARNING] > `create_inference_endpoint_from_catalog` es experimental. Su API está sujeta a cambios en el futuro. Por favor, proporcione comentarios si tiene sugerencias o solicitudes. #### create_pull_request[[huggingface_hub.HfApi.create_pull_request]] ```python create_pull_request(repo_id: str, title: str, token: bool | str | None = None, description: str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7529) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. title (`str`) : El título de la discusión. Puede tener hasta 200 caracteres y debe tener al menos 3 caracteres. Se eliminarán los espacios en blanco iniciales y finales. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. description (`str`, *opcional*) : Una descripción opcional para la Pull Request. El valor predeterminado es `"Discussion opened with the huggingface_hub Python library"` repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. Crea una Pull Request. Las Pull Requests creadas de forma programática estarán en estado `"draft"`. También es posible crear una Pull Request con los cambios de una sola vez con [HfApi.create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit); Este es un envoltorio alrededor de [HfApi.create_discussion()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_discussion). Devuelve: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionWithDetails) > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### create_repo[[huggingface_hub.HfApi.create_repo]] ```python create_repo(repo_id: str, token: str | bool | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, repo_type: str | None = None, exist_ok: bool = False, resource_group_id: str | None = None, region: REPO_REGIONS | None = None, space_sdk: str | None = None, space_hardware: SpaceHardware | None = None, space_sleep_time: int | None = None, space_secrets: list[dict[str, str]] | None = None, space_variables: list[dict[str, str]] | None = None, space_volumes: list[Volume] | None = None, space_template: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4576) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. private (`bool`, *opcional*) : Si se debe hacer el repositorio privado. Si es `None` (predeterminado), el repositorio será público a menos que el valor predeterminado de la organización sea privado. Este valor se ignora si el repositorio ya existe. No se puede pasar junto con `visibility`. visibility (`Literal["public", "private", "protected"]`, *opcional*) : Visibilidad del repositorio. Puede ser `"public"` o `"private"`, o `"protected"` para Spaces. Si es `None` (predeterminado), el repositorio será público a menos que el valor predeterminado de la organización sea privado. Este valor se ignora si el repositorio ya existe. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. exist_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanzará un error si el repositorio ya existe. resource_group_id (`str`, *opcional*) : Grupo de recursos en el que se creará el repositorio. Los grupos de recursos solo están disponibles para organizaciones de Enterprise Hub y permiten definir qué miembros de la organización pueden acceder al recurso. El ID de un grupo de recursos se puede encontrar en la URL de la página del recurso en el Hub (p. ej. `"66670e5163145ca562cb1988"`). Para obtener más información sobre los grupos de recursos, consulte https://huggingface.co/docs/hub/en/security-resource-groups. region (`Literal["us", "eu"]`, *opcional*) : Región de la nube en la que se creará el repositorio. Puede ser `"us"` o `"eu"`. Si no se especifica, el repositorio se creará en la región predeterminada. Requiere el plan Team o superior. space_sdk (`str`, *opcional*) : Elección del SDK a utilizar si repo_type es "space". Puede ser "streamlit", "gradio", "docker" o "static". Los Spaces `"static"` son gratuitos para todos. Los demás SDK se ejecutan en hardware de cómputo: en el hardware gratuito `cpu-basic`, requieren una suscripción (PRO para usuarios, Team o Enterprise para organizaciones), mientras que el hardware de pago solo requiere facturación (un método de pago y créditos prepagados). space_hardware (`SpaceHardware` o `str`, *opcional*) : Elección de Hardware si repo_type es "space". Consulte [SpaceHardware](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceHardware) para obtener una lista completa. space_sleep_time (`int`, *opcional*) : Número de segundos de inactividad que se espera antes de que un Space entre en modo de suspensión. Establezca `-1` si no desea que su Space entre en suspensión (comportamiento predeterminado para el hardware actualizado). Para el hardware gratuito, no puede configurar el tiempo de suspensión (el valor está fijo en 48 horas de inactividad). Consulte https://huggingface.co/docs/hub/spaces-gpus#sleep-time para obtener más detalles. space_secrets (`list[dict[str, str]]`, *opcional*) : Una lista de claves secretas para configurar en tu Space. Cada elemento tiene la forma `{"key": ..., "value": ..., "description": ...}` donde description es opcional. Para más detalles, consulta https://huggingface.co/docs/hub/spaces-overview#managing-secrets. space_variables (`list[dict[str, str]]`, *opcional*) : Una lista de variables de entorno públicas para establecer en tu Space. Cada elemento tiene la forma `{"key": ..., "value": ..., "description": ...}` donde description es opcional. Para más detalles, consulta https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables. space_volumes (`list[Volume]`, *opcional*) : Una lista de objetos [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) para montar en el Space en el momento de la creación. Cada volumen tiene un `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), un `source` (ID del repositorio o bucket), un `mount_path` (ruta dentro del contenedor) y los campos opcionales `revision`, `read_only` y `path`. Solo es aplicable si repo_type es "space". space_template (`str`, *opcional*) : Inicializa el nuevo Space a partir de una plantilla oficial. Puede ser el id del repositorio de la plantilla (p. ej. `"SpacesExamples/jupyterlab"`) o su nombre corto (p. ej. `"JupyterLab"`). Usa [HfApi.list_space_templates()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_space_templates) para listar las plantillas disponibles. Solo es aplicable si repo_type es "space". Si la plantilla se recomienda que sea privada y visibility no se establece explícitamente, el Space se crea como privado. **Devuelve:** [RepoUrl](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.RepoUrl) URL del repositorio recién creado. El valor es una subclase de `str` que contiene atributos como `endpoint`, `repo_type` y `repo_id`. Crea un repositorio vacío en el HuggingFace Hub. #### create_scheduled_job[[huggingface_hub.HfApi.create_scheduled_job]] ```python create_scheduled_job(image: str, command: list[str], schedule: str, suspend: bool | None = None, concurrency: bool | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13072) **Parámetros:** image (`str`) : La imagen de Docker que se va a utilizar. Ejemplos: `"ubuntu"`, `"python:3.12"`, `"pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"`. Ejemplo con una imagen de un Space: `"hf.co/spaces/lhoestq/duckdb"`. command (`list[str]`) : El comando a ejecutar. Ejemplo: `["echo", "hello"]`. schedule (`str`) : Uno de "@annually", "@yearly", "@monthly", "@weekly", "@daily", "@hourly", o una expresión de programación CRON (p. ej., '0 9 * * 1' para las 9:00 AM cada lunes). suspend (`bool`, *opcional*) : Si es True, el Job programado se suspende (se pausa). Por defecto, False. concurrency (`bool`, *opcional*) : Si es True, se pueden ejecutar varias instancias de este Job de forma concurrente. El valor predeterminado es False. env (`dict[str, Any]`, *opcional*) : Define las variables de entorno para el Job. secrets (`dict[str, Any]`, *opcional*) : Define las variables de entorno secretas para el Job. flavor (`str`, *opcional*) : Sabor para el hardware. Consulte `JobHardware` para los valores posibles. El valor predeterminado es `"cpu-basic"`. timeout (`Union[int, float, str]`, *opcional*) : Duración máxima para el Job: int con s (segundos, predeterminado), m (minutos), h (horas) o d (días). Ejemplo: `300` o `"5m"` para 5 minutos. attempts (`int`, *opcional*) : Número máximo de intentos para cada ejecución, incluido el intento inicial. El valor predeterminado es 1. name (`str`, *opcional*) : Un nombre para el Job programado. Se almacena como la etiqueta `name`. No se puede pasar junto con una clave `name` en `labels`. Los nombres no tienen que ser únicos. El valor predeterminado es un nombre derivado de la imagen y el comando (con un sufijo de hash corto). labels (`dict[str, str]`, *opcional*) : Etiquetas para adjuntar al trabajo (pares clave-valor). volumes (`list[Volume]`, *opcional*) : Buckets o Repositorios de Hugging Face para montar como volúmenes en el contenedor del trabajo. Cada volumen es un [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) con `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), `source` (p. ej. `"username/my-bucket"`) y `mount_path` (p. ej. `"/data"`). expose (`list[int]`, *opcional*) : Puertos de contenedor que se expondrán a través del proxy de trabajos. Cada puerto listado es accesible en el dominio público de trabajos (p. ej. `https://--8000.hf.jobs`). El acceso siempre requiere un token de HF con permiso de lectura en el espacio de nombres del trabajo. Utilice `expose_public` para acceso sin autenticación. expose_public (`list[int]`, *opcional*) : Puertos para exponer a través del proxy de Jobs sin autenticación. No es necesario que estén listados en `expose`. resource_group_id (`str`, *opcional*) : El ID del grupo de recursos en el que se creará el Job programado. Se utiliza para controlar el acceso a los recursos dentro de una organización y para las funciones de atribución de costos y límites de gasto. Si no se proporciona, el Job programado se creará fuera de cualquier grupo de recursos. namespace (`str`, *opcional*) : El espacio de nombres donde se creará el Job. Por defecto, se utiliza el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Crea trabajos de cómputo programados en la infraestructura de Hugging Face. Ejemplo: Crea tu primer Job programado: ```python >>> from huggingface_hub import create_scheduled_job >>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly") ``` Use una expresión de programación CRON: ```python >>> from huggingface_hub import create_scheduled_job >>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('this runs every 5min')"], schedule="*/5 * * * *") ``` Crear un trabajo de GPU programado: ```python >>> from huggingface_hub import create_scheduled_job >>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel" >>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"] >>> create_scheduled_job(image=image, command=command, flavor="a10g-small", schedule="@hourly") ``` #### create_scheduled_uv_job[[huggingface_hub.HfApi.create_scheduled_uv_job]] ```python create_scheduled_uv_job(script: str, script_args: list[str] | None = None, schedule: str, suspend: bool | None = None, concurrency: bool | None = None, dependencies: list[str] | None = None, python: str | None = None, image: str | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13551) **Parámetros:** script (`str`) : Ruta o URL del script de UV, o un comando. script_args (`list[str]`, *opcional*) : Argumentos para pasar al script o a un comando. schedule (`str`) : Uno de "@annually", "@yearly", "@monthly", "@weekly", "@daily", "@hourly", o una expresión de programación CRON (p. ej., '0 9 * * 1' para las 9:00 AM cada lunes). suspend (`bool`, *opcional*) : Si es True, el Job programado se suspende (se pausa). Por defecto, False. concurrency (`bool`, *opcional*) : Si es True, se pueden ejecutar varias instancias de este Job de forma concurrente. El valor predeterminado es False. dependencies (`list[str]`, *opcional*) : Dependencias para usar al ejecutar el script de UV. python (`str`, *opcional*) : Use una versión específica de Python. El valor predeterminado es 3.12. image (`str`, *opcional*, valor predeterminado "ghcr.io/astral-sh/uv --python3.12-bookworm"): Use una imagen de Docker personalizada con `uv` instalado. env (`dict[str, Any]`, *opcional*) : Define las variables de entorno para el Job. secrets (`dict[str, Any]`, *opcional*) : Define las variables de entorno secretas para el Job. flavor (`str`, *opcional*) : Sabor para el hardware. Consulte `JobHardware` para los valores posibles. El valor predeterminado es `"cpu-basic"`. timeout (`Union[int, float, str]`, *opcional*) : Duración máxima para el Job: int con s (segundos, predeterminado), m (minutos), h (horas) o d (días). Ejemplo: `300` o `"5m"` para 5 minutos. attempts (`int`, *opcional*) : Número máximo de intentos para cada ejecución, incluido el intento inicial. El valor predeterminado es 1. name (`str`, *opcional*) : Un nombre para el Job programado. Se almacena como la etiqueta `name`. No se puede pasar junto con una clave `name` en `labels`. Los nombres no tienen que ser únicos. El valor predeterminado es un nombre derivado del script y sus argumentos (con un sufijo de hash corto). labels (`dict[str, str]`, *opcional*) : Etiquetas para adjuntar al trabajo (pares clave-valor). volumes (`list[Volume]`, *opcional*) : Buckets o Repositorios de Hugging Face para montar como volúmenes en el contenedor del trabajo. Cada volumen es un [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) con `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), `source` (p. ej. `"username/my-bucket"`) y `mount_path` (p. ej. `"/data"`). expose (`list[int]`, *opcional*) : Puertos de contenedor que se expondrán a través del proxy de trabajos. Cada puerto listado es accesible en el dominio público de trabajos (p. ej. `https://--8000.hf.jobs`). El acceso siempre requiere un token de HF con permiso de lectura en el espacio de nombres del trabajo. Utilice `expose_public` para acceso sin autenticación. expose_public (`list[int]`, *opcional*) : Puertos para exponer a través del proxy de Jobs sin autenticación. No es necesario que estén listados en `expose`. resource_group_id (`str`, *opcional*) : El ID del grupo de recursos en el que se creará el Job programado. Se utiliza para controlar el acceso a los recursos dentro de una organización y para las funciones de atribución de costos y límites de gasto. Si no se proporciona, el Job programado se creará fuera de cualquier grupo de recursos. namespace (`str`, *opcional*) : El espacio de nombres donde se creará el Job. Por defecto, se utiliza el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Ejecuta un trabajo de script de UV en la infraestructura de Hugging Face. > [!WARNING] > A diferencia de `hf jobs uv run`, este método ignora la tabla opcional `[tool.hf-jobs]` que un script de UV puede incluir en su encabezado PEP 723 (consulte la [Guía de Jobs](../guides/jobs#ship-the-launch-config-with-the-script)): la configuración de lanzamiento debe pasarse de forma explícita aquí. Ejemplo: Programar un script desde una URL: ```python >>> from huggingface_hub import 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") ``` Programar un script local: ```python >>> from huggingface_hub import 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") ``` Programar un comando: ```python >>> from huggingface_hub import 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") ``` #### create_tag[[huggingface_hub.HfApi.create_tag]] ```python create_tag(repo_id: str, tag: str, tag_message: str | None = None, revision: str | None = None, token: bool | str | None = None, repo_type: str | None = None, exist_ok: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7095) **Parámetros:** repo_id (`str`) : El repositorio en el que se etiquetará un commit. Ejemplo: `"user/my-cool-model"`. tag (`str`) : El nombre de la etiqueta a crear. tag_message (`str`, *opcional*) : La descripción de la etiqueta a crear. revision (`str`, *opcional*) : La revisión de git a etiquetar. Puede ser el nombre de una rama o el OID/SHA de un commit, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). El valor predeterminado es el final de la rama `"main"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se etiqueta un conjunto de datos o un espacio, `None` o `"model"` si se etiqueta un modelo. El valor predeterminado es `None`. exist_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanza un error si la etiqueta ya existe. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la revisión no se encuentra (error 404) en el repositorio. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Si la rama ya existe en el repositorio (error 409) y `exist_ok` está establecido en `False`. Etiquetar un commit dado de un repositorio en el Hub. #### create_webhook[[huggingface_hub.HfApi.create_webhook]] ```python create_webhook(url: str | None = None, job_id: str | None = None, watched: list[dict | WebhookWatchedItem], domains: list[constants.WEBHOOK_DOMAIN_T] | None = None, secret: str | None = None, secrets: dict[str, str] | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11176) **Parámetros:** url (`str`) : URL a la que se enviará la carga. job_id (`str`) : ID del Job de origen que se activará con la carga del webhook en la variable de entorno WEBHOOK_PAYLOAD. Hay disponibles variables de entorno adicionales para mayor comodidad: WEBHOOK_REPO_ID, WEBHOOK_REPO_TYPE y WEBHOOK_SECRET. watched (`list[WebhookWatchedItem]`) : Lista de [WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookWatchedItem) que el webhook debe vigilar. Puede tratarse de usuarios, organizaciones, modelos, conjuntos de datos, espacios o cubos. Los elementos vigilados también pueden proporcionarse como diccionarios simples. domains (`list[Literal["repo", "discussion"]]`, opcional) : Lista de dominios a vigilar. Puede ser "repo", "discussion" o ambos. El valor predeterminado es ambos. secret (`str`, opcional) : Un secreto para firmar la carga útil. secrets (`dict[str, str]`, opcional) : Variables de entorno secretas para el Job activado por el webhook (p. ej. `{"HF_TOKEN": "hf_***"}`). Solo es válido con `job_id`. Los secretos del Job de origen no se copian al webhook, por lo que debe pasarlos aquí. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookInfo) Información sobre el webhook recién creado. Crea un nuevo webhook. El webhook puede enviar un payload a una URL o activar un Job para que se ejecute en la infraestructura de Hugging Face. Esta función debe llamarse con uno de `url` o `job_id`, pero no con ambos. Ejemplo: Crea un webhook que envía una carga útil a una URL ```python >>> from huggingface_hub import 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, ) ``` Ejecuta un Job y luego crea un webhook que active este Job ```python >>> from huggingface_hub import create_webhook, run_job >>> job = run_job( ... image="ubuntu", ... command=["bash", "-c", r"echo An event occurred 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 occurred 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, ) ``` #### dataset_info[[huggingface_hub.HfApi.dataset_info]] ```python dataset_info(repo_id: str, revision: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: list[ExpandDatasetProperty_T] | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3219) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`, *opcional*) : La revisión del repositorio del conjunto de datos del que se obtendrá la información. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. files_metadata (`bool`, *opcional*) : Si se deben recuperar o no los metadatos de los archivos del repositorio (tamaño, metadatos de LFS, etc.). El valor predeterminado es `False`. expand (`list[ExpandDatasetProperty_T]`, *opcional*) : Propiedades de la lista que se devolverán en la respuesta. Cuando se usa, solo se devolverán las propiedades de la lista. Este parámetro no se puede usar si se pasa `files_metadata`. Los valores posibles son `"author"`, `"cardData"`, `"citation"`, `"createdAt"`, `"disabled"`, `"description"`, `"downloads"`, `"downloadsAllTime"`, `"gated"`, `"lastModified"`, `"likes"`, `"mainSize"`, `"paperswithcode_id"`, `"private"`, `"siblings"`, `"sha"`, `"tags"`, `"trendingScore"`, `"usedStorage"` y `"resourceGroup"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [hf_api.DatasetInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DatasetInfo) La información del repositorio del conjunto de datos. Obtén información sobre un conjunto de datos específico en huggingface.co. El Dataset puede ser privado si pasas un token aceptable. > [!TIP] > Lanza los siguientes errores: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Si no se puede encontrar la revisión del que se va a descargar. #### delete_branch[[huggingface_hub.HfApi.delete_branch]] ```python delete_branch(repo_id: str, branch: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7043) **Parámetros:** repo_id (`str`) : El repositorio en el que se eliminará una rama. Ejemplo: `"user/my-cool-model"`. branch (`str`) : El nombre de la rama a eliminar. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está creando una rama en un dataset o space, `None` o `"model"` si está etiquetando un modelo. El valor predeterminado es `None`. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Si se intenta eliminar una rama protegida. Ej.: `main` no se puede eliminar. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Si se intenta eliminar una rama que no existe. Eliminar una rama de un repositorio en el Hub. #### delete_bucket[[huggingface_hub.HfApi.delete_bucket]] ```python delete_bucket(bucket_id: str, missing_ok: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14157) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). missing_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanza un error si el bucket no existe. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `BucketNotFoundError` - `BucketNotFoundError` -- Si no se puede encontrar el bucket y `missing_ok` está establecido en `False` (valor predeterminado). Eliminar un bucket del Hub. Ejemplo: ```python >>> from huggingface_hub import delete_bucket >>> delete_bucket(bucket_id="Wauplin/first-bucket") >>> delete_bucket(bucket_id="Wauplin/first-bucket", missing_ok=True) ``` #### delete_collection[[huggingface_hub.HfApi.delete_collection]] ```python delete_collection(collection_slug: str, missing_ok: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10373) **Parámetros:** collection_slug (`str`) : Slug de la colección a eliminar. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. missing_ok (`bool`, *opcional*) : Si `True`, no se lanza un error si la colección no existe. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Eliminar una colección en el Hub. Ejemplo: ```py >>> from huggingface_hub import delete_collection >>> collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True) ``` > [!WARNING] > Esta es una acción irreversible. Una colección eliminada no se puede restaurar. #### delete_collection_item[[huggingface_hub.HfApi.delete_collection_item]] ```python delete_collection_item(collection_slug: str, item_object_id: str, missing_ok: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10548) **Parámetros:** collection_slug (`str`) : Slug de la colección a actualizar. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_object_id (`str`) : ID del elemento en la colección. Este no es el id del elemento en el Hub (repo_id o paper id). Debe obtenerse de un objeto [CollectionItem](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.CollectionItem). Ejemplo: `collection.items[0].item_object_id`. missing_ok (`bool`, *opcional*) : Si `True`, no se lanza un error si el elemento no existe. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Eliminar un elemento de una colección. Ejemplo: ```py >>> from huggingface_hub import get_collection, delete_collection_item # Get collection first >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") # Delete item based on its ID >>> delete_collection_item( ... collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026", ... item_object_id=collection.items[-1].item_object_id, ... ) ``` #### delete_file[[huggingface_hub.HfApi.delete_file]] ```python delete_file(path_in_repo: str, repo_id: str, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6045) **Parámetros:** path_in_repo (`str`) : Ruta de archivo relativa en el repositorio, por ejemplo: `"checkpoints/1fec34a/weights.bin"` repo_id (`str`) : El repositorio del que se eliminará el archivo, por ejemplo: `"username/custom_transformers"` token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si el archivo está en un dataset o space, `None` o `"model"` si está en un model. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. commit_message (`str`, *opcional*) : El resumen / título / primera línea del commit generado. El valor predeterminado es `f"Delete {path_in_repo} with huggingface_hub"`. commit_description (`str`, *opcional*) : La descripción del commit generado create_pr (`boolean`, *opcional*) : Si se debe o no crear una Pull Request con ese commit. El valor predeterminado es `False`. Si `revision` no está establecido, la PR se abre contra la rama `"main"`. Si `revision` está establecido y es una rama, la PR se abre contra esta rama. Si `revision` está establecido y no es el nombre de una rama (por ejemplo, un oid de commit), el servidor devuelve un `RevisionNotFoundError`. parent_commit (`str`, *opcional*) : El OID / SHA del commit padre, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). Si se especifica y `create_pr` es `False`, el commit fallará si `revision` no apunta a `parent_commit`. Si se especifica y `create_pr` es `True`, la pull request se creará desde `parent_commit`. Especificar `parent_commit` garantiza que el repositorio no haya cambiado antes de confirmar los cambios, y puede ser especialmente útil si el repositorio se actualiza / confirma de forma concurrente. Elimina un archivo en el repositorio indicado. > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Si no se puede encontrar la revisión del que se va a descargar. - [EntryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.EntryNotFoundError) Si no se puede encontrar el archivo que se va a descargar. #### delete_files[[huggingface_hub.HfApi.delete_files]] ```python delete_files(repo_id: str, delete_patterns: list[str], token: bool | str | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6135) **Parámetros:** repo_id (`str`) : El repositorio del que se eliminará la carpeta, por ejemplo: `"username/custom_transformers"` delete_patterns (`list[str]`) : Lista de archivos o carpetas para eliminar. Cada cadena puede ser una ruta de archivo, una ruta de carpeta o un patrón de comodín. Los patrones son comodines estándar (patrones de globbing) tal como se documenta [aquí](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). La coincidencia de patrones se basa en [`fnmatch`](https://docs.python.org/3/library/fnmatch.html). Tenga en cuenta que `fnmatch` hace que `*` coincida a través de los límites de la ruta, a diferencia del globbing tradicional de la shell de Unix. Por ejemplo, `["file.txt", "folder/", "data/*.parquet"]` token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. al token almacenado. repo_type (`str`, *opcional*) : Tipo de repositorio del que se eliminarán los archivos. Puede ser `"model"`, `"dataset"` o `"space"`. El valor predeterminado es `"model"`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. commit_message (`str`, *opcional*) : El resumen (primera línea) del commit generado. El valor predeterminado es `f"Delete files using huggingface_hub"`. commit_description (`str`, *opcional*) : La descripción del commit generado. create_pr (`boolean`, *opcional*) : Si se debe o no crear una Pull Request con ese commit. El valor predeterminado es `False`. Si `revision` no está establecido, la PR se abre contra la rama `"main"`. Si `revision` está establecido y es una rama, la PR se abre contra esta rama. Si `revision` está establecido y no es el nombre de una rama (por ejemplo, un oid de commit), el servidor devuelve un `RevisionNotFoundError`. parent_commit (`str`, *opcional*) : El OID / SHA del commit padre, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). Si se especifica y `create_pr` es `False`, el commit fallará si `revision` no apunta a `parent_commit`. Si se especifica y `create_pr` es `True`, la pull request se creará desde `parent_commit`. Especificar `parent_commit` garantiza que el repositorio no haya cambiado antes de confirmar los cambios, y puede ser especialmente útil si el repositorio se actualiza / confirma de forma concurrente. Eliminar archivos de un repositorio en el Hub. Si se proporciona una ruta de carpeta, se elimina la carpeta completa junto con todos los archivos que contenía. #### delete_folder[[huggingface_hub.HfApi.delete_folder]] ```python delete_folder(path_in_repo: str, repo_id: str, token: bool | str | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6214) **Parámetros:** path_in_repo (`str`) : Ruta de carpeta relativa en el repositorio, por ejemplo: `"checkpoints/1fec34a"`. repo_id (`str`) : El repositorio del que se eliminará la carpeta, por ejemplo: `"username/custom_transformers"` token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. al token almacenado. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si la carpeta está en un dataset o space, `None` o `"model"` si está en un model. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. commit_message (`str`, *opcional*) : El resumen / título / primera línea del commit generado. El valor predeterminado es `f"Delete folder {path_in_repo} with huggingface_hub"`. commit_description (`str`, *opcional*) : La descripción del commit generado. create_pr (`boolean`, *opcional*) : Si se debe o no crear una Pull Request con ese commit. El valor predeterminado es `False`. Si `revision` no está establecido, la PR se abre contra la rama `"main"`. Si `revision` está establecido y es una rama, la PR se abre contra esta rama. Si `revision` está establecido y no es el nombre de una rama (por ejemplo, un oid de commit), el servidor devuelve un `RevisionNotFoundError`. parent_commit (`str`, *opcional*) : El OID / SHA del commit padre, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). Si se especifica y `create_pr` es `False`, el commit fallará si `revision` no apunta a `parent_commit`. Si se especifica y `create_pr` es `True`, la pull request se creará desde `parent_commit`. Especificar `parent_commit` garantiza que el repositorio no haya cambiado antes de confirmar los cambios, y puede ser especialmente útil si el repositorio se actualiza / confirma de forma concurrente. Elimina una carpeta en el repositorio indicado. Envoltorio simple del método [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit). #### delete_inference_endpoint[[huggingface_hub.HfApi.delete_inference_endpoint]] ```python delete_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9894) **Parámetros:** name (`str`) : El nombre del Inference Endpoint que se va a eliminar. namespace (`str`, *opcional*) : El espacio de nombres en el que se encuentra el Inference Endpoint. Por defecto, es el usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Eliminar un Inference Endpoint. Esta operación no es reversible. Si no desea ser cobrado por un Inference Endpoint, es preferible pausarlo con [pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint) o escalarlo a cero con [scale_to_zero_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.scale_to_zero_inference_endpoint). Por comodidad, también puede eliminar un Inference Endpoint usando [InferenceEndpoint.delete()](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.delete). #### delete_repo[[huggingface_hub.HfApi.delete_repo]] ```python delete_repo(repo_id: str, token: str | bool | None = None, repo_type: str | None = None, missing_ok: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4788) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un model. missing_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanza un error si el repositorio no existe. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se puede encontrar el repositorio del que se debe eliminar y `missing_ok` está establecido en False (valor predeterminado). Eliminar un repositorio del HuggingFace Hub. PRECAUCIÓN: esta acción es irreversible. #### delete_scheduled_job[[huggingface_hub.HfApi.delete_scheduled_job]] ```python delete_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13324) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Eliminar un Job de cómputo programado en la infraestructura de Hugging Face. #### delete_space_secret[[huggingface_hub.HfApi.delete_space_secret]] ```python delete_space_secret(repo_id: str, key: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8083) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. key (`str`) : Clave secreta. Ejemplo: `"GITHUB_API_KEY"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Elimina un secreto de un Space. Los secretos permiten establecer claves o tokens secretos en un Space sin codificarlos directamente. Para más detalles, consulte https://huggingface.co/docs/hub/spaces-overview#managing-secrets. #### delete_space_variable[[huggingface_hub.HfApi.delete_space_variable]] ```python delete_space_variable(repo_id: str, key: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8210) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. key (`str`) : Clave de variable. Ejemplo: `"MODEL_REPO_ID"` token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Elimina una variable de un Space. Las variables permiten establecer variables de entorno en un Space sin codificarlas directamente. Para más detalles, consulte https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables #### delete_space_volumes[[huggingface_hub.HfApi.delete_space_volumes]] ```python delete_space_volumes(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9108) **Parámetros:** repo_id (`str`) : ID del Space que se va a actualizar. Ejemplo: `"username/my-space"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `BadRequestError` - `BadRequestError` -- Si el Space no tiene volúmenes adjuntos. Eliminar todos los volúmenes de un Space. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.delete_space_volumes("username/my-space") ``` #### delete_tag[[huggingface_hub.HfApi.delete_tag]] ```python delete_tag(repo_id: str, tag: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7169) **Parámetros:** repo_id (`str`) : El repositorio en el que se eliminará una etiqueta. Ejemplo: `"user/my-cool-model"`. tag (`str`) : El nombre de la etiqueta a eliminar. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se etiqueta un conjunto de datos o un espacio, `None` o `"model"` si se etiqueta un modelo. El valor predeterminado es `None`. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la etiqueta no se encuentra. Eliminar una etiqueta de un repositorio en el Hub. #### delete_webhook[[huggingface_hub.HfApi.delete_webhook]] ```python delete_webhook(webhook_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11529) **Parámetros:** webhook_id (`str`) : El identificador único del webhook que se va a eliminar. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `None` Eliminar un webhook. Ejemplo: ```python >>> from huggingface_hub import delete_webhook >>> delete_webhook("654bbbc16f2ec14d77f109cc") ``` #### disable_space_dev_mode[[huggingface_hub.HfApi.disable_space_dev_mode]] ```python disable_space_dev_mode(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8497) **Parámetros:** repo_id (`str`) : ID del Space para desactivar el modo de desarrollo. Ejemplo: `"Salesforce/BLIP2"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución sobre tu Space. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) o [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra tu Space (error 404). Lo más probable es que el repo_id sea incorrecto o que tu space sea privado y no estés autenticado. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: solo el propietario de un Space puede establecer el modo de desarrollo. Si deseas gestionar un Space que no te pertenece, solicita al propietario abriendo una Discussion o duplica el Space. - [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Si tu Space es un Space estático. Los Spaces estáticos siempre están en ejecución y nunca se facturan. Si quieres ocultar un Space estático, puedes configurarlo como privado. Desactivar el modo de desarrollo en un Space. Spaces Dev Mode facilita la depuración de tu aplicación y agiliza la iteración en Spaces al permitirte reiniciar tu aplicación sin detener el contenedor del Space. Habilitar el modo de desarrollo requiere un plan PRO o Team & Enterprise, pero deshabilitarlo siempre está permitido (por ejemplo, después de que una suscripción haya expirado). Consulta https://huggingface.co/docs/hub/spaces-dev-mode para más detalles. #### disable_webhook[[huggingface_hub.HfApi.disable_webhook]] ```python disable_webhook(webhook_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11476) **Parámetros:** webhook_id (`str`) : El identificador único del webhook que se va a deshabilitar. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookInfo) Información sobre el webhook deshabilitado. Desactivar un webhook (lo pone en estado "desactivado"). Ejemplo: ```python >>> from huggingface_hub import disable_webhook >>> disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc") >>> disabled_webhook WebhookInfo( 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, ) ``` #### download_bucket_files[[huggingface_hub.HfApi.download_bucket_files]] ```python download_bucket_files(bucket_id: str, files: list[tuple[str | BucketFile, str | Path]], raise_on_missing_files: bool = False, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15069) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). files (`list[tuple[Union[str, BucketFile], Union[str, Path]]]`) : Archivos para descargar como una lista de tuplas (origen, destino). Consulte la descripción anterior para obtener detalles sobre el formato. raise_on_missing_files (`bool`, *opcional*) : Si es `True`, se lanza un `EntryNotFoundError` cuando el archivo solicitado no existe en el bucket. Si es `False` (valor predeterminado), los archivos que faltan se omiten con una advertencia. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Descarga archivos de un bucket. La entrada Files es una lista de tuplas `(remote file, local file)` donde `remote file` es la ruta del archivo en el bucket o un objeto [BucketFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketFile), y `local file` es la ruta de destino en el sistema de archivos local. Al pasar un objeto [BucketFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketFile) (obtenido de [list_bucket_tree()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_bucket_tree)), el método omitirá el paso de obtención de metadatos y descargará los archivos directamente. Ejemplo: ```python >>> from huggingface_hub import download_bucket_files >>> download_bucket_files( ... bucket_id="username/my-bucket", ... files=[ ... ("models/model.safetensors", "./local/model.safetensors"), ... ("config.json", "./local/config.json"), ... ], ... ) ``` ```python >>> from huggingface_hub import download_bucket_files >>> parquet_files = [file for file in list_bucket_tree(bucket_id="username/my-bucket") if file.path.endswith(".parquet")] >>> download_bucket_files( ... bucket_id="username/my-bucket", ... files=[(file, f"./local/{file.path}") for file in parquet_files], ... ) ``` #### duplicate_repo[[huggingface_hub.HfApi.duplicate_repo]] ```python duplicate_repo(from_id: str, to_id: str | None = None, repo_type: str | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, token: bool | str | None = None, exist_ok: bool = False, resource_group_id: str | None = None, space_hardware: SpaceHardware | None = None, space_sleep_time: int | None = None, space_secrets: list[dict[str, str]] | None = None, space_variables: list[dict[str, str]] | None = None, space_volumes: list[Volume] | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8863) **Parámetros:** from_id (`str`) : ID del repositorio a duplicar. Ejemplo: `"openai/gdpval"`. to_id (`str`, *opcional*) : ID del nuevo repositorio. Ejemplo: `"myorg/my-gdpval"`. Si no se proporciona, el nuevo repositorio tendrá el mismo nombre que el repositorio original, pero en tu cuenta. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está duplicando un dataset o un Space, `None` o `"model"` si está duplicando un modelo. El valor predeterminado es `None`. private (`bool`, *opcional*) : Si el nuevo repositorio debe ser privado o no. El valor predeterminado es la misma privacidad que el repositorio original. No se puede pasar junto con `visibility`. visibility (`Literal["public", "private", "protected"]`, *opcional*) : Visibilidad del nuevo repositorio. Puede ser `"public"` o `"private"`, o `"protected"` para Spaces. Por defecto, es la misma visibilidad que el repositorio original. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. exist_ok (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, no se lanzará un error si el repositorio ya existe. resource_group_id (`str`, *opcional*) : Grupo de recursos en el que se creará el nuevo repositorio. Los grupos de recursos solo están disponibles para organizaciones de Enterprise Hub y permiten definir qué miembros de la organización pueden acceder al recurso. El ID de un grupo de recursos se puede encontrar en la URL de la página del recurso en el Hub (p. ej. `"66670e5163145ca562cb1988"`). Para obtener más información sobre los grupos de recursos, consulte https://huggingface.co/docs/hub/en/security-resource-groups. space_hardware (`SpaceHardware` o `str`, *opcional*) : Elección de Hardware si repo_type es "space". Ejemplo: `"t4-medium"`. Consulte [SpaceHardware](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceHardware) para obtener una lista completa. space_sleep_time (`int`, *opcional*) : Número de segundos de inactividad que se espera antes de que un Space entre en modo de suspensión. Establezca `-1` si no desea que su Space entre en suspensión (comportamiento predeterminado para el hardware actualizado). Para el hardware gratuito, no puede configurar el tiempo de suspensión (el valor está fijo en 48 horas de inactividad). Solo es aplicable si repo_type es "space". Consulte https://huggingface.co/docs/hub/spaces-gpus#sleep-time para obtener más detalles. space_secrets (`list[dict[str, str]]`, *opcional*) : Una lista de claves secretas para configurar en tu Space. Cada elemento tiene la forma `{"key": ..., "value": ..., "description": ...}` donde description es opcional. Solo aplicable si repo_type es "space". Para más detalles, consulta https://huggingface.co/docs/hub/spaces-overview#managing-secrets. space_variables (`list[dict[str, str]]`, *opcional*) : Una lista de variables de entorno públicas para establecer en tu Space. Cada elemento tiene la forma `{"key": ..., "value": ..., "description": ...}` donde description es opcional. Solo aplicable si repo_type es "space". Para más detalles, consulta https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables. space_volumes (`list[Volume]`, *opcional*) : Una lista de objetos [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) para montar en el Space en el momento de la duplicación. Cada volumen tiene un `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), un `source` (ID del repositorio o bucket), un `mount_path` (ruta dentro del contenedor) y los campos opcionales `revision`, `read_only` y `path`. Solo es aplicable si repo_type es "space". **Devuelve:** [DuplicatedRepoUrl](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DuplicatedRepoUrl) URL del repositorio recién creado. El valor es una subclase de [RepoUrl](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.RepoUrl) (y de `str`) que contiene atributos como `endpoint`, `repo_type`, `repo_id` y `files_copy_pending`. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o `HfHubHTTPError` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se puede encontrar `from_id` o `to_id`. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - `HfHubHTTPError` -- Si la API de HuggingFace devolvió un error Duplicar un repositorio en el Hub (modelo, conjunto de datos o Space). Esto realiza una copia en el servidor que preserva el historial completo de git y los objetos LFS sin requerir un ciclo de descarga/carga local. El historial de git se copia de inmediato, pero los archivos LFS/Xet pueden seguir copiándose en segundo plano una vez que este método devuelve el control. En ese caso, `files_copy_pending` es `True` en el valor devuelto y la descarga de estos archivos desde el nuevo repositorio puede fallar hasta que la copia se complete. Ejemplo: ```python >>> from huggingface_hub import duplicate_repo # Duplicate a model to your account >>> repo_url = duplicate_repo("google/gemma-7b") >>> repo_url RepoUrl('https://huggingface.co/nateraw/gemma-7b',...) >>> repo_url.files_copy_pending True # Duplicate a dataset with a custom name >>> duplicate_repo("openai/gdpval", to_id="myorg/my-gdpval", repo_type="dataset") RepoUrl('https://huggingface.co/datasets/myorg/my-gdpval',...) # Duplicate a Space with custom hardware >>> duplicate_repo("multimodalart/dreambooth-training", repo_type="space", space_hardware="t4-medium") RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...) ``` #### edit_discussion_comment[[huggingface_hub.HfApi.edit_discussion_comment]] ```python edit_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, new_content: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7883) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. comment_id (`str`) : El ID del comentario a editar. new_content (`str`) : El nuevo contenido del comentario. Los comentarios admiten formato markdown. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionComment) el comentario editado Edita un comentario en una Discusión / Solicitud de extracción (Pull Request). > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### enable_space_dev_mode[[huggingface_hub.HfApi.enable_space_dev_mode]] ```python enable_space_dev_mode(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8458) **Parámetros:** repo_id (`str`) : ID del Space para el que se habilitará el modo de desarrollo. Ejemplo: `"Salesforce/BLIP2"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución sobre tu Space. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) o [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra tu Space (error 404). Lo más probable es que el repo_id sea incorrecto o que tu space sea privado y no estés autenticado. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: solo el propietario de un Space puede establecer el modo de desarrollo. Si deseas gestionar un Space que no te pertenece, solicita al propietario abriendo una Discussion o duplica el Space. - [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Si tu Space es un Space estático. Los Spaces estáticos siempre están en ejecución y nunca se facturan. Si quieres ocultar un Space estático, puedes configurarlo como privado. Activar el modo de desarrollo en un Space. Spaces Dev Mode facilita la depuración de tu aplicación y agiliza la iteración en Spaces al permitirte reiniciar tu aplicación sin detener el contenedor del Space. Esta función está disponible como parte de un plan PRO o Team & Enterprise. Consulta https://huggingface.co/docs/hub/spaces-dev-mode para más detalles. #### enable_webhook[[huggingface_hub.HfApi.enable_webhook]] ```python enable_webhook(webhook_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11423) **Parámetros:** webhook_id (`str`) : El identificador único del webhook que se habilitará. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookInfo) Información sobre el webhook habilitado. Habilitar un webhook (lo hace "activo"). Ejemplo: ```python >>> from huggingface_hub import enable_webhook >>> enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc") >>> enabled_webhook WebhookInfo( 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, ) ``` #### fetch_job_logs[[huggingface_hub.HfApi.fetch_job_logs]] ```python fetch_job_logs(job_id: str, namespace: str | None = None, follow: bool = False, tail: int | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12327) **Parámetros:** job_id (`str`) : ID del trabajo. namespace (`str`, *opcional*) : El espacio de nombres donde se está ejecutando el Job. Por defecto, es el espacio de nombres del usuario actual. follow (`bool`, *opcional*) : Si es `True`, transmite los registros en tiempo real hasta que el trabajo se complete (bloqueante). Si es `False` (predeterminado), recupera solo los registros actualmente disponibles y devuelve de inmediato (no bloqueante). tail (`int`, *opcional*) : Número máximo de líneas a devolver de los registros. Cuando se combina con `follow=True`, comienza desde las últimas N líneas y continúa transmitiendo nuevos registros. Cuando `follow=False`, devuelve solo las últimas N líneas de los registros actualmente disponibles. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Obtén todos los registros de un Job de cómputo en la infraestructura de Hugging Face. Ejemplo: ```python >>> from huggingface_hub import fetch_job_logs, run_job >>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"]) >>> for log in fetch_job_logs(job_id=job.id): ... print(log) Hello from HF compute! >>> # Non-blocking: fetch only currently available logs >>> for log in fetch_job_logs(job_id=job.id, follow=False): ... print(log) >>> # Stream logs starting from the last 100 lines >>> for log in fetch_job_logs(job_id=job.id, follow=True, tail=100): ... print(log) ``` #### fetch_job_metrics[[huggingface_hub.HfApi.fetch_job_metrics]] ```python fetch_job_metrics(job_id: str, namespace: str | None = None, follow: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12407) **Parámetros:** job_id (`str`) : ID del trabajo. namespace (`str`, *opcional*) : El espacio de nombres donde se está ejecutando el Job. Por defecto, es el espacio de nombres del usuario actual. follow (`bool`, *opcional*) : Si es `True`, transmite las métricas en tiempo real hasta que el trabajo se complete (bloqueante). Si es `False` (predeterminado), solo recupera las métricas actuales y devuelve (no bloqueante). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Obtén las métricas en vivo de un Job de cómputo en la infraestructura de Hugging Face. Ejemplo: ```python >>> from huggingface_hub import fetch_job_metrics, run_job >>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], flavor="a10g-small") >>> for metrics in 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" } >>> # Stream metrics until the job completes >>> for metrics in fetch_job_metrics(job_id=job.id, follow=True): ... print(metrics) ``` #### fetch_space_logs[[huggingface_hub.HfApi.fetch_space_logs]] ```python fetch_space_logs(repo_id: str, build: bool = False, follow: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8737) **Parámetros:** repo_id (`str`) : ID del Space. Ejemplo: `"bigcode/in-the-stack"`. build (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, obtiene los registros de compilación del contenedor (útil cuando un Space se queda atascado en `BUILD_ERROR`). Si es `False` (predeterminado), obtiene los registros de ejecución, es decir, el stdout/stderr de la aplicación en ejecución. follow (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, transmite los registros en tiempo real (bloqueante) hasta que el servidor cierre el flujo o se lance `KeyboardInterrupt`. Si es `False` (predeterminado), recupera solo los registros actualmente en el búfer y devuelve el control de inmediato (no bloqueante, como `docker logs`). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Por defecto, se utiliza el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** `Iterable[str]` Un generador que produce líneas de registro a medida que están disponibles. Obtén los registros de ejecución o compilación de un Space en el Hub. Útil para depurar un Space que falla al compilar o se detiene en tiempo de ejecución, especialmente desde un script o un flujo de trabajo agéntico donde leer los registros en un navegador no es una opción. Ejemplo: ```python >>> from huggingface_hub import fetch_space_logs >>> # Non-blocking: print currently available run logs and exit. >>> for line in fetch_space_logs("username/my-space"): ... print(line, end="") >>> # Debug a build failure: >>> for line in fetch_space_logs("username/my-space", build=True): ... print(line, end="") >>> # Stream run logs until the server closes the stream. >>> for line in fetch_space_logs("username/my-space", follow=True): ... print(line, end="") ``` #### file_exists[[huggingface_hub.HfApi.file_exists]] ```python file_exists(repo_id: str, filename: str, repo_type: str | None = None, revision: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3768) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. filename (`str`) : El nombre del archivo a verificar, por ejemplo: `"config.json"` repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si obtiene información del repositorio de un dataset o un space, `None` o `"model"` si obtiene información del repositorio de un modelo. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión del repositorio de la que se obtendrá la información. El valor predeterminado es la rama `"main"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** True si el archivo existe, False en caso contrario. Comprueba si un archivo existe en un repositorio de Hugging Face Hub. Ejemplos: ```py >>> from huggingface_hub import file_exists >>> file_exists("bigcode/starcoder", "config.json") True >>> file_exists("bigcode/starcoder", "not-a-file") False >>> file_exists("bigcode/not-a-repo", "config.json") False ``` #### get_bucket_file_metadata[[huggingface_hub.HfApi.get_bucket_file_metadata]] ```python get_bucket_file_metadata(bucket_id: str, remote_path: str, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15010) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). remote_path (`str`) : La ruta del archivo en el bucket. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [BucketFileMetadata](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketFileMetadata) El archivo de metadatos que contiene la información de tamaño y xet. Obtener los metadatos de un archivo en un bucket. Ejemplo: ```python >>> from huggingface_hub import get_bucket_file_metadata >>> metadata = get_bucket_file_metadata( ... bucket_id="username/my-bucket", ... remote_path="models/model.safetensors", ... ) >>> metadata.size 42000 ``` #### get_bucket_paths_info[[huggingface_hub.HfApi.get_bucket_paths_info]] ```python get_bucket_paths_info(bucket_id: str, paths: Iterable[str], token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14356) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). paths (`Iterable[str]`) : Las rutas para obtener información. Si una ruta no existe, se ignora sin lanzar una excepción. Solo se admiten rutas de archivo. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[BucketFile]` La información sobre las rutas, como un iterable de objetos [BucketFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketFile). Obtén información sobre las rutas de un bucket. Las llamadas se realizan en lotes de 1000 rutas. Los resultados se devuelven a medida que se reciben. Ejemplo: ```py >>> from huggingface_hub import get_bucket_paths_info >>> paths_info = get_bucket_paths_info("username/my-bucket", ["file.txt", "checkpoints/model.safetensors"]) >>> for info in paths_info: ... print(info) BucketFile(type='file', path='file.txt', size=2379, xet_hash='96e637d9665bd35477b1908a23f2e254edfba0618dbd2d62f90a6baee7d139cf', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc)) BucketFile(type='file', path='checkpoints/model.safetensors', size=2408828, xet_hash='3ed0e9fefe788ddd61d1e26eba67057e9740a064b009256fbafadf6bb95785ca', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc)) ``` #### get_collection[[huggingface_hub.HfApi.get_collection]] ```python get_collection(collection_slug: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10152) **Parámetros:** collection_slug (`str`) : Slug de la colección del Hub. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Obtiene información sobre una colección en el Hub. Devuelve: [Collection](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.Collection) Ejemplo: ```py >>> from huggingface_hub import get_collection >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") >>> collection.title 'Recent models' >>> len(collection.items) 37 >>> collection.items[0] CollectionItem( item_object_id='651446103cd773a050bf64c2', item_id='TheBloke/U-Amethyst-20B-AWQ', item_type='model', position=88, note=None ) ``` #### get_dataset_leaderboard[[huggingface_hub.HfApi.get_dataset_leaderboard]] ```python get_dataset_leaderboard(repo_id: str, base_model_only: bool | None = None, token: bool | str | None = None, timeout: float | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3289) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. Por ejemplo: `"allenai/olmOCR-bench"`. base_model_only (`bool` o `None`, *opcional*) : Por defecto, la clasificación solo incluye modelos que no tienen una relación `base_model` declarada (es decir, repositorios canónicos o raíz), coincidiendo con la vista de clasificación predeterminada del Hub. Se excluyen los repositorios de ajuste fino o derivados que declaran un modelo padre. Pasa `base_model_only=False` para desactivar este filtro e incluir cada resultado enviado, independientemente de si el modelo declara una relación de modelo base. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. **Devuelve:** `list[DatasetLeaderboardEntry]` Una lista de objetos [DatasetLeaderboardEntry](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DatasetLeaderboardEntry) que representan las entradas del ranking, ordenadas por posición. Obtén la clasificación de un conjunto de datos en el Hub. El ranking clasifica los modelos en función de sus puntuaciones de evaluación en el conjunto de datos de referencia dado. No todos los conjuntos de datos tienen un ranking: solo aquellos conjuntos de datos de referencia a los que se han enviado resultados de evaluación. Esto ofrece una visión centrada en el conjunto de datos de las puntuaciones; para una visión centrada en el modelo, use [model_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.model_info) con `expand=["evalResults"]`. > [!TIP] > Lanza los siguientes errores: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) Si el conjunto de datos no tiene una clasificación. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench") >>> leaderboard[0].model_id 'datalab-to/chandra-ocr-2' >>> leaderboard[0].rank 1 # Include fine-tuned / derivative models too >>> full_leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench", base_model_only=False) ``` #### get_dataset_tags[[huggingface_hub.HfApi.get_dataset_tags]] ```python get_dataset_tags() ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2301) Liste todas las etiquetas de conjunto de datos válidas como un objeto de espacio de nombres anidado. #### get_discussion_details[[huggingface_hub.HfApi.get_discussion_details]] ```python get_discussion_details(repo_id: str, discussion_num: int, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7364) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Obtiene los detalles de una Discusión / Solicitud de extracción (Pull Request) del Hub. Devuelve: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionWithDetails) > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### get_full_repo_name[[huggingface_hub.HfApi.get_full_repo_name]] ```python get_full_repo_name(model_id: str, organization: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7218) **Parámetros:** model_id (`str`) : El nombre del modelo. organization (`str`, *opcional*) : Si se pasa, el nombre del repositorio estará en el espacio de nombres de la organización en lugar del espacio de nombres del usuario. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `str` El nombre del repositorio en el espacio de nombres del usuario ({username}/{model_id}) si no se pasa ninguna organización, y en el espacio de nombres de la organización ({organization}/{model_id}) en caso contrario. Devuelve el nombre del repositorio para un ID de modelo dado y una organización opcional. #### get_hf_file_metadata[[huggingface_hub.HfApi.get_hf_file_metadata]] ```python get_hf_file_metadata(url: str, token: bool | str | None = None, timeout: float | None = 10) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6285) **Parámetros:** url (`str`) : URL del archivo, por ejemplo, la devuelta por [hf_hub_url()](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.hf_hub_url). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. timeout (`float`, *opcional*, valor predeterminado 10) : Número de segundos que se espera a que el servidor envíe metadatos antes de abandonar la espera. **Devuelve:** Un objeto [HfFileMetadata](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.HfFileMetadata) que contiene metadatos como ubicación, etag, tamaño y commit_hash. Obtener los metadatos de un archivo versionado en el Hub para una URL dada. #### get_inference_endpoint[[huggingface_hub.HfApi.get_inference_endpoint]] ```python get_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9659) **Parámetros:** name (`str`) : El nombre del Inference Endpoint sobre el que se desea obtener información. namespace (`str`, *opcional*) : El espacio de nombres en el que se encuentra el Inference Endpoint. Por defecto, es el usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el Inference Endpoint solicitado. Obtén información sobre un Inference Endpoint. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> endpoint = api.get_inference_endpoint("my-text-to-image") >>> endpoint InferenceEndpoint(name='my-text-to-image', ...) # Get status >>> endpoint.status 'running' >>> endpoint.url 'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud' # Run inference >>> endpoint.client.text_to_image(...) ``` #### get_model_tags[[huggingface_hub.HfApi.get_model_tags]] ```python get_model_tags() ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2292) Liste todas las etiquetas de modelo válidas como un objeto de espacio de nombres anidado #### get_organization_overview[[huggingface_hub.HfApi.get_organization_overview]] ```python get_organization_overview(organization: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11747) **Parámetros:** organization (`str`) : Nombre de la organización para la que se desea obtener un resumen. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Organization` Un objeto `Organization` con la descripción general de la organización. **Excepciones:** ``HTTPError`` - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) -- HTTP 404 Si la organización no existe en el Hub. Obtén una visión general de una organización en el Hub. #### get_paths_info[[huggingface_hub.HfApi.get_paths_info]] ```python get_paths_info(repo_id: str, paths: list[str] | str, expand: bool = False, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4269) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. paths (`Union[list[str], str]`, *opcional*) : Las rutas para obtener información. Si una ruta no existe, se ignora sin lanzar una excepción. expand (`bool`, *opcional*, valor predeterminado `False`) : Si se debe obtener más información sobre las rutas (p. ej., el último commit y los resultados del análisis de seguridad de los archivos). Esta operación es más costosa para el servidor, por lo que solo se devuelven 50 resultados por página (en lugar de 1000). Dado que la paginación está implementada en `huggingface_hub`, esto es transparente para ti, excepto por el tiempo que tarda en obtener los resultados. revision (`str`, *opcional*) : La revisión del repositorio de la que se obtendrá la información. El valor predeterminado es la rama `"main"`. repo_type (`str`, *opcional*) : El tipo de repositorio del que se obtiene la información (`"model"`, `"dataset"` o `"space"`. Por defecto, `"model"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `list[Union[RepoFile, RepoFolder]]` La información sobre las rutas, como una lista de objetos [RepoFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.RepoFile) y `RepoFolder`. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la revisión no se encuentra (error 404) en el repositorio. Obtén información sobre las rutas de un repositorio. Ejemplo: ```py >>> from huggingface_hub import get_paths_info >>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset") >>> paths_info [ RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None), RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None) ] ``` #### get_repo_discussions[[huggingface_hub.HfApi.get_repo_discussions]] ```python get_repo_discussions(repo_id: str, author: str | None = None, discussion_type: constants.DiscussionTypeFilter | None = None, discussion_status: constants.DiscussionStatusFilter | None = None, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7256) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. author (`str`, *opcional*) : Pasa un valor para filtrar por autor de la discusión. `None` significa sin filtro. El valor predeterminado es `None`. discussion_type (`str`, *opcional*) : Establezca `"pull_request"` para obtener solo solicitudes de extracción, `"discussion"` para obtener solo discusiones. Establezca `"all"` o `None` para obtener ambos. El valor predeterminado es `None`. discussion_status (`str`, *opcional*) : Establezca `"open"` (o `"closed"`) para obtener solo discusiones abiertas (o cerradas). Establezca `"all"` o `None` para obtener ambas. El valor predeterminado es `None`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se obtiene de un dataset o space, `None` o `"model"` si se obtiene de un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterator[Discussion]` Un iterador de objetos [Discussion](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.Discussion). Obtiene las Discusiones y las Pull Requests del repositorio indicado. Ejemplo: Recopilar todas las discusiones de un repositorio en una lista: ```python >>> from huggingface_hub import get_repo_discussions >>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased")) ``` Iterar sobre las discusiones de un repositorio: ```python >>> from huggingface_hub import get_repo_discussions >>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"): ... print(discussion.num, discussion.title) ``` #### get_safetensors_metadata[[huggingface_hub.HfApi.get_safetensors_metadata]] ```python get_safetensors_metadata(repo_id: str, repo_type: str | None = None, revision: str | None = None, token: bool | str | None = None, timeout: float | None = 10) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6669) **Parámetros:** repo_id (`str`) : El nombre de un usuario u organización y el nombre de un repositorio separados por una `/`. repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si el archivo está en un dataset o space, `None` o `"model"` si está en un model. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se obtiene el archivo. Puede ser el nombre de una rama, una etiqueta o un hash de commit. Por defecto, es la cabecera de la rama `"main"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. timeout (`float`, *opcional*, valor predeterminado 10) : Número de segundos que se espera a que el servidor envíe datos antes de abandonar la espera, se pasa a cada solicitud que obtiene la cabecera de un archivo safetensors. Establezca `None` para deshabilitar el tiempo de espera (no se recomienda, ya que una conexión detenida puede bloquear la llamada indefinidamente). **Devuelve:** `SafetensorsRepoMetadata` información relacionada con el repositorio de safetensors. **Excepciones:** `NotASafetensorsRepoError` o `SafetensorsParsingError` - `NotASafetensorsRepoError` -- Si el repositorio no es un repositorio de safetensors, es decir, si no contiene un archivo `model.safetensors` ni un archivo `model.safetensors.index.json`. - `SafetensorsParsingError` -- Si no se pudo analizar correctamente la cabecera de un archivo safetensors. Analizar los metadatos de un repositorio de safetensors en el Hub. Primero comprobamos si el repositorio tiene un único archivo safetensors o si es un repositorio de safetensors fragmentado. Si es un único archivo safetensors, analizamos los metadatos de este archivo. Si es un repositorio de safetensors fragmentado, analizamos los metadatos del archivo de índice y luego los metadatos de cada fragmento. Para analizar los metadatos de un único archivo safetensors, use [parse_safetensors_file_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.parse_safetensors_file_metadata). Para obtener la cabecera de cada fragmento de un modelo fragmentado en `main` en una sola solicitud, use [get_sharded_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_sharded_safetensors_metadata). Para más detalles sobre el formato safetensors, consulta https://huggingface.co/docs/safetensors/index#format. Ejemplo: ```py # Parse repo with single weights file >>> metadata = get_safetensors_metadata("bigscience/bloomz-560m") >>> metadata SafetensorsRepoMetadata( metadata=None, sharded=False, weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...}, files_metadata={'model.safetensors': SafetensorsFileMetadata(...)} ) >>> metadata.files_metadata["model.safetensors"].metadata {'format': 'pt'} # Parse repo with sharded model >>> metadata = get_safetensors_metadata("bigscience/bloom") Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00, 5.78it/s] >>> metadata SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...}) >>> len(metadata.files_metadata) 72 # All safetensors files have been fetched # Parse repo with sharded model >>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5") NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files. ``` #### get_sharded_safetensors_metadata[[huggingface_hub.HfApi.get_sharded_safetensors_metadata]] ```python get_sharded_safetensors_metadata(repo_id: str, filename: str = 'model.safetensors.index.json', token: bool | str | None = None, timeout: float | None = 10) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6824) **Parámetros:** repo_id (`str`) : El nombre de un usuario u organización y el nombre de un repositorio separados por una `/`. filename (`str`, *opcional*) : Ruta del archivo de índice de safetensors en el repositorio. El valor predeterminado es `"model.safetensors.index.json"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. timeout (`float`, *opcional*, valor predeterminado 10) : Número de segundos que se espera a que el servidor envíe datos antes de abandonar la espera. Establezca `None` para deshabilitar el tiempo de espera (no se recomienda, ya que una conexión detenida puede bloquear la llamada indefinidamente). **Devuelve:** `SafetensorsRepoMetadata` los mismos metadatos que [get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata). Obtén los metadatos de cada fragmento de un modelo safetensors fragmentado en `main` desde el Hub en una sola solicitud, en lugar de que [get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata) analice la cabecera de cada fragmento. Solo Hugging Face Hub. Ejemplo: ```py >>> metadata = get_sharded_safetensors_metadata("HuggingFaceH4/zephyr-7b-beta") >>> len(metadata.files_metadata) 8 ``` #### get_space_runtime[[huggingface_hub.HfApi.get_space_runtime]] ```python get_space_runtime(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8239) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución sobre un Space, incluida la etapa y el hardware del Space. Obtiene información de tiempo de ejecución sobre un Space. #### get_space_secrets[[huggingface_hub.HfApi.get_space_secrets]] ```python get_space_secrets(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8109) **Parámetros:** repo_id (`str`) : ID del repositorio a consultar. Ejemplo: `"bigcode/in-the-stack"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `dict[str, SpaceSecret]` Diccionario de objetos `SpaceSecret` indexado por el nombre del secreto. Obtiene todos los secretos de un Space. Los valores secretos son de solo escritura y no se pueden leer de nuevo. Solo se devuelve la clave, la descripción y la hora de la última actualización. Los secretos permiten establecer claves o tokens secretos en un Space sin codificarlos directamente. Para más detalles, consulte https://huggingface.co/docs/hub/spaces-overview#managing-secrets. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.get_space_secrets("username/my-space") {'HF_TOKEN': SpaceSecret(key='HF_TOKEN', description='...', updated_at=datetime.datetime(...))} ``` #### get_space_variables[[huggingface_hub.HfApi.get_space_variables]] ```python get_space_variables(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8146) **Parámetros:** repo_id (`str`) : ID del repositorio a consultar. Ejemplo: `"bigcode/in-the-stack"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Obtiene todas las variables de un Space. Las variables permiten establecer variables de entorno en un Space sin codificarlas directamente. Para más detalles, consulte https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables #### get_user_overview[[huggingface_hub.HfApi.get_user_overview]] ```python get_user_overview(username: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11721) **Parámetros:** username (`str`) : Nombre de usuario del usuario del que se desea obtener un resumen. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `User` Un objeto [User](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.User) con el resumen del usuario. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si el usuario no existe en el Hub. Obtén una visión general de un usuario en el Hub. #### get_webhook[[huggingface_hub.HfApi.get_webhook]] ```python get_webhook(webhook_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11072) **Parámetros:** webhook_id (`str`) : El identificador único del webhook a obtener. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookInfo) Información sobre el webhook. Obtén un webhook por su id. Ejemplo: ```python >>> from huggingface_hub import 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, ) ``` #### get_zero_gpu_quota[[huggingface_hub.HfApi.get_zero_gpu_quota]] ```python get_zero_gpu_quota(token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8283) **Parámetros:** token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena de caracteres). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Un token de grano fino debe tener el permiso "Billing > Read billing usage and payment method status" y un token de OAuth debe tener el ámbito `read-billing`. **Devuelve:** [ZeroGpuQuota](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.ZeroGpuQuota) La cuota de ZeroGPU del usuario autenticado. Obtén la cuota de ZeroGPU del usuario autenticado. Útil para hacer seguimiento del uso de ZeroGPU al llamar a espacios ZeroGPU de forma programática (p. ej., desde una aplicación, un agente o un servidor MCP). Consulte https://huggingface.co/docs/hub/spaces-zerogpu para más detalles. Ejemplo: ```py >>> from huggingface_hub import get_zero_gpu_quota >>> quota = get_zero_gpu_quota() >>> quota ZeroGpuQuota(base=2400, remaining=1810, resets_at=datetime.datetime(2026, 9, 30, 9, 12, 3, tzinfo=datetime.timezone.utc), overquota_used=0) >>> print(f"{quota.remaining / 60:.1f} minutes left") 30.2 minutes left ``` #### grant_access[[huggingface_hub.HfApi.grant_access]] ```python grant_access(repo_id: str, user: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11017) **Parámetros:** repo_id (`str`) : El id del repositorio al que se otorga el acceso. user (`str`) : El nombre de usuario del usuario al que se le otorgará el acceso. repo_type (`str`, *opcional*) : El tipo de repositorio al que se otorga el acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 400 si el usuario ya tiene acceso al repositorio. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. - `HfHubHTTPError` -- HTTP 404 si el usuario no existe en el Hub. Conceder acceso a un usuario para un repositorio con control de acceso determinado. Conceder el acceso no requiere que el usuario envíe una solicitud de acceso por sí mismo. El usuario se agrega automáticamente a la lista de aceptados, lo que significa que puede descargar los archivos. Puedes revocar el acceso concedido en cualquier momento usando [cancel_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) o [reject_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. #### hf_hub_download[[huggingface_hub.HfApi.hf_hub_download]] ```python hf_hub_download(repo_id: str, filename: str, subfolder: str | None = None, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_dir: str | Path | None = None, force_download: bool = False, etag_timeout: float = 10, token: bool | str | None = None, local_files_only: bool = False, tqdm_class: type[base_tqdm] | None = None, dry_run: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6364) **Parámetros:** repo_id (`str`) : El nombre de un usuario u organización y el nombre de un repositorio separados por una `/`. filename (`str`) : El nombre del archivo en el repositorio. subfolder (`str`, *opcional*) : Un valor opcional que corresponde a una carpeta dentro del repositorio. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está descargando desde un dataset o space, `None` o `"model"` si está descargando desde un model. El valor predeterminado es `None`. revision (`str`, *opcional*) : Un identificador de revisión de Git opcional, que puede ser un nombre de rama, una etiqueta o un hash de commit. cache_dir (`str`, `Path`, *opcional*) : Ruta a la carpeta donde se almacenan los archivos en caché. local_dir (`str` o `Path`, *opcional*) : Si se proporciona, el archivo descargado se colocará en este directorio. force_download (`bool`, *opcional*, valor predeterminado `False`) : Si el archivo debe descargarse aunque ya exista en la caché local. etag_timeout (`float`, *opcional*, valor predeterminado `10`) : Al obtener el ETag, cuántos segundos esperar a que el servidor envíe datos antes de abandonar la solicitud, valor que se pasa a `httpx2.request`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. local_files_only (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, evita descargar el archivo y devuelve la ruta al archivo en caché local si existe. tqdm_class (`tqdm`, *opcional*) : Si se proporciona, sobrescribe el comportamiento predeterminado de la barra de progreso. El argumento pasado debe heredar de `tqdm.auto.tqdm` o al menos imitar su comportamiento. El valor predeterminado es la barra de progreso personalizada de HF, que se puede desactivar estableciendo la variable de entorno `HF_HUB_DISABLE_PROGRESS_BARS`. dry_run (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, realiza una ejecución de prueba sin descargar realmente el archivo. Devuelve un objeto [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DryRunFileInfo) que contiene información sobre lo que se descargaría. **Devuelve:** `str` o [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DryRunFileInfo) - Si `dry_run=False`: ruta local del archivo o, si la red está desactivada, la última versión del archivo en caché en el disco. - Si `dry_run=True`: un objeto [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DryRunFileInfo) que contiene información de descarga. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) o `~utils.RemoteEntryNotFoundError` o [LocalEntryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.LocalEntryNotFoundError) o ``EnvironmentError`` o ``OSError`` o ``ValueError`` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si no se puede encontrar la revisión desde la que se debe descargar. - `~utils.RemoteEntryNotFoundError` -- Si no se puede encontrar el archivo para descargar. - [LocalEntryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.LocalEntryNotFoundError) -- Si la red está deshabilitada o no está disponible y el archivo no se encuentra en la caché. - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) -- Si `token=True` pero no se puede encontrar el token. - [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -- Si no se puede determinar el ETag. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si el valor de algún parámetro no es válido. Descarga un archivo dado si no está presente en la caché local. El nuevo diseño de archivo de cacheta es el siguiente: - El directorio de caché contiene un subdirectorio por repo_id (espaciado de nombres por tipo de repositorio) - dentro de cada carpeta de repositorio: - refs es una lista de los pares de revisión => commit_hash más recientes conocidos - blobs contiene los blobs de archivo reales (identificados por su git-sha o sha256, dependiendo de si son archivos LFS o no) - snapshots contiene un subdirectorio por commit, cada "commit" contiene el subconjunto de archivos que se han resuelto en ese commit en particular. Cada nombre de archivo es un enlace simbólico al blob en ese commit en particular. ``` [ 96] . └── [ 160] models--julien-c--EsperBERTo-small ├── [ 160] blobs │ ├── [321M] 403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd │ ├── [ 398] 7cb18dc9bafbfcf74629a4b760af1b160957a83e │ └── [1.4K] d7edf6bd2a681fb0175f7735299831ee1b22b812 ├── [ 96] refs │ └── [ 40] main └── [ 128] snapshots ├── [ 128] 2439f60ef33a0d46d85da5001d52aeda5b00ce9f │ ├── [ 52] README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812 │ └── [ 76] pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd └── [ 128] bbc77c8132af1cc5cf678da3f1ddf2de43606d48 ├── [ 52] README.md -> ../../blobs/7cb18dc9bafbfcf74629a4b760af1b160957a83e └── [ 76] pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd ``` Si se proporciona `local_dir`, la estructura de archivos del repositorio se replicará en esta ubicación. Al usar esta opción, no se utilizará `cache_dir` y se creará una carpeta `.cache/huggingface/` en la raíz de `local_dir` para almacenar algunos metadatos relacionados con los archivos descargados. Aunque este mecanismo no es tan robusto como el sistema de caché principal, está optimizado para obtener regularmente la última versión de un repositorio. #### hide_discussion_comment[[huggingface_hub.HfApi.hide_discussion_comment]] ```python hide_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7940) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. comment_id (`str`) : El ID del comentario a editar. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionComment) el comentario oculto Oculta un comentario en una Discusión / Solicitud de extracción (Pull Request). > [!WARNING] > El contenido de los comentarios ocultos ya no se puede recuperar. Ocultar un comentario es irreversible. > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### inspect_job[[huggingface_hub.HfApi.inspect_job]] ```python inspect_job(job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12563) **Parámetros:** job_id (`str`) : ID del trabajo. namespace (`str`, *opcional*) : El espacio de nombres donde se está ejecutando el Job. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Inspeccionar un Job de cómputo en la infraestructura de Hugging Face. Ejemplo: ```python >>> from huggingface_hub import inspect_job, run_job >>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"]) >>> inspect_job(job_id=job.id) JobInfo( id='68780d00bbe36d38803f645f', created_at=datetime.datetime(2025, 7, 16, 20, 35, 12, 808000, tzinfo=datetime.timezone.utc), docker_image='python:3.12', space_id=None, command=['python', '-c', "print('Hello from HF compute!')"], arguments=[], environment={}, secrets={}, flavor='cpu-basic', status=JobStatus(stage='RUNNING', message=None) ) ``` #### inspect_scheduled_job[[huggingface_hub.HfApi.inspect_scheduled_job]] ```python inspect_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13285) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Inspeccionar un Job de cómputo programado en la infraestructura de Hugging Face. Ejemplo: ```python >>> from huggingface_hub import inspect_scheduled_job, create_scheduled_job >>> scheduled_job = create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly") >>> inspect_scheduled_job(scheduled_job_id=scheduled_job.id) ``` #### kernel_info[[huggingface_hub.HfApi.kernel_info]] ```python kernel_info(repo_id: str, revision: str | None = None, timeout: float | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3429) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`, *opcional*) : La revisión del repositorio del kernel desde la que obtener la información. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [ModelInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.ModelInfo) La información del repositorio del kernel. Obtén información sobre un kernel específico en huggingface.co. #### list_accepted_access_requests[[huggingface_hub.HfApi.list_accepted_access_requests]] ```python list_accepted_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10669) **Parámetros:** repo_id (`str`) : El id del repositorio para el que se deben obtener las solicitudes de acceso. repo_type (`str`, *opcional*) : El tipo de repositorio para el que se obtendrán las solicitudes de acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[AccessRequest]` Un iterable de objetos `AccessRequest`. Cada elemento contiene los atributos `username`, `request_id`, `email`, `status` y `timestamp`. Si el repositorio con acceso restringido tiene un formulario personalizado, el atributo `fields` se rellenará con las respuestas del usuario. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. Obtén las solicitudes de acceso aceptadas para un repositorio con control de acceso determinado. Una solicitud aceptada significa que el usuario ha solicitado acceso al repositorio y la solicitud ha sido aceptada. El usuario puede descargar cualquier archivo del repositorio. Si el modo de aprobación es automático, esta lista debe contener por defecto todas las solicitudes. Las solicitudes aceptadas pueden cancelarse o rechazarse en cualquier momento usando [cancel_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) y [reject_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Una solicitud cancelada volverá a la lista de pendientes, mientras que una solicitud rechazada pasará a la lista de rechazadas. En ambos casos, el usuario perderá el acceso al repositorio. Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. Ejemplo: ```py >>> from huggingface_hub import list_accepted_access_requests >>> requests = list(list_accepted_access_requests("meta-llama/Llama-2-7b")) >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', request_id='655f3a1c9e6b2d4f8a7c1e05', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='accepted', fields=None, ), ... ] ``` #### list_bucket_tree[[huggingface_hub.HfApi.list_bucket_tree]] ```python list_bucket_tree(bucket_id: str, prefix: str | None = None, recursive: bool | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14301) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). prefix (`str`, *opcional*) : Filtra los resultados a archivos cuya ruta comienza con este prefijo. recursive (`bool`, *opcional*) : Si `True`, lista los archivos de forma recursiva. Si `False` (predeterminado), lista solo los archivos y directorios en la raíz. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[Union[BucketFile, BucketFolder]]` Un iterable de objetos [BucketFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketFile) y `BucketFolder` que contiene información de archivos y directorios (ruta, etc.). Listar archivos en un bucket. Ejemplo: ```python >>> from huggingface_hub import list_bucket_tree >>> for file_info in list_bucket_tree(bucket_id="username/my-bucket"): ... print(file_info.path) >>> # Filter by prefix >>> for file_info in list_bucket_tree(bucket_id="username/my-bucket", prefix="models/"): ... print(file_info.path) ``` #### list_buckets[[huggingface_hub.HfApi.list_buckets]] ```python list_buckets(namespace: str | None = None, search: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14108) **Parámetros:** namespace (`str`, *opcional*) : Lista los buckets bajo este namespace (usuario u organización). Por defecto, lista los buckets del usuario. search (`str`, *opcional*) : Una cadena de búsqueda para filtrar nombres de cubos. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[BucketInfo]` Un iterable de objetos [BucketInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.BucketInfo). Listar los cubos en el Hub bajo un determinado espacio de nombres. Ejemplo: ```python >>> from huggingface_hub import list_buckets >>> for bucket in list_buckets(): # lists buckets in the user's namespace ... print(bucket) >>> for bucket in list_buckets(namespace="huggingface"): # lists buckets in the "huggingface" organization ... print(bucket) >>> for bucket in list_buckets(search="my-prefix"): # filter buckets by name ... print(bucket) ``` #### list_collections[[huggingface_hub.HfApi.list_collections]] ```python list_collections(owner: list[str] | str | None = None, item: list[str] | str | None = None, sort: CollectionSort_T | None = None, limit: int | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10096) **Parámetros:** owner (`list[str]` o `str`, *opcional*) : Filtrar por el nombre de usuario del propietario. item (`list[str]` o `str`, *opcional*) : Filtra colecciones que contienen elementos específicos. Ejemplo: `"models/teknium/OpenHermes-2.5-Mistral-7B"`, `"datasets/squad"` o `"papers/2311.12983"`. sort (`Literal["lastModified", "trending", "upvotes"]`, *opcional*) : Ordena las colecciones por última modificación, tendencias o votos a favor. limit (`int`, *opcional*) : Número máximo de colecciones que se devolverán. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[Collection]` un iterable de objetos [Collection](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.Collection). Listar colecciones en el Huggingface Hub, dados algunos filtros. > [!WARNING] > Al listar colecciones, la lista de elementos por colección se trunca a un máximo de 4 elementos. Para recuperar todos los elementos de una colección, debe usar [get_collection()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_collection). #### list_daily_papers[[huggingface_hub.HfApi.list_daily_papers]] ```python list_daily_papers(date: str | None = None, token: bool | str | None = None, week: str | None = None, month: str | None = None, submitter: str | None = None, sort: DailyPapersSort_T | None = None, p: int | None = None, limit: int | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11978) **Parámetros:** date (`str`, *opcional*) : Fecha en formato ISO (YYYY-MM-DD) para la que se deben obtener los artículos diarios. Por defecto, se obtienen los más recientes. token (Union[bool, str, None], *opcional*) : Un token de acceso de usuario válido (cadena). El valor predeterminado es el token guardado localmente. Para deshabilitar la autenticación, pase `False`. week (`str`, *opcional*) : Semana en formato ISO (YYYY-Www) para la que se deben obtener los artículos diarios. Ejemplo, `2025-W09`. month (`str`, *opcional*) : Mes en formato ISO (YYYY-MM) para el que se deben obtener los papeles diarios. Ejemplo, `2025-02`. submitter (`str`, *opcional*) : Nombre de usuario del remitente para filtrar los papeles diarios. sort (`Literal["publishedAt", "trending"]`, *opcional*) : Orden de clasificación para los papeles diarios. Puede ser por `publishedAt` o por `trending`. El valor predeterminado es `"publishedAt"` p (`int`, *opcional*) : Número de página para la paginación. El valor predeterminado es 0. limit (`int`, *opcional*) : Límite de artículos a recuperar. El valor predeterminado es 50. **Devuelve:** `Iterable[PaperInfo]` un iterable de objetos `huggingface_hub.hf_api.PaperInfo`. Muestra los artículos diarios publicados en una fecha determinada en el Hugging Face Hub. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> list(api.list_daily_papers(date="2025-10-29")) ``` #### list_dataset_parquet_files[[huggingface_hub.HfApi.list_dataset_parquet_files]] ```python list_dataset_parquet_files(repo_id: str, config: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2707) **Parámetros:** repo_id (`str`) : El ID del repositorio del conjunto de datos (p. ej. `"username/dataset-name"`). config (`str`, *opcional*) : Filtrar por un nombre específico de configuración/subconjunto. Cuando se proporciona, solo se devuelven los archivos parquet para esa configuración. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `list[DatasetParquetEntry]` una lista de objetos `DatasetParquetEntry` que contienen la configuración, la división, la URL y el tamaño de cada archivo parquet. Listar los archivos parquet disponibles para un conjunto de datos en el Hub. Todos los conjuntos de datos alojados en el Hub se convierten automáticamente a Parquet por el [Dataset Viewer](https://huggingface.co/docs/dataset-viewer/parquet). Este método devuelve la lista de archivos parquet con sus URLs, configuraciones, divisiones y tamaños. Ejemplo: ```python >>> from huggingface_hub import list_dataset_parquet_files >>> list_dataset_parquet_files("lhoestq/demo1") >>> entries[0] DatasetParquetEntry(config='default', split='train', url='https://huggingface.co/...', size=5038) ``` #### list_datasets[[huggingface_hub.HfApi.list_datasets]] ```python list_datasets(filter: str | Iterable[str] | None = None, author: str | None = None, benchmark: Literal[True] | Literal['official'] | str | None = None, dataset_name: str | None = None, gated: bool | None = None, language_creators: str | list[str] | None = None, language: str | list[str] | None = None, multilinguality: str | list[str] | None = None, size_categories: str | list[str] | None = None, task_categories: str | list[str] | None = None, task_ids: str | list[str] | None = None, search: str | None = None, sort: DatasetSort_T | None = None, limit: int | None = None, expand: list[ExpandDatasetProperty_T] | None = None, full: bool | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2502) **Parámetros:** filter (`str` o `Iterable[str]`, *opcional*) : Una cadena de caracteres o una lista de cadenas de caracteres para filtrar conjuntos de datos en el hub. author (`str`, *opcional*) : Una cadena que identifica al autor de los conjuntos de datos devueltos. benchmark (`True`, `"official"`, `str`, *opcional*) : Filtra conjuntos de datos por benchmark. Puede ser `True` o `"official"` para devolver conjuntos de datos de benchmark oficiales. Para compatibilidad futura, también puede ser una cadena que represente el nombre del benchmark (actualmente solo se admite "official"). dataset_name (`str`, *opcional*) : Una cadena o lista de cadenas que se puede utilizar para identificar conjuntos de datos en el Hub por su nombre, como `SQAC` o `wikineural` gated (`bool`, *opcional*) : Un valor booleano para filtrar los conjuntos de datos en el Hub que están restringidos o no. De forma predeterminada, se devuelven todos los conjuntos de datos. Si se pasa `gated=True`, solo se devuelven los conjuntos de datos restringidos. Si se pasa `gated=False`, solo se devuelven los conjuntos de datos no restringidos. language_creators (`str` o `List`, *opcional*) : Una cadena de caracteres o una lista de cadenas de caracteres que se puede utilizar para identificar conjuntos de datos en el Hub según cómo se curaron los datos, como `crowdsourced` o `machine_generated`. language (`str` o `List`, *opcional*) : Una cadena o lista de cadenas que representa un idioma de dos caracteres para filtrar conjuntos de datos en el Hub. multilinguality (`str` o `List`, *opcional*) : Una cadena o lista de cadenas que representa un filtro para conjuntos de datos que contienen varios idiomas. size_categories (`str` o `List`, *opcional*) : Una cadena de caracteres o una lista de cadenas de caracteres que se puede utilizar para identificar conjuntos de datos en el Hub por el tamaño del conjunto de datos, como `100K>> from huggingface_hub import HfApi >>> api = HfApi() # List all datasets >>> api.list_datasets() # List only the text classification datasets >>> api.list_datasets(filter="task_categories:text-classification") # List only the datasets in russian for language modeling >>> api.list_datasets( ... filter=("language:ru", "task_ids:language-modeling") ... ) # List FiftyOne datasets (identified by the tag "fiftyone" in dataset card) >>> api.list_datasets(filter="fiftyone") ``` Ejemplo de uso con el argumento `search`: ```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") ``` #### list_inference_catalog[[huggingface_hub.HfApi.list_inference_catalog]] ```python list_inference_catalog(accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = None, engine: Literal['llamacpp', 'sglang', 'tei', 'vllm'] | str | None = None, license: str | None = None, task: str | None = None, search: str | None = None, limit: int | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9587) **Parámetros:** accelerator (`str`, *opcional*) : Solo devuelve modelos que tengan una receta para este acelerador (`"cpu"`, `"gpu"` o `"neuron"`). engine (`str`, *opcional*) : Solo devuelve modelos que tengan una receta para este motor de inferencia (p. ej. `"vllm"`, `"llamacpp"`, `"tei"`, `"sglang"`). license (`str`, *opcional*) : Solo devuelve modelos bajo esta licencia (p. ej. `"Apache 2.0"`). task (`str`, *opcional*) : Devuelve solo modelos para esta tarea (p. ej. `"text-generation"`). search (`str`, *opcional*) : Solo devuelve modelos que coincidan con esta consulta de búsqueda. limit (`int`, *opcional*) : El número máximo de modelos a devolver. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). **Devuelve:** `list[InferenceCatalogModel]` Los modelos disponibles en el catálogo, cada uno con sus recetas probadas. Listar los modelos disponibles en el Catálogo de Inferencia de Hugging Face. El objetivo del Inference Catalog es proporcionar una lista curada de modelos optimizados para inferencia y para los cuales se han probado configuraciones predeterminadas. Consulte https://endpoints.huggingface.co/catalog para ver la lista de modelos disponibles en el catálogo. Use [create_inference_endpoint_from_catalog()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_inference_endpoint_from_catalog) para desplegar un modelo o una receta del catálogo. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> catalog = api.list_inference_catalog(task="text-generation", accelerator="neuron") >>> [(model.repo_id, [recipe.id for recipe in model.recipes]) for model in catalog] [('meta-llama/Llama-3.1-8B-Instruct', ['sizzling-biryani-g4xsi1ac', 'artisanal-quinoa-yz9ynamx']), ...] ``` > [!WARNING] > `list_inference_catalog` es experimental. Su API está sujeta a cambios en el futuro. Por favor, proporcione comentarios si tiene sugerencias o solicitudes. #### list_inference_endpoints[[huggingface_hub.HfApi.list_inference_endpoints]] ```python list_inference_endpoints(namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9147) **Parámetros:** namespace (`str`, *opcional*) : El espacio de nombres para el que se listarán los puntos finales. Por defecto, es el usuario actual. Establezca `"*"` para listar todos los puntos finales de todos los espacios de nombres (es decir, el espacio de nombres personal y todas las organizaciones a las que pertenece el usuario). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** lista[InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) Una lista de todos los puntos de inferencia para el espacio de nombres dado. Lista todos los puntos de inferencia para el espacio de nombres dado. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.list_inference_endpoints() [InferenceEndpoint(name='my-endpoint', ...), ...] ``` #### list_inference_endpoints_hardware[[huggingface_hub.HfApi.list_inference_endpoints_hardware]] ```python list_inference_endpoints_hardware(namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10038) **Parámetros:** namespace (`str`, *opcional*) : El espacio de nombres cuyo hardware disponible y cuota de acelerador se deben listar. Por defecto, es el usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). **Devuelve:** `list[InferenceEndpointHardware]` El hardware disponible en cada proveedor y región, incluido el hardware que actualmente no está disponible o está obsoleto. Muestra el hardware disponible para desplegar un Inference Endpoint. Cada entrada incluye los valores exactos de `vendor`, `region`, `accelerator`, `instance_type` y `instance_size` que espera [create_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_inference_endpoint), junto con el precio y la cuota de aceleradores del espacio de nombres. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> hardware = api.list_inference_endpoints_hardware() >>> [hw.id for hw in hardware if hw.accelerator == "gpu" and hw.status == "available"] ['aws-us-east-1-nvidia-l4-x1', 'aws-us-east-1-nvidia-l4-x4', ...] ``` #### list_jobs[[huggingface_hub.HfApi.list_jobs]] ```python list_jobs(status: list[JobStage | str] | JobStage | str | None = None, labels: dict[str, str] | None = None, timeout: int | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12487) **Parámetros:** status (`JobStage`, `str` o `list`, *opcional*) : Devuelve solo los Jobs con el estado o estados indicados, por ejemplo `"RUNNING"` o `[JobStage.RUNNING, JobStage.SCHEDULING]`. Consulta [JobStage](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobStage) para ver los valores posibles. labels (`dict[str, str]`, *opcional*) : Solo devuelve Jobs que tengan todas las etiquetas `key=value` dadas, p. ej. `{"env": "prod", "team": "ml"}`. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. namespace (`str`, *opcional*) : El espacio de nombres desde el que lista los trabajos. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** `Iterable[JobInfo]` un iterable de objetos [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo). Listar trabajos de cómputo en la infraestructura de Hugging Face. #### list_jobs_hardware[[huggingface_hub.HfApi.list_jobs_hardware]] ```python list_jobs_hardware(token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12535) **Devuelve:** `list[JobHardwareInfo]` Una lista de configuraciones de hardware disponibles. Muestra las opciones de hardware disponibles para los trabajos en la infraestructura de Hugging Face. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> hardware_list = api.list_jobs_hardware() >>> hardware_list[0] JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ephemeral_storage='20 GB', accelerator=None, unit_cost_micro_usd=167, unit_cost_usd=0.000167, unit_label='minute') >>> hardware_list[0].name 'cpu-basic' # Filter GPU options >>> gpu_hardware = [hw for hw in hardware_list if hw.accelerator is not None] >>> gpu_hardware[0].accelerator.model 'T4' ``` #### list_lfs_files[[huggingface_hub.HfApi.list_lfs_files]] ```python list_lfs_files(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4426) **Parámetros:** repo_id (`str`) : El repositorio para el que estás listando archivos LFS. repo_type (`str`, *opcional*) : Tipo de repositorio. Establezca `"dataset"` o `"space"` si se lista desde un dataset o space, `None` o `"model"` si se lista desde un model. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[LFSFileInfo]` Un iterador de objetos `LFSFileInfo`. Listar todos los archivos LFS de un repositorio en el Hub. Esto es útil principalmente para contar cuánto almacenamiento está usando un repositorio y, eventualmente, para limpiar archivos grandes con [permanently_delete_lfs_files()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.permanently_delete_lfs_files). Tenga en cuenta que esta sería una acción permanente que afectará a todos los commits que hacen referencia a estos archivos eliminados y que no se puede deshacer. Ejemplo: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> lfs_files = api.list_lfs_files("username/my-cool-repo") # Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`. # e.g. select only LFS files in the "checkpoints" folder >>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/")) # Permanently delete LFS files >>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete) ``` #### list_liked_repos[[huggingface_hub.HfApi.list_liked_repos]] ```python list_liked_repos(user: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2988) **Parámetros:** user (`str`, *opcional*) : Nombre del usuario para el que deseas obtener los me gusta. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [UserLikes](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.UserLikes) objeto que contiene el nombre de usuario y 3 listas de ids de repositorios (1 para modelos, 1 para conjuntos de datos y 1 para Spaces). **Excepciones:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si no se pasa `user` y no se encuentra ningún token (ni por argumento ni en la máquina). Listar todos los repositorios públicos que un usuario ha marcado con me gusta en huggingface.co. Esta lista es pública, por lo que el token es opcional. Si no se pasa `user`, se usa el usuario conectado por defecto. Véase también [unlike()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.unlike). Ejemplo: ```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", ...] ``` #### list_models[[huggingface_hub.HfApi.list_models]] ```python list_models(filter: str | Iterable[str] | None = None, author: str | None = None, apps: str | list[str] | None = None, gated: bool | None = None, inference: Literal['warm'] | None = None, inference_provider: Literal['all'] | PROVIDER_T | list[PROVIDER_T] | None = None, trained_dataset: str | list[str] | None = None, search: str | None = None, pipeline_tag: str | None = None, num_parameters: str | None = None, emissions_thresholds: tuple[float, float] | None = None, sort: ModelSort_T | None = None, limit: int | None = None, expand: list[ExpandModelProperty_T] | None = None, full: bool | None = None, cardData: bool = False, fetch_config: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2310) **Parámetros:** filter (`str` o `Iterable[str]`, *opcional*) : Una cadena de caracteres o una lista de cadenas de caracteres para filtrar modelos en el Hub. Los modelos se pueden filtrar por biblioteca, idioma, tarea, etiquetas y más. author (`str`, *opcional*) : Una cadena que identifica al autor (usuario u organización) de los modelos devueltos. apps (`str` o `List`, *opcional*) : Una cadena o lista de cadenas para filtrar modelos en el Hub que admitan las aplicaciones especificadas. Los valores de ejemplo incluyen `"ollama"` o `["ollama", "vllm"]`. gated (`bool`, *opcional*) : Un valor booleano para filtrar modelos en el Hub que estén o no restringidos. De forma predeterminada, se devuelven todos los modelos. Si se pasa `gated=True`, solo se devuelven los modelos restringidos. Si se pasa `gated=False`, solo se devuelven los modelos no restringidos. inference (`Literal["warm"]`, *opcional*) : Si es "warm", filtra los modelos del Hub que actualmente están servidos por al menos un proveedor. inference_provider (`Literal["all"]` o `str`, *opcional*) : Una cadena para filtrar modelos en el Hub que son servidos por un proveedor específico. Pasa `"all"` para obtener todos los modelos servidos por al menos un proveedor. trained_dataset (`str` o `List`, *opcional*) : Una etiqueta de cadena o una lista de etiquetas de cadenas del conjunto de datos entrenado para un modelo en el Hub. search (`str`, *opcional*) : Una cadena de caracteres que estará contenida en los identificadores de modelo devueltos. pipeline_tag (`str`, *opcional*) : Una etiqueta de pipeline de cadena para filtrar modelos en el Hub, como `summarization`. num_parameters (`str`, *opcional*) : Filtra modelos por número de parámetros. Acepta la misma sintaxis de rango que la interfaz y la API de Hub, por ejemplo `"min:6B,max:128B"`, `"min:6B"` o `"max:128B"`. emissions_thresholds (`Tuple`, *opcional*) : Una tupla de dos enteros o flotantes que representa una huella de carbono mínima y máxima para filtrar los modelos resultantes, en gramos. sort (`ModelSort_T`, *opcional*) : La clave con la que se ordenan los modelos resultantes. Los valores posibles son "created_at", "downloads", "last_modified", "likes" y "trending_score". limit (`int`, *opcional*) : El límite en el número de modelos obtenidos. Dejar esta opción en `None` obtiene todos los modelos. expand (`list[ExpandModelProperty_T]`, *opcional*) : Propiedades de la lista que se devolverán en la respuesta. Cuando se usa, solo se devolverán las propiedades de la lista. Este parámetro no se puede usar si se pasan `full`, `cardData` o `fetch_config`. Los valores posibles son `"author"`, `"cardData"`, `"config"`, `"createdAt"`, `"disabled"`, `"downloads"`, `"downloadsAllTime"`, `"evalResults"`, `"gated"`, `"gguf"`, `"inference"`, `"inferenceProviderMapping"`, `"lastModified"`, `"library_name"`, `"likes"`, `"mask_token"`, `"model-index"`, `"pipeline_tag"`, `"private"`, `"safetensors"`, `"sha"`, `"siblings"`, `"spaces"`, `"tags"`, `"transformersInfo"`, `"trendingScore"`, `"widgetData"` y `"resourceGroup"`. full (`bool`, *opcional*) : Si se deben obtener todos los datos del modelo, incluidos `last_modified`, `sha`, los archivos y las `tags`. Esto se establece en `True` de forma predeterminada al usar un filtro. cardData (`bool`, *opcional*) : Si se debe obtener también la metadatos del modelo. Puede contener información útil, como las emisiones de carbono, las métricas y los conjuntos de datos en los que se entrenó. fetch_config (`bool`, *opcional*) : Si se deben obtener también las configuraciones del modelo. Esto no está incluido en `full` debido a su tamaño. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[ModelInfo]` un iterable de objetos [huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.ModelInfo). Listar los modelos alojados en el Huggingface Hub, dados algunos filtros. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # List all models >>> api.list_models() # List text classification models >>> api.list_models(filter="text-classification") # List models from the KerasHub library >>> api.list_models(filter="keras-hub") # List models served by Cohere >>> api.list_models(inference_provider="cohere") # List models with "bert" in their name >>> api.list_models(search="bert") # List models with "bert" in their name and pushed by google >>> api.list_models(search="bert", author="google") # List models with 6B to 128B parameters >>> api.list_models(num_parameters="min:6B,max:128B", sort="likes") ``` #### list_organization_followers[[huggingface_hub.HfApi.list_organization_followers]] ```python list_organization_followers(organization: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11774) **Parámetros:** organization (`str`) : Nombre de la organización de la que se quieren obtener los seguidores. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[User]` Una lista de objetos [User](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.User) con los seguidores de la organización. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si la organización no existe en el Hub. Obtener la lista de seguidores de una organización en el Hub. #### list_organization_members[[huggingface_hub.HfApi.list_organization_members]] ```python list_organization_members(organization: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11803) **Parámetros:** organization (`str`) : Nombre de la organización de la que se deben obtener los miembros. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[User]` Una lista de objetos [User](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.User) con los miembros de la organización. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si la organización no existe en el Hub. Lista de miembros de una organización en el Hub. #### list_papers[[huggingface_hub.HfApi.list_papers]] ```python list_papers(query: str | None = None, limit: int | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11887) **Parámetros:** query (`str`, *opcional*) : Una cadena de consulta de búsqueda para encontrar artículos. Si se proporciona, devuelve los artículos que coinciden con la consulta. limit (`int`, *opcional*) : El número máximo de artículos a devolver. token (Union[bool, str, None], *opcional*) : Un token de acceso de usuario válido (cadena). El valor predeterminado es el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[PaperInfo]` un iterable de objetos `huggingface_hub.hf_api.PaperInfo`. Muestra los artículos diarios del Hugging Face Hub según una consulta de búsqueda. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # List all papers with "attention" in their title >>> api.list_papers(query="attention") ``` #### list_pending_access_requests[[huggingface_hub.HfApi.list_pending_access_requests]] ```python list_pending_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10604) **Parámetros:** repo_id (`str`) : El id del repositorio para el que se deben obtener las solicitudes de acceso. repo_type (`str`, *opcional*) : El tipo de repositorio para el que se obtendrán las solicitudes de acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[AccessRequest]` Un iterable de objetos `AccessRequest`. Cada elemento contiene los atributos `username`, `request_id`, `email`, `status` y `timestamp`. Si el repositorio con acceso restringido tiene un formulario personalizado, el atributo `fields` se rellenará con las respuestas del usuario. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. Obtén las solicitudes de acceso pendientes para un repositorio con control de acceso determinado. Una solicitud pendiente significa que el usuario ha solicitado acceso al repositorio, pero la solicitud aún no ha sido procesada. Si el modo de aprobación es automático, esta lista debería estar vacía. Las solicitudes pendientes pueden aceptarse o rechazarse mediante [accept_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) y [reject_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. Ejemplo: ```py >>> from huggingface_hub import list_pending_access_requests, accept_access_request # List pending requests >>> requests = list(list_pending_access_requests("meta-llama/Llama-2-7b")) >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', request_id='655f3a1c9e6b2d4f8a7c1e05', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='pending', fields=None, ), ... ] # Accept Clem's request >>> accept_access_request("meta-llama/Llama-2-7b", "clem") ``` #### list_rejected_access_requests[[huggingface_hub.HfApi.list_rejected_access_requests]] ```python list_rejected_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10732) **Parámetros:** repo_id (`str`) : El id del repositorio para el que se deben obtener las solicitudes de acceso. repo_type (`str`, *opcional*) : El tipo de repositorio para el que se obtendrán las solicitudes de acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[AccessRequest]` Un iterable de objetos `AccessRequest`. Cada elemento contiene los atributos `username`, `request_id`, `email`, `status` y `timestamp`. Si el repositorio con acceso restringido tiene un formulario personalizado, el atributo `fields` se rellenará con las respuestas del usuario. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. Obtener las solicitudes de acceso rechazadas para un repositorio con control de acceso determinado. Una solicitud rechazada significa que el usuario ha solicitado acceso al repositorio y la solicitud ha sido rechazada explícitamente por un propietario del repositorio (ya sea usted u otro usuario de su organización). El usuario no puede descargar ningún archivo del repositorio. Las solicitudes rechazadas pueden aceptarse o cancelarse en cualquier momento usando [accept_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) y [cancel_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request). Una solicitud cancelada volverá a la lista de pendientes, mientras que una solicitud aceptada pasará a la lista de aceptadas. Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. Ejemplo: ```py >>> from huggingface_hub import list_rejected_access_requests >>> requests = list(list_rejected_access_requests("meta-llama/Llama-2-7b")) >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', request_id='655f3a1c9e6b2d4f8a7c1e05', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='rejected', fields=None, ), ... ] ``` #### list_repo_commits[[huggingface_hub.HfApi.list_repo_commits]] ```python list_repo_commits(repo_id: str, repo_type: str | None = None, token: bool | str | None = None, revision: str | None = None, formatted: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4183) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está listando commits de un dataset o un Space, `None` o `"model"` si está listando de un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. formatted (`bool`) : Si se debe devolver el título y la descripción de los commits en formato HTML. El valor predeterminado es False. **Devuelve:** list[[GitCommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.GitCommitInfo)] lista de objetos que contienen información sobre los commits de un repositorio en el Hub. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la revisión no se encuentra (error 404) en el repositorio. Obtén la lista de commits de una revisión dada para un repositorio en el Hub. Los commits se ordenan por fecha (el commit más reciente primero). Ejemplo: ```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", branch="new_empty_branch", revision=initial_commit.commit_id) ``` #### list_repo_files[[huggingface_hub.HfApi.list_repo_files]] ```python list_repo_files(repo_id: str, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3829) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`, *opcional*) : La revisión del repositorio de la que se obtendrá la información. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `list[str]` la lista de archivos en un repositorio dado. Obtén la lista de archivos en un repositorio dado. #### list_repo_likers[[huggingface_hub.HfApi.list_repo_likers]] ```python list_repo_likers(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3105) **Parámetros:** repo_id (`str`) : El repositorio del que se obtendrá. Ejemplo: `"user/my-cool-model"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. **Devuelve:** `Iterable[User]` un iterable de objetos [huggingface_hub.hf_api.User](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.User). Listar todos los usuarios que le dieron me gusta a un repositorio dado en el hugging Face Hub. Véase también [list_liked_repos()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_liked_repos). #### list_repo_refs[[huggingface_hub.HfApi.list_repo_refs]] ```python list_repo_refs(repo_id: str, repo_type: str | None = None, include_pull_requests: bool = False, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4111) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. repo_type (`str`, *opcional*) : Establezca `"dataset"`, `"space"` o `"kernel"` si está listando refs de un dataset, un Space o un Kernel, `None` o `"model"` si está listando desde un model. El valor predeterminado es `None`. include_pull_requests (`bool`, *opcional*) : Si se incluyen referencias de solicitudes de extracción en la lista. El valor predeterminado es `False`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [GitRefs](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.GitRefs) objeto que contiene toda la información sobre ramas y etiquetas de un repositorio en el Hub. Obtén la lista de refs de un repositorio dado (tanto etiquetas como ramas). Ejemplo: ```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') ] ) ``` #### list_repo_tree[[huggingface_hub.HfApi.list_repo_tree]] ```python list_repo_tree(repo_id: str, path_in_repo: str | None = None, recursive: bool = False, expand: bool = False, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3866) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. path_in_repo (`str`, *opcional*) : Ruta relativa del árbol (carpeta) en el repositorio, por ejemplo: `"checkpoints/1fec34a/results"`. Por defecto, se utilizará el árbol (carpeta) raíz del repositorio. recursive (`bool`, *opcional*, por defecto `False`) : Si se deben listar los archivos y carpetas del árbol de forma recursiva. expand (`bool`, *opcional*, valor predeterminado `False`) : Si se debe obtener más información sobre los archivos y carpetas del árbol (p. ej., el último commit y los resultados del análisis de seguridad de los archivos). Esta operación es más costosa para el servidor, por lo que solo se devuelven 50 resultados por página (en lugar de 1000). Dado que la paginación está implementada en `huggingface_hub`, esto es transparente para ti, excepto por el tiempo que tarda en obtener los resultados. revision (`str`, *opcional*) : La revisión del repositorio desde la que se obtiene el árbol. El valor predeterminado es la rama `"main"`. repo_type (`str`, *opcional*) : El tipo de repositorio del que se obtendrá el árbol (`"model"`, `"dataset"`, `"space"` o `"kernel"`). El valor predeterminado es `"model"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[Union[RepoFile, RepoFolder]]` La información sobre los archivos y carpetas del árbol, como un iterable de objetos [RepoFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.RepoFile) y `RepoFolder`. El orden de los archivos y carpetas no está garantizado. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) o `~utils.RemoteEntryNotFoundError` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la revisión no se encuentra (error 404) en el repositorio. - `~utils.RemoteEntryNotFoundError` -- Si el árbol (carpeta) no existe (error 404) en el repositorio. Listar los archivos y carpetas de un árbol de repositorio y obtener información sobre ellos. Ejemplos: Obtén información sobre el árbol de un repositorio. ```py >>> from huggingface_hub import list_repo_tree >>> repo_tree = list_repo_tree("lysandre/arxiv-nlp") >>> repo_tree >>> list(repo_tree) [ RepoFile(path='.gitattributes', size=391, blob_id='ae8c63daedbd4206d7d40126955d4e6ab1c80f8f', lfs=None, last_commit=None, security=None), RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None), RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None), RepoFile( path='flax_model.msgpack', size=497764107, blob_id='8095a62ccb4d806da7666fcda07467e2d150218e', lfs={'size': 497764107, 'sha256': 'd88b0d6a6ff9c3f8151f9d3228f57092aaea997f09af009eefd7373a77b5abb9', 'pointer_size': 134}, last_commit=None, security=None ), RepoFile(path='merges.txt', size=456318, blob_id='226b0752cac7789c48f0cb3ec53eda48b7be36cc', lfs=None, last_commit=None, security=None), RepoFile( path='pytorch_model.bin', size=548123560, blob_id='64eaa9c526867e404b68f2c5d66fd78e27026523', lfs={'size': 548123560, 'sha256': '9be78edb5b928eba33aa88f431551348f7466ba9f5ef3daf1d552398722a5436', 'pointer_size': 134}, last_commit=None, security=None ), RepoFile(path='vocab.json', size=898669, blob_id='b00361fece0387ca34b4b8b8539ed830d644dbeb', lfs=None, last_commit=None, security=None)] ] ``` Obtén aún más información sobre el árbol de un repositorio (último commit y resultados del análisis de seguridad de los archivos) ```py >>> from huggingface_hub import list_repo_tree >>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True) >>> list(repo_tree) [ RepoFolder( path='feature_extractor', tree_id='aa536c4ea18073388b5b0bc791057a7296a00398', last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc) } ), RepoFolder( path='safety_checker', tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440', last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc) } ), RepoFile( path='model_index.json', size=582, blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1', lfs=None, last_commit={ 'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e', 'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)', 'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc) }, security={ 'safe': True, 'av_scan': {'virusFound': False, 'virusNames': None}, 'pickle_import_scan': None } ) ... ] ``` #### list_scheduled_jobs[[huggingface_hub.HfApi.list_scheduled_jobs]] ```python list_scheduled_jobs(labels: dict[str, str] | None = None, timeout: int | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13231) **Parámetros:** labels (`dict[str, str]`, *opcional*) : Solo devuelve los Jobs programados que tienen todas las etiquetas `key=value` dadas, p. ej. `{"env": "prod", "team": "ml"}`. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. namespace (`str`, *opcional*) : El espacio de nombres desde el que lista los trabajos. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** `list[ScheduledJobInfo]` una lista de objetos `ScheduledJobInfo`. Listar los trabajos de cómputo programados en la infraestructura de Hugging Face. #### list_space_templates[[huggingface_hub.HfApi.list_space_templates]] ```python list_space_templates(token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4548) **Parámetros:** token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `list[SpaceTemplate]` La lista de plantillas de Space disponibles. Muestra las plantillas de Space oficiales disponibles en el Hub. El `repo_id` de una plantilla devuelta (o su `name` abreviado) se puede pasar como `space_template` a [HfApi.create_repo()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_repo) para crear un nuevo Space a partir de esa plantilla. Ejemplo: ```py >>> from huggingface_hub import list_space_templates >>> templates = list_space_templates() >>> templates[0] SpaceTemplate(name='Streamlit', repo_id='streamlit/streamlit-template-space', sdk='docker', preferred_private=False) ``` #### list_spaces[[huggingface_hub.HfApi.list_spaces]] ```python list_spaces(filter: str | Iterable[str] | None = None, author: str | None = None, search: str | None = None, datasets: str | Iterable[str] | None = None, models: str | Iterable[str] | None = None, linked: bool = False, sort: SpaceSort_T | None = None, limit: int | None = None, expand: list[ExpandSpaceProperty_T] | None = None, full: bool | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2774) **Parámetros:** filter (`str` o `Iterable`, *opcional*) : Una etiqueta de cadena o una lista de etiquetas que se pueden usar para identificar Spaces en el Hub. author (`str`, *opcional*) : Una cadena que identifica al autor de los Spaces devueltos. search (`str`, *opcional*) : Una cadena que estará contenida en los Spaces devueltos. datasets (`str` o `Iterable`, *opcional*) : Si se deben devolver los Spaces que utilizan un conjunto de datos. El nombre de un conjunto de datos específico se puede pasar como una cadena. models (`str` o `Iterable`, *opcional*) : Si se deben devolver los Spaces que hacen uso de un modelo. El nombre de un modelo específico se puede pasar como una cadena de caracteres. linked (`bool`, *opcional*) : Si se deben devolver los Spaces que utilizan un modelo o un conjunto de datos. sort (`SpaceSort_T`, *opcional*) : La clave con la que se ordenan los espacios resultantes. Los valores posibles son "created_at", "last_modified", "likes" y "trending_score". limit (`int`, *opcional*) : El límite en el número de Spaces obtenidos. Dejar esta opción en `None` obtiene todos los Spaces. expand (`list[ExpandSpaceProperty_T]`, *opcional*) : Propiedades de la lista que se devolverán en la respuesta. Cuando se usa, solo se devolverán las propiedades de la lista. Este parámetro no se puede usar si se pasa `full`. Los valores posibles son `"author"`, `"cardData"`, `"datasets"`, `"disabled"`, `"lastModified"`, `"createdAt"`, `"likes"`, `"models"`, `"private"`, `"region"`, `"runtime"`, `"sdk"`, `"siblings"`, `"sha"`, `"subdomain"`, `"tags"`, `"trendingScore"`, `"usedStorage"` y `"resourceGroup"`. full (`bool`, *opcional*) : Si se deben obtener todos los datos de Spaces, incluidos los campos `last_modified`, `siblings` y `card_data`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[SpaceInfo]` un iterable de objetos [huggingface_hub.hf_api.SpaceInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.SpaceInfo). Listar los espacios alojados en el Huggingface Hub, dados algunos filtros. #### list_spaces_hardware[[huggingface_hub.HfApi.list_spaces_hardware]] ```python list_spaces_hardware(token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8260) **Devuelve:** `list[JobHardwareInfo]` Una lista de configuraciones de hardware disponibles. Muestra las opciones de hardware disponibles para Spaces. Ejemplo: ```python >>> from huggingface_hub import list_spaces_hardware >>> hardware_list = list_spaces_hardware() >>> hardware_list[0] JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ...) >>> hardware_list[0].name 'cpu-basic' ``` #### list_user_followers[[huggingface_hub.HfApi.list_user_followers]] ```python list_user_followers(username: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11831) **Parámetros:** username (`str`) : Nombre de usuario del usuario del que se deben obtener los seguidores. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[User]` Una lista de objetos [User](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.User) con los seguidores del usuario. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si el usuario no existe en el Hub. Obtén la lista de seguidores de un usuario en el Hub. #### list_user_following[[huggingface_hub.HfApi.list_user_following]] ```python list_user_following(username: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11859) **Parámetros:** username (`str`) : Nombre de usuario del usuario del que se quieren obtener los usuarios seguidos. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[User]` Una lista de objetos [User](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.User) con los usuarios seguidos por el usuario. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si el usuario no existe en el Hub. Obtén la lista de usuarios seguidos por un usuario en el Hub. #### list_user_repos[[huggingface_hub.HfApi.list_user_repos]] ```python list_user_repos(namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3065) **Parámetros:** namespace (`str`, *opcional*) : Nombre de la organización. Si no se proporciona, lista los repositorios del usuario autenticado. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Por defecto, se utiliza el token guardado localmente. **Devuelve:** `Iterable[RepoStorageInfo]` Un iterable de objetos `RepoStorageInfo`. Listar todos los repositorios (modelos, conjuntos de datos, espacios, cubos) de un usuario u organización con información de almacenamiento. Utiliza el punto de acceso `/api/settings/repositories` para el usuario autenticado o `/api/organizations/{namespace}/settings/repositories` para una organización. Ejemplo: ```python >>> from huggingface_hub import list_user_repos >>> repos = list(list_user_repos()) >>> repos[0] RepoStorageInfo(id='username/my-model', type='model', ...) >>> # List repos from an organization >>> repos = list(list_user_repos(namespace="my-org")) ``` #### list_webhooks[[huggingface_hub.HfApi.list_webhooks]] ```python list_webhooks(token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11125) **Parámetros:** token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `list[WebhookInfo]` Lista de objetos de información de webhook. Listar todos los webhooks configurados. Ejemplo: ```python >>> from huggingface_hub import list_webhooks >>> webhooks = list_webhooks() >>> len(webhooks) 2 >>> webhooks[0] WebhookInfo( id="654bbbc16f2ec14d77f109cc", 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, ) ``` #### merge_pull_request[[huggingface_hub.HfApi.merge_pull_request]] ```python merge_pull_request(repo_id: str, discussion_num: int, token: bool | str | None = None, comment: str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7830) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. comment (`str`, *opcional*) : Un comentario opcional para publicar junto con el cambio de estado. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [DiscussionStatusChange](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionStatusChange) el evento de cambio de estado Fusiona una Pull Request. > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### model_info[[huggingface_hub.HfApi.model_info]] ```python model_info(repo_id: str, revision: str | None = None, timeout: float | None = None, securityStatus: bool | None = None, files_metadata: bool = False, expand: list[ExpandModelProperty_T] | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3144) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`, *opcional*) : La revisión del repositorio del modelo desde la cual obtener la información. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. securityStatus (`bool`, *opcional*) : Si se debe recuperar también el estado de seguridad del repositorio del modelo. El estado de seguridad se devolverá en el campo `security_repo_status`. files_metadata (`bool`, *opcional*) : Si se deben recuperar o no los metadatos de los archivos del repositorio (tamaño, metadatos de LFS, etc.). El valor predeterminado es `False`. expand (`list[ExpandModelProperty_T]`, *opcional*) : Propiedades de la lista que se devolverán en la respuesta. Cuando se usa, solo se devolverán las propiedades de la lista. Este parámetro no se puede usar si se pasan `securityStatus` o `files_metadata`. Los valores posibles son `"author"`, `"baseModels"`, `"cardData"`, `"childrenModelCount"`, `"config"`, `"createdAt"`, `"disabled"`, `"downloads"`, `"downloadsAllTime"`, `"evalResults"`, `"gated"`, `"gguf"`, `"inference"`, `"inferenceProviderMapping"`, `"lastModified"`, `"library_name"`, `"likes"`, `"mask_token"`, `"model-index"`, `"pipeline_tag"`, `"private"`, `"safetensors"`, `"sha"`, `"siblings"`, `"spaces"`, `"tags"`, `"transformersInfo"`, `"trendingScore"`, `"widgetData"`, `"usedStorage"` y `"resourceGroup"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.ModelInfo) La información del repositorio del modelo. Obtén información sobre un modelo específico en huggingface.co El modelo puede ser privado si pasas un token aceptable o si has iniciado sesión. > [!TIP] > Lanza los siguientes errores: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Si no se puede encontrar la revisión del que se va a descargar. #### move_bucket[[huggingface_hub.HfApi.move_bucket]] ```python move_bucket(from_id: str, to_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14199) **Parámetros:** from_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de cubo separados por `/`. Identificador original del cubo (p. ej. `"username/my-bucket"`). to_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de cubo separados por `/`. Identificador final del cubo (p. ej. `"username/new-bucket-name"` o `"organization/my-bucket"`). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `BucketNotFoundError` - `BucketNotFoundError` -- Si no se puede encontrar el bucket de origen. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. Mover un bucket de "namespace1/repo_name1" a "namespace2/repo_name2" Tenga en cuenta que existen ciertas limitaciones. Para obtener más información sobre el traslado de repositorios, consulte https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo. Ejemplo: ```python >>> from huggingface_hub import move_bucket >>> # Rename a bucket within the same namespace >>> move_bucket(from_id="username/old-name", to_id="username/new-name") >>> # Transfer a bucket to an organization >>> move_bucket(from_id="username/my-bucket", to_id="my-org/my-bucket") ``` #### move_repo[[huggingface_hub.HfApi.move_repo]] ```python move_repo(from_id: str, to_id: str, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4918) **Parámetros:** from_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. Identificador del repositorio original. to_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. Identificador final del repositorio. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Mover un repositorio de namespace1/repo_name1 a namespace2/repo_name2 Tenga en cuenta que existen ciertas limitaciones. Para obtener más información sobre el traslado de repositorios, consulte https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo. > [!TIP] > Lanza los siguientes errores: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### paper_info[[huggingface_hub.HfApi.paper_info]] ```python paper_info(id: str) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11938) **Parámetros:** id (`str`, **opcional**) : id de ArXiv del artículo. **Devuelve:** `PaperInfo` Un objeto `PaperInfo`. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si el artículo no existe en el Hub. Obtén información sobre un artículo en el Hub. #### parse_safetensors_file_metadata[[huggingface_hub.HfApi.parse_safetensors_file_metadata]] ```python parse_safetensors_file_metadata(repo_id: str, filename: str, repo_type: str | None = None, revision: str | None = None, token: bool | str | None = None, timeout: float | None = 10) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6882) **Parámetros:** repo_id (`str`) : El nombre de un usuario u organización y el nombre de un repositorio separados por una `/`. filename (`str`) : El nombre del archivo en el repositorio. repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si el archivo está en un dataset o space, `None` o `"model"` si está en un model. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se obtiene el archivo. Puede ser el nombre de una rama, una etiqueta o un hash de commit. Por defecto, es la cabecera de la rama `"main"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. timeout (`float`, *opcional*, valor predeterminado 10) : Número de segundos que se espera a que el servidor envíe datos antes de abandonar la espera. Establezca `None` para deshabilitar el tiempo de espera (no se recomienda, ya que una conexión detenida puede bloquear la llamada indefinidamente). **Devuelve:** `SafetensorsFileMetadata` información relacionada con un archivo safetensors. **Excepciones:** `NotASafetensorsRepoError` o `SafetensorsParsingError` - `NotASafetensorsRepoError` -- Si el repositorio no es un repositorio de safetensors, es decir, si no contiene un archivo `model.safetensors` ni un archivo `model.safetensors.index.json`. - `SafetensorsParsingError` -- Si no se pudo analizar correctamente la cabecera de un archivo safetensors. Analizar los metadatos de un archivo safetensors en el Hub. Para analizar los metadatos de todos los archivos safetensors de un repositorio a la vez, use [get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata). Para más detalles sobre el formato safetensors, consulta https://huggingface.co/docs/safetensors/index#format. #### pause_inference_endpoint[[huggingface_hub.HfApi.pause_inference_endpoint]] ```python pause_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9922) **Parámetros:** name (`str`) : El nombre del Inference Endpoint que se va a pausar. namespace (`str`, *opcional*) : El espacio de nombres en el que se encuentra el Inference Endpoint. Por defecto, es el usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el Inference Endpoint pausado. Pausar un punto de inferencia. Un Inference Endpoint en pausa no genera cargos. Puede reanudarse en cualquier momento mediante [resume_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.resume_inference_endpoint). Esto es diferente de escalar el Inference Endpoint a cero con [scale_to_zero_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.scale_to_zero_inference_endpoint), que se reiniciaría automáticamente cuando se le envíe una solicitud. Por comodidad, también puede pausar un Inference Endpoint usando [pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint). #### pause_space[[huggingface_hub.HfApi.pause_space]] ```python pause_space(repo_id: str, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8419) **Parámetros:** repo_id (`str`) : ID del Space que se va a pausar. Ejemplo: `"Salesforce/BLIP2"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución de tu Space, incluida la `stage=PAUSED` y el hardware solicitado. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) o [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra tu Space (error 404). Lo más probable es que el repo_id sea incorrecto o que tu space sea privado y no estés autenticado. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: solo el propietario de un Space puede pausarlo. Si deseas administrar un Space que no es tuyo, solicita al propietario abriendo una Discussion o duplica el Space. - [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Si tu Space es un Space estático. Los Spaces estáticos siempre están en ejecución y nunca se facturan. Si quieres ocultar un Space estático, puedes configurarlo como privado. Pausa tu Space. Un Space en pausa deja de ejecutarse hasta que su propietario lo reinicie manualmente. Esto es diferente del estado de suspensión al que pasan los Spaces gratuitos tras 48 horas de inactividad. El tiempo en pausa no se factura en tu cuenta, sin importar el hardware que hayas seleccionado. Para reiniciar tu Space, usa [restart_space()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.restart_space) y ve a la página de configuración de tu Space. Para más detalles, visite [la documentación](https://huggingface.co/docs/hub/spaces-gpus#pause). #### permanently_delete_lfs_files[[huggingface_hub.HfApi.permanently_delete_lfs_files]] ```python permanently_delete_lfs_files(repo_id: str, lfs_files: Iterable[LFSFileInfo], rewrite_history: bool = True, repo_type: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4480) **Parámetros:** repo_id (`str`) : El repositorio para el que estás listando archivos LFS. lfs_files (`Iterable[LFSFileInfo]`) : Un iterable de elementos `LFSFileInfo` para eliminar permanentemente del repositorio. Utilice [list_lfs_files()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_lfs_files) para listar todos los archivos LFS de un repositorio. rewrite_history (`bool`, *opcional*, valor predeterminado `True`) : Si se debe reescribir el historial del repositorio para eliminar los punteros de archivo que hacen referencia a los archivos LFS eliminados (recomendado). repo_type (`str`, *opcional*) : Tipo de repositorio. Establezca `"dataset"` o `"space"` si se lista desde un dataset o space, `None` o `"model"` si se lista desde un model. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Eliminar permanentemente los archivos LFS de un repositorio en el Hub. > [!WARNING] > Esta es una acción permanente que afectará a todos los commits que hacen referencia a los archivos eliminados y podría corromper tu repositorio. Esta es una operación no reversible. Úsala solo si sabes lo que estás haciendo. Ejemplo: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> lfs_files = api.list_lfs_files("username/my-cool-repo") # Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`. # e.g. select only LFS files in the "checkpoints" folder >>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/")) # Permanently delete LFS files >>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete) ``` #### preupload_lfs_files[[huggingface_hub.HfApi.preupload_lfs_files]] ```python preupload_lfs_files(repo_id: str, additions: Iterable[CommitOperationAdd], token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, num_threads: int = 5, free_memory: bool = True, gitignore_content: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5311) **Parámetros:** repo_id (`str`) : El repositorio en el que se enviarán los archivos, por ejemplo: `"username/custom_transformers"`. additions (`Iterable` de [CommitOperationAdd](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitOperationAdd)) : La lista de archivos a subir. Advertencia: los objetos de esta lista se modificarán para incluir información relativa a la carga. No reutilice los mismos objetos para varios commits. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : El tipo de repositorio al que se subirá (p. ej. `"model"` -por defecto-, `"dataset"`, `"space"` o `"kernel"`). revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. create_pr (`boolean`, *opcional*) : Si planea o no crear una Pull Request con ese commit. El valor predeterminado es `False`. num_threads (`int`, *opcional*) : Número de hilos concurrentes para la carga de archivos. El valor predeterminado es 5. Establecerlo en 2 significa que se cargarán como máximo 2 archivos de forma concurrente. free_memory (`bool`, *opcional*, valor predeterminado `True`) : Si es `True`, el atributo `path_or_fileobj` de cada `CommitOperationAdd` se reemplaza por un objeto `bytes` vacío después de la carga para ahorrar memoria. Establezca `False` si necesita reutilizar los objetos de operación fuera de una llamada posterior a [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit). gitignore_content (`str`, *opcional*) : El contenido del archivo `.gitignore` para saber qué archivos deben ignorarse. El orden de prioridad es comprobar primero si se pasa `gitignore_content`, luego comprobar si el archivo `.gitignore` está presente en la lista de archivos a enviar y, por último, usar de forma predeterminada el archivo `.gitignore` ya alojado en el Hub (si lo hay). Sube los archivos LFS a S3 antes de preparar un commit futuro. Este método es útil si estás generando los archivos para subirlos al vuelo y no deseas almacenarlos en memoria antes de subirlos todos de una vez. > [!WARNING] > Este es un método para usuarios avanzados. No debería ser necesario llamarlo directamente para realizar un commit normal. En su lugar, use [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit) directamente. > [!WARNING] > Las operaciones de commit se modificarán durante el proceso. En particular, el `path_or_fileobj` adjunto se eliminará después de la carga para ahorrar memoria (y se reemplazará por un objeto `bytes` vacío). No reutilice los mismos objetos, excepto para pasarlos a [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit). Si no desea eliminar el contenido adjunto del objeto de operación de commit, pase `free_memory=False`. Ejemplo: ```py >>> from huggingface_hub import CommitOperationAdd, preupload_lfs_files, create_commit, create_repo >>> repo_id = create_repo("test_preupload").repo_id # Generate and preupload LFS files one by one >>> operations = [] # List of all `CommitOperationAdd` objects that will be generated >>> for i in range(5): ... content = ... # generate binary content ... addition = CommitOperationAdd(path_in_repo=f"shard_{i}_of_5.bin", path_or_fileobj=content) ... preupload_lfs_files(repo_id, additions=[addition]) # upload + free memory ... operations.append(addition) # Create commit >>> create_commit(repo_id, operations=operations, commit_message="Commit all shards") ``` #### read_paper[[huggingface_hub.HfApi.read_paper]] ```python read_paper(id: str) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11958) **Parámetros:** id (`str`) : id de ArXiv del artículo. **Devuelve:** `str` El contenido de la página del artículo en markdown. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Si el artículo no existe en el Hub. Obtén el contenido en markdown de una página de un artículo en el Hub. #### reject_access_request[[huggingface_hub.HfApi.reject_access_request]] ```python reject_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, rejection_reason: str | None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10925) **Parámetros:** repo_id (`str`) : El id del repositorio para el que se rechaza la solicitud de acceso. user (`str`, *opcional*) : El nombre de usuario del usuario cuya solicitud de acceso debe rechazarse. Debe proporcionarse exactamente uno de `user` o `request_id`. request_id (`str`, *opcional*) : El identificador de la solicitud de acceso a rechazar (consulte `AccessRequest`). Es obligatorio cuando el repositorio está configurado para no compartir los nombres de usuario de los solicitantes. Debe proporcionarse exactamente uno de `user` o `request_id`. repo_type (`str`, *opcional*) : El tipo de repositorio para el que se debe rechazar la solicitud de acceso. Debe ser uno de `model`, `dataset` o `space`. El valor predeterminado es `model`. rejection_reason (`str`, *opcional*) : Motivo de rechazo opcional que será visible para el usuario (máx. 200 caracteres). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 400 si el repositorio no está abierto. - `HfHubHTTPError` -- HTTP 403 si solo tienes acceso de solo lectura al repositorio. Esto puede ocurrir si no tienes el rol `write` o `admin` en la organización a la que pertenece el repositorio, o si pasaste un token de `read`. - `HfHubHTTPError` -- HTTP 404 si el usuario no existe en el Hub. - `HfHubHTTPError` -- HTTP 404 si no se puede encontrar la solicitud de acceso del usuario. - `HfHubHTTPError` -- HTTP 404 si la solicitud de acceso del usuario ya está en la lista de rechazados. Rechazar una solicitud de acceso de un usuario para un repositorio con control de acceso determinado. Una solicitud rechazada pasará a la lista de rechazadas. El usuario no podrá descargar ningún archivo del repositorio. Las solicitudes rechazadas pueden aceptarse o cancelarse en cualquier momento mediante [accept_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) y [cancel_access_request()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request). Una solicitud cancelada volverá a la lista de pendientes, mientras que una solicitud aceptada pasará a la lista de aceptadas. Para obtener más información sobre los repositorios con acceso restringido, consulte https://huggingface.co/docs/hub/models-gated. #### rename_discussion[[huggingface_hub.HfApi.rename_discussion]] ```python rename_discussion(repo_id: str, discussion_num: int, new_title: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7689) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. discussion_num (`int`) : El número de la Discusión o Pull Request. Debe ser un entero estrictamente positivo. new_title (`str`) : El nuevo título para la discusión repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se sube a un dataset o space, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [DiscussionTitleChange](/docs/huggingface_hub/v2.4.0/es/package_reference/community#huggingface_hub.DiscussionTitleChange) el evento de cambio de título Cambia el nombre de una Discusión. Ejemplos: ```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', ...) ``` > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. #### repo_exists[[huggingface_hub.HfApi.repo_exists]] ```python repo_exists(repo_id: str, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3677) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si obtiene información del repositorio de un dataset o un space, `None` o `"model"` si obtiene información del repositorio de un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** True si el repositorio existe, False en caso contrario. Comprueba si un repositorio existe en el Hugging Face Hub. Ejemplos: ```py >>> from huggingface_hub import repo_exists >>> repo_exists("google/gemma-7b") True >>> repo_exists("google/not-a-repo") False ``` #### repo_info[[huggingface_hub.HfApi.repo_info]] ```python repo_info(repo_id: str, revision: str | None = None, repo_type: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: ExpandModelProperty_T | ExpandDatasetProperty_T | ExpandSpaceProperty_T | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3469) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`, *opcional*) : La revisión del repositorio de la que se obtendrá la información. repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si obtiene información del repositorio de un dataset o un space, `None` o `"model"` si obtiene información del repositorio de un modelo. El valor predeterminado es `None`. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. expand (`ExpandModelProperty_T` o `ExpandDatasetProperty_T` o `ExpandSpaceProperty_T`, *opcional*) : Propiedades que se devolverán en la respuesta. Si se utiliza, solo se devolverán las propiedades de la lista. Este parámetro no se puede utilizar si se pasa `files_metadata`. Para obtener una lista exhaustiva de las propiedades disponibles, consulte [model_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.model_info), [dataset_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) o [space_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.space_info). files_metadata (`bool`, *opcional*) : Si se deben recuperar o no los metadatos de los archivos del repositorio (tamaño, metadatos de LFS, etc.). El valor predeterminado es `False`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Union[SpaceInfo, DatasetInfo, ModelInfo]` La información del repositorio, como un objeto [huggingface_hub.hf_api.DatasetInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DatasetInfo), [huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.ModelInfo) o [huggingface_hub.hf_api.SpaceInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.SpaceInfo). Obtenga el objeto de información para un repositorio dado de un tipo dado. > [!TIP] > Lanza los siguientes errores: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Si no se puede encontrar la revisión del que se va a descargar. #### request_space_hardware[[huggingface_hub.HfApi.request_space_hardware]] ```python request_space_hardware(repo_id: str, hardware: SpaceHardware, token: bool | str | None = None, sleep_time: int | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8323) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. hardware (`str` o [SpaceHardware](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceHardware)) : Hardware en el que se ejecutará el Space. Ejemplo: `"t4-medium"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. sleep_time (`int`, *opcional*) : Número de segundos de inactividad que se espera antes de que un Space entre en modo de suspensión. Establezca `-1` si no desea que su Space entre en suspensión (comportamiento predeterminado para el hardware actualizado). Para el hardware gratuito, no puede configurar el tiempo de suspensión (el valor está fijo en 48 horas de inactividad). Consulte https://huggingface.co/docs/hub/spaces-gpus#sleep-time para obtener más detalles. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución sobre un Space, incluida la etapa y el hardware del Space. Solicitar nuevo hardware para un Space. > [!TIP] > También es posible solicitar hardware directamente al crear el repositorio de Space. Consulte [create_repo()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_repo) para más detalles. #### rerun_job[[huggingface_hub.HfApi.rerun_job]] ```python rerun_job(job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12728) **Parámetros:** job_id (`str`) : ID del Job que se debe reejecutar. namespace (`str`, *opcional*) : Espacio de nombres del trabajo. El valor predeterminado es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Token de acceso del usuario. Por defecto, se utiliza el token guardado localmente. **Devuelve:** [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) El trabajo recién iniciado. Ejecuta un nuevo Job usando la especificación del Job existente, incluidos sus ajustes de reintento y recursos. #### resolve_revision[[huggingface_hub.HfApi.resolve_revision]] ```python resolve_revision(repo_id: str, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_files_only: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3544) **Parámetros:** repo_id (`str`) : El nombre de un usuario u organización y el nombre de un repositorio separados por una `/`. repo_type (`str`, *opcional*) : Establezca `"dataset"`, `"space"` o `"kernel"` si el repositorio es un repositorio de dataset, space o kernel, `None` o `"model"` si es un modelo. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión a resolver. Puede ser el nombre de una rama, una etiqueta, una referencia de PR o un hash de commit. El valor predeterminado es la rama predeterminada. Si se pasa un [ResolvedRevision](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.ResolvedRevision), se devuelve tal cual, a menos que se haya resuelto contra otro repositorio, en cuyo caso se vuelve a resolver la revisión que se solicitó inicialmente. cache_dir (`str`, `Path`, *opcional*) : Ruta a la carpeta donde se almacenan los archivos en caché. El valor predeterminado es el de `HF_HUB_CACHE`. local_files_only (`bool`, *opcional*, por defecto `False`) : Si es `True`, resuelve la revisión solo desde la caché local, sin contactar con el Hub. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [ResolvedRevision](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.ResolvedRevision) Subclase de `str` que contiene tanto la revisión solicitada como el hash de commit al que se resuelve. **Excepciones:** [RevisionResolutionError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionResolutionError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) o [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [RevisionResolutionError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionResolutionError) -- Si no se puede resolver la revisión: no se pudo acceder al Hub y no hay nada en caché local. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la revisión no existe en el Hub. - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se puede encontrar el repositorio. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. Resuelve una revisión (rama, etiqueta, referencia de PR) a un hash de commit. Esto está pensado para las librerías que descargan y cargan varios componentes de un repositorio por separado (config, pesos, tokenizer, ...). Resolver la revisión una vez y pasar el [ResolvedRevision](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.ResolvedRevision) devuelto garantiza que cada llamada posterior apunte al mismo commit exacto, incluso si el repositorio se actualiza mientras tanto. También ahorra llamadas HTTP, ya que las descargas realizadas con un hash de commit pueden servirse desde la caché local sin contactar con el Hub. El mapeo de `revision` -> `commit hash` se almacena en caché en el disco (en la carpeta `refs/` de la caché) de la mejor manera posible. Si más adelante no se puede acceder al Hub (modo sin conexión, error de conexión, tiempo de espera agotado, caída del Hub, ...), se utiliza el valor en caché como alternativa. > [!TIP] > Si solo necesitas descargar una instantánea completa del repositorio, una sola llamada a [snapshot_download()](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.snapshot_download) es suficiente y ya hace lo correcto. `resolve_revision` solo es útil al descargar archivos por separado. Ejemplo: ```py >>> from huggingface_hub import hf_hub_download, resolve_revision >>> revision = resolve_revision("openai-community/gpt2") >>> revision ResolvedRevision(initial=None, resolved='607a30d783dfa663caf39e06633721c8d4cfcd7e') # Pass it around: every download is pinned to the same commit >>> config = hf_hub_download("openai-community/gpt2", "config.json", revision=revision) >>> weights = hf_hub_download("openai-community/gpt2", "model.safetensors", revision=revision) ``` #### restart_space[[huggingface_hub.HfApi.restart_space]] ```python restart_space(repo_id: str, token: bool | str | None = None, factory_reboot: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8542) **Parámetros:** repo_id (`str`) : ID del Space que se va a reiniciar. Ejemplo: `"Salesforce/BLIP2"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. factory_reboot (`bool`, *opcional*) : Si `True`, el Space se reconstruirá desde cero sin cachear ningún requisito. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución sobre tu Space. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) o [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra tu Space (error 404). Lo más probable es que el repo_id sea incorrecto o que tu space sea privado y no estés autenticado. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: solo el propietario de un Space puede reiniciarlo. Si deseas reiniciar un Space que no te pertenece, solicita al propietario abriendo una Discussion o duplica el Space. - [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Si tu Space es un Space estático. Los Spaces estáticos siempre están en ejecución y nunca se facturan. Si quieres ocultar un Space estático, puedes configurarlo como privado. Reinicia tu Space. Esta es la única forma de reiniciar un Space de manera programática si lo has puesto en Pausa (consulta [pause_space()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.pause_space)). Debes ser el propietario del Space para poder reiniciarlo. Si estás utilizando un hardware de nivel superior, se realizará un cargo a tu cuenta en cuanto se reinicie el Space. Puedes iniciar un reinicio independientemente del estado actual del Space. Para más detalles, visite [la documentación](https://huggingface.co/docs/hub/spaces-gpus#pause). #### resume_inference_endpoint[[huggingface_hub.HfApi.resume_inference_endpoint]] ```python resume_inference_endpoint(name: str, namespace: str | None = None, running_ok: bool = True, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9957) **Parámetros:** name (`str`) : El nombre del Inference Endpoint que se va a reanudar. namespace (`str`, *opcional*) : El espacio de nombres en el que se encuentra el Inference Endpoint. Por defecto, es el usuario actual. running_ok (`bool`, *opcional*) : Si `True`, el método no lanzará un error si el Inference Endpoint ya está en ejecución. El valor predeterminado es `True`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el Inference Endpoint reanudado. Resumir un punto de inferencia. Para su comodidad, también puede reanudar un Inference Endpoint usando [InferenceEndpoint.resume()](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.resume). #### resume_scheduled_job[[huggingface_hub.HfApi.resume_scheduled_job]] ```python resume_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13384) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Resume (reanudar) un Job de cómputo programado en la infraestructura de Hugging Face. #### revision_exists[[huggingface_hub.HfApi.revision_exists]] ```python revision_exists(repo_id: str, revision: str, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3721) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`) : La revisión del repositorio a verificar. repo_type (`str`, *opcional*) : Establezca en `"dataset"` o `"space"` si obtiene información del repositorio de un dataset o un space, `None` o `"model"` si obtiene información del repositorio de un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** True si el repositorio y la revisión existen, False en caso contrario. Comprueba si una revisión específica existe en un repositorio del Hugging Face Hub. Ejemplos: ```py >>> from huggingface_hub import revision_exists >>> revision_exists("google/gemma-7b", "float16") True >>> revision_exists("google/gemma-7b", "not-a-revision") False ``` #### run_as_future[[huggingface_hub.HfApi.run_as_future]] ```python run_as_future(fn: Callable[..., R], *args, **kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2178) **Parámetros:** fn (`Callable`) : El método que se ejecutará en segundo plano. - ***args,** **kwargs : Argumentos con los que se llamará al método. **Devuelve:** `Future` una instancia de [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) para obtener el resultado de la tarea. Ejecuta un método en segundo plano y devuelve una instancia de Future. El objetivo principal es ejecutar métodos sin bloquear el hilo principal (por ejemplo, para enviar datos durante un entrenamiento). Las tareas en segundo plano se encolan para preservar el orden, pero no se ejecutan en paralelo. Si necesitas acelerar tus scripts paralelizando muchas llamadas a la API, debes configurar y usar tu propio [ThreadPoolExecutor](https://docs.python.org/3/library/concurrent.futures.html#threadpoolexecutor). Nota: Los métodos más utilizados, como [upload_file()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.upload_file), [upload_folder()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.upload_folder) y [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit), tienen un argumento `run_as_future: bool` para llamarlos directamente en segundo plano. Esto es equivalente a llamar `api.run_as_future(...)` sobre ellos, pero es menos verboso. Ejemplo: ```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 ``` #### run_job[[huggingface_hub.HfApi.run_job]] ```python run_job(image: str, command: list[str], env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, ssh: bool = False, network_group: str | None = None, network_aliases: list[str] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12122) **Parámetros:** image (`str`) : La imagen de Docker que se va a utilizar. Ejemplos: `"ubuntu"`, `"python:3.12"`, `"pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"`. Ejemplo con una imagen de un Space: `"hf.co/spaces/lhoestq/duckdb"`. command (`list[str]`) : El comando a ejecutar. Ejemplo: `["echo", "hello"]`. env (`dict[str, Any]`, *opcional*) : Define las variables de entorno para el Job. secrets (`dict[str, Any]`, *opcional*) : Define las variables de entorno secretas para el Job. flavor (`str`, *opcional*) : Sabor para el hardware. Consulte `JobHardware` para los valores posibles. El valor predeterminado es `"cpu-basic"`. timeout (`Union[int, float, str]`, *opcional*) : Duración máxima para el Job: int con s (segundos, predeterminado), m (minutos), h (horas) o d (días). Ejemplo: `300` o `"5m"` para 5 minutos. attempts (`int`, *opcional*) : Número máximo de intentos, incluida la ejecución inicial. El valor predeterminado es 1. Por ejemplo, 3 reintenta un Job fallido hasta 2 veces. name (`str`, *opcional*) : Un nombre para el Job. Se almacena como la etiqueta `name`. No se puede pasar junto con una clave `name` en `labels`. Los nombres no tienen que ser únicos. El valor predeterminado es un nombre derivado de la imagen y el comando (con un sufijo de hash corto). labels (`dict[str, str]`, *opcional*) : Etiquetas para adjuntar al trabajo (pares clave-valor). volumes (`list[Volume]`, *opcional*) : Buckets o Repositorios de Hugging Face para montar como volúmenes en el contenedor del trabajo. Cada volumen es un [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) con `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), `source` (p. ej. `"username/my-bucket"`) y `mount_path` (p. ej. `"/data"`). expose (`list[int]`, *opcional*) : Puertos de contenedor que se expondrán a través del proxy de trabajos. Cada puerto listado es accesible en el dominio público de trabajos (p. ej. `https://--8000.hf.jobs`). El acceso siempre requiere un token de HF con permiso de lectura en el espacio de nombres del trabajo. Utilice `expose_public` para acceso sin autenticación. expose_public (`list[int]`, *opcional*) : Puertos para exponer a través del proxy de Jobs sin autenticación. No es necesario que estén listados en `expose`. ssh (`bool`, *opcional*) : Si es True, el contenedor del trabajo es accesible mediante SSH en la URL indicada por `job.status.ssh_url` (p. ej. `ssh @ssh.hf.jobs`, o `hf jobs ssh ` desde la CLI). La conexión requiere acceso de escritura al espacio de nombres del trabajo y una clave pública SSH registrada en el Hub (https://huggingface.co/settings/keys). El valor predeterminado es False. network_group (`str`, *opcional*) : Nombre de un grupo de red al que unirse. Los trabajos en el mismo espacio de nombres y grupo de recursos que comparten un grupo se colocan juntos y pueden comunicarse entre sí en todos los puertos. Dentro de cada miembro, `HF_NETWORK_GROUP_HOSTNAME` se resuelve a todos los miembros del grupo. Alfanuméricos en minúsculas y guiones, máximo 46 caracteres. network_aliases (`list[str]`, *opcional*) : Alias que este trabajo reclama en su grupo de red. Los miembros acceden a los trabajos que reclaman un alias en `${HF_NETWORK_GROUP_PREFIX}`. Varios trabajos pueden reclamar el mismo alias. Alfanuméricos en minúsculas y guiones, máximo 34 caracteres, único dentro del trabajo. Requiere `network_group`. resource_group_id (`str`, *opcional*) : El ID del grupo de recursos en el que se creará el Job. Se utiliza para controlar el acceso a los recursos dentro de una organización y para las funciones de atribución de costos y límites de gasto. Si no se proporciona, el Job se creará fuera de cualquier grupo de recursos. namespace (`str`, *opcional*) : El espacio de nombres donde se creará el Job. Por defecto, se utiliza el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Ejecuta trabajos de cómputo en la infraestructura de Hugging Face. Ejemplo: Ejecuta tu primer Job: ```python >>> from huggingface_hub import run_job >>> run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"]) ``` Ejecutar un trabajo de GPU: ```python >>> from huggingface_hub import run_job >>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel" >>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"] >>> run_job(image=image, command=command, flavor="a10g-small") ``` Ejecutar un trabajo con volúmenes: ```python >>> from huggingface_hub import Volume, run_job >>> dataset_volume = Volume(type="dataset", source="HuggingFaceFW/fineweb", mount_path="/data") >>> output_bucket_volume = Volume(type="bucket", source="username/my-bucket", mount_path="/output") >>> image = "duckdb/duckdb" >>> command = ["duckdb", "-c", "COPY (SELECT * FROM '/data/**/*.parquet' LIMIT 5) TO '/output/first-rows.parquet'"] >>> run_job(image=image, command=command, volumes=[dataset_volume, output_bucket_volume]) ``` #### run_uv_job[[huggingface_hub.HfApi.run_uv_job]] ```python run_uv_job(script: str, script_args: list[str] | None = None, dependencies: list[str] | None = None, python: str | None = None, image: str | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, ssh: bool = False, network_group: str | None = None, network_aliases: list[str] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12871) **Parámetros:** script (`str`) : Ruta o URL del script de UV, o un comando. script_args (`list[str]`, *opcional*) : Argumentos para pasar al script o comando. dependencies (`list[str]`, *opcional*) : Dependencias para usar al ejecutar el script de UV. python (`str`, *opcional*) : Use una versión específica de Python. El valor predeterminado es 3.12. image (`str`, *opcional*, valor predeterminado "ghcr.io/astral-sh/uv --python3.12-bookworm"): Use una imagen de Docker personalizada con `uv` instalado. env (`dict[str, Any]`, *opcional*) : Define las variables de entorno para el Job. secrets (`dict[str, Any]`, *opcional*) : Define las variables de entorno secretas para el Job. flavor (`str`, *opcional*) : Sabor para el hardware. Consulte `JobHardware` para los valores posibles. El valor predeterminado es `"cpu-basic"`. timeout (`Union[int, float, str]`, *opcional*) : Duración máxima para el Job: int con s (segundos, predeterminado), m (minutos), h (horas) o d (días). Ejemplo: `300` o `"5m"` para 5 minutos. attempts (`int`, *opcional*) : Número máximo de intentos, incluida la ejecución inicial. El valor predeterminado es 1. name (`str`, *opcional*) : Un nombre para el Job. Se almacena como la etiqueta `name`. No se puede pasar junto con una clave `name` en `labels`. Los nombres no tienen que ser únicos. El valor predeterminado es un nombre derivado del script y sus argumentos (con un sufijo de hash corto). labels (`dict[str, str]`, *opcional*) : Etiquetas para adjuntar al trabajo (pares clave-valor). volumes (`list[Volume]`, *opcional*) : Buckets o Repositorios de Hugging Face para montar como volúmenes en el contenedor del trabajo. Cada volumen es un [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) con `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), `source` (p. ej. `"username/my-bucket"`) y `mount_path` (p. ej. `"/data"`). expose (`list[int]`, *opcional*) : Puertos de contenedor que se expondrán a través del proxy de trabajos. Cada puerto listado es accesible en el dominio público de trabajos (p. ej. `https://--8000.hf.jobs`). El acceso siempre requiere un token de HF con permiso de lectura en el espacio de nombres del trabajo. Utilice `expose_public` para acceso sin autenticación. expose_public (`list[int]`, *opcional*) : Puertos para exponer a través del proxy de Jobs sin autenticación. No es necesario que estén listados en `expose`. ssh (`bool`, *opcional*) : Si es True, el contenedor del trabajo es accesible mediante SSH en la URL indicada por `job.status.ssh_url` (p. ej. `ssh @ssh.hf.jobs`, o `hf jobs ssh ` desde la CLI). La conexión requiere acceso de escritura al espacio de nombres del trabajo y una clave pública SSH registrada en el Hub (https://huggingface.co/settings/keys). El valor predeterminado es False. network_group (`str`, *opcional*) : Nombre de un grupo de red al que unirse. Los trabajos en el mismo espacio de nombres y grupo de recursos que comparten un grupo se colocan juntos y pueden comunicarse entre sí en todos los puertos. Dentro de cada miembro, `HF_NETWORK_GROUP_HOSTNAME` se resuelve a todos los miembros del grupo. Alfanuméricos en minúsculas y guiones, máximo 46 caracteres. network_aliases (`list[str]`, *opcional*) : Alias que este trabajo reclama en su grupo de red. Los miembros acceden a los trabajos que reclaman un alias en `${HF_NETWORK_GROUP_PREFIX}`. Varios trabajos pueden reclamar el mismo alias. Alfanuméricos en minúsculas y guiones, máximo 34 caracteres, único dentro del trabajo. Requiere `network_group`. resource_group_id (`str`, *opcional*) : El ID del grupo de recursos en el que se creará el Job. Se utiliza para controlar el acceso a los recursos dentro de una organización y para las funciones de atribución de costos y límites de gasto. Si no se proporciona, el Job se creará fuera de cualquier grupo de recursos. namespace (`str`, *opcional*) : El espacio de nombres donde se creará el Job. Por defecto, se utiliza el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Ejecuta un trabajo de script de UV en la infraestructura de Hugging Face. > [!WARNING] > A diferencia de `hf jobs uv run`, este método ignora la tabla opcional `[tool.hf-jobs]` que un script de UV puede incluir en su encabezado PEP 723 (consulte la [Guía de Jobs](../guides/jobs#ship-the-launch-config-with-the-script)): la configuración de lanzamiento debe pasarse de forma explícita aquí. Ejemplo: Ejecutar un script desde una URL: ```python >>> from huggingface_hub import run_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"] >>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small") ``` Ejecutar un script local: ```python >>> from huggingface_hub import run_uv_job >>> script = "my_sft.py" >>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"] >>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small") ``` Ejecuta un comando: ```python >>> from huggingface_hub import run_uv_job >>> script = "lighteval" >>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"] >>> run_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small") ``` Montar volúmenes, por ejemplo, para guardar puntos de control del modelo durante el entrenamiento: ```python >>> from huggingface_hub import Volume, run_uv_job >>> script = "my_sft.py" >>> script_args = ["--output_dir", "/training-outputs/training-v3-final", ...] >>> checkpoints_bucket = Volume(type="bucket", source="username/my-bucket", mount_path="/training-outputs") >>> run_uv_job(script, script_args=script_args, volumes=[checkpoints_bucket]) ``` #### scale_to_zero_inference_endpoint[[huggingface_hub.HfApi.scale_to_zero_inference_endpoint]] ```python scale_to_zero_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10003) **Parámetros:** name (`str`) : El nombre del Inference Endpoint que se debe escalar a cero. namespace (`str`, *opcional*) : El espacio de nombres en el que se encuentra el Inference Endpoint. Por defecto, es el usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el Inference Endpoint escalado a cero. Escalar el punto de inferencia a cero. Un Inference Endpoint escalado a cero no se facturará. Se reanudará en la siguiente solicitud, con un retraso de arranque en frío. Esto es diferente a pausar el Inference Endpoint con [pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint), lo cual requeriría una reanudación manual con [resume_inference_endpoint()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.resume_inference_endpoint). Por comodidad, también puede escalar un Inference Endpoint a cero usando [InferenceEndpoint.scale_to_zero()](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.scale_to_zero). #### search_spaces[[huggingface_hub.HfApi.search_spaces]] ```python search_spaces(query: str, filter: str | Iterable[str] | None = None, sdk: str | list[str] | None = None, include_non_running: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2878) **Parámetros:** query (`str`) : La cadena de texto de la consulta de búsqueda. filter (`str` o `Iterable[str]`, *opcional*) : Una etiqueta de cadena o una lista de etiquetas para filtrar. sdk (`str` o `list[str]`, *opcional*) : Filtrar por SDK (p. ej. `"gradio"`, `"docker"`, `"static"`). include_non_running (`bool`, *opcional*) : Si se incluyen Spaces que no están en ejecución en los resultados. El valor predeterminado es `False`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `Iterable[SpaceSearchResult]` un iterable de objetos [SpaceSearchResult](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.SpaceSearchResult). Espacios de búsqueda en el Hub mediante búsqueda semántica. Este punto de acceso utiliza búsqueda semántica (basada en embeddings) para consultas de varias palabras y búsqueda de texto completo para consultas de una sola palabra. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> results = list(api.search_spaces("generate image")) >>> results[0].id 'mrfakename/Z-Image-Turbo' >>> results[0].ai_category 'Image Generation' ``` #### set_space_sleep_time[[huggingface_hub.HfApi.set_space_sleep_time]] ```python set_space_sleep_time(repo_id: str, sleep_time: int, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8373) **Parámetros:** repo_id (`str`) : ID del repositorio que se actualizará. Ejemplo: `"bigcode/in-the-stack"`. sleep_time (`int`, *opcional*) : Número de segundos de inactividad que se espera antes de que un Space se ponga en suspensión. Establezca `-1` si no desea que su Space se pause (comportamiento predeterminado para el hardware actualizado). Para el hardware gratuito, no puede configurar el tiempo de suspensión (el valor está fijo en 48 horas de inactividad). Consulte https://huggingface.co/docs/hub/spaces-gpus#sleep-time para obtener más detalles. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Información de tiempo de ejecución sobre un Space, incluida la etapa y el hardware del Space. Establece un tiempo de suspensión personalizado para un Space que se ejecuta en hardware actualizado. Tu Space entrará en modo de suspensión tras X segundos de inactividad. No se te factura cuando tu Space está en modo de "suspensión". Si un nuevo visitante accede a tu Space, este se "despertará". Solo el hardware actualizado puede tener un tiempo de suspensión configurable. Para obtener más información sobre la etapa de suspensión, consulta https://huggingface.co/docs/hub/spaces-gpus#sleep-time. > [!TIP] > También es posible establecer un tiempo de espera personalizado al solicitar hardware con [request_space_hardware()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.request_space_hardware). #### set_space_volumes[[huggingface_hub.HfApi.set_space_volumes]] ```python set_space_volumes(repo_id: str, volumes: list[Volume], token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9057) **Parámetros:** repo_id (`str`) : ID del Space que se va a actualizar. Ejemplo: `"username/my-space"`. volumes (`list[Volume]`) : Lista de objetos [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) para montar. Cada volumen tiene un `type` (`"bucket"`, `"model"`, `"dataset"` o `"space"`), un `source` (ID de repositorio o bucket), un `mount_path` (ruta dentro del contenedor) y los campos opcionales `revision`, `read_only` y `path`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `BadRequestError` - `BadRequestError` -- Si el Space es un Space estático (los volúmenes no se admiten en Spaces estáticos). Establecer volúmenes para un Space. Sets (o reemplaza) la lista de volúmenes montados en el Space. Cada volumen otorga al contenedor del Space acceso a un recurso del Hub (modelo, conjunto de datos o cubo de almacenamiento). Ejemplo: ```python >>> from huggingface_hub import HfApi, Volume >>> api = HfApi() >>> api.set_space_volumes( ... "username/my-space", ... volumes=[ ... Volume(type="model", source="username/my-model", mount_path="/models", read_only=True), ... Volume(type="bucket", source="username/my-bucket", mount_path="/data"), ... ], ... ) ``` #### snapshot_download[[huggingface_hub.HfApi.snapshot_download]] ```python snapshot_download(repo_id: str, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_dir: str | Path | None = None, etag_timeout: float = 10, force_download: bool = False, token: bool | str | None = None, local_files_only: bool = False, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, max_workers: int = 8, tqdm_class: type[base_tqdm] | None = None, dry_run: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6546) **Parámetros:** repo_id (`str`) : El nombre de un usuario u organización y el nombre de un repositorio separados por una `/`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está descargando desde un dataset o space, `None` o `"model"` si está descargando desde un model. El valor predeterminado es `None`. revision (`str`, *opcional*) : Un identificador de revisión de Git opcional, que puede ser un nombre de rama, una etiqueta o un hash de commit. cache_dir (`str`, `Path`, *opcional*) : Ruta a la carpeta donde se almacenan los archivos en caché. local_dir (`str` o `Path`, *opcional*) : Si se proporciona, los archivos descargados se colocarán en este directorio. etag_timeout (`float`, *opcional*, valor predeterminado `10`) : Al obtener el ETag, cuántos segundos esperar a que el servidor envíe datos antes de abandonar la solicitud, valor que se pasa a `httpx2.request`. force_download (`bool`, *opcional*, valor predeterminado `False`) : Si el archivo debe descargarse aunque ya exista en la caché local. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. local_files_only (`bool`, *opcional*, valor predeterminado `False`) : Si es `True`, evita descargar el archivo y devuelve la ruta al archivo en caché local si existe. allow_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, solo se descargan los archivos que coincidan con al menos un patrón. ignore_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, los archivos que coincidan con alguno de los patrones no se descargarán. max_workers (`int`, *opcional*) : Número de hilos concurrentes para descargar archivos (1 hilo = 1 descarga de archivo). El valor predeterminado es 8. tqdm_class (`tqdm`, *opcional*) : Si se proporciona, sobrescribe el comportamiento predeterminado de la barra de progreso. El argumento pasado debe heredar de `tqdm.auto.tqdm` o al menos imitar su comportamiento. Tenga en cuenta que `tqdm_class` no se pasa a cada descarga individual. El valor predeterminado es la barra de progreso personalizada de HF, que se puede desactivar estableciendo la variable de entorno `HF_HUB_DISABLE_PROGRESS_BARS`. dry_run (`bool`, *opcional*, valor predeterminado `False`) : Si `True`, realiza una ejecución de prueba sin descargar realmente los archivos. Devuelve una lista de objetos [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DryRunFileInfo) que contienen información sobre lo que se descargaría. **Devuelve:** `str` o lista de [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DryRunFileInfo) - Si `dry_run=False`: Ruta de la carpeta de la instantánea del repositorio. - Si `dry_run=True`: una lista de objetos [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.DryRunFileInfo) que contienen información de descarga. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) o ``EnvironmentError`` o ``OSError`` o ``ValueError`` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si no se puede encontrar la revisión desde la que se debe descargar. - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) -- Si `token=True` y no se puede encontrar el token. - [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -- si no se puede determinar el ETag. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- si el valor de algún parámetro no es válido. Descarga los archivos del repositorio. Descarga un instantáneo completo de los archivos de un repositorio en la revisión especificada. Esto es útil cuando se desean todos los archivos de un repositorio, ya que no se sabe a priori cuáles se necesitarán. Todos los archivos se anidan dentro de una carpeta para mantener su nombre de archivo real relativo a esa carpeta. También se puede filtrar qué archivos descargar usando `allow_patterns` y `ignore_patterns`. Si se proporciona `local_dir`, la estructura de archivos del repositorio se replicará en esta ubicación. Al usar esta opción, no se utilizará `cache_dir` y se creará una carpeta `.cache/huggingface/` en la raíz de `local_dir` para almacenar algunos metadatos relacionados con los archivos descargados. Aunque este mecanismo no es tan robusto como el sistema de caché principal, está optimizado para obtener regularmente la última versión de un repositorio. Una alternativa sería clonar el repositorio, pero esto requiere que git y git-lfs estén instalados y configurados correctamente. Además, no es posible filtrar qué archivos descargar al clonar un repositorio usando git. #### space_info[[huggingface_hub.HfApi.space_info]] ```python space_info(repo_id: str, revision: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: list[ExpandSpaceProperty_T] | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3359) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. revision (`str`, *opcional*) : La revisión del repositorio del espacio desde la que obtener la información. timeout (`float`, *opcional*) : Si se debe establecer un tiempo de espera para la solicitud al Hub. files_metadata (`bool`, *opcional*) : Si se deben recuperar o no los metadatos de los archivos del repositorio (tamaño, metadatos de LFS, etc.). El valor predeterminado es `False`. expand (`list[ExpandSpaceProperty_T]`, *opcional*) : Propiedades de la lista que se devolverán en la respuesta. Cuando se usa, solo se devolverán las propiedades de la lista. Este parámetro no se puede usar si se pasa `full`. Los valores posibles son `"author"`, `"cardData"`, `"createdAt"`, `"datasets"`, `"disabled"`, `"lastModified"`, `"likes"`, `"models"`, `"private"`, `"region"`, `"runtime"`, `"sdk"`, `"siblings"`, `"sha"`, `"subdomain"`, `"tags"`, `"trendingScore"`, `"usedStorage"` y `"resourceGroup"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [SpaceInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.SpaceInfo) La información del repositorio de Space. Obtén información sobre un Space específico en huggingface.co. El espacio puede ser privado si se pasa un token aceptable. > [!TIP] > Lanza los siguientes errores: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Si no se puede encontrar la revisión del que se va a descargar. #### super_squash_history[[huggingface_hub.HfApi.super_squash_history]] ```python super_squash_history(repo_id: str, branch: str | None = None, commit_message: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4346) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. branch (`str`, *opcional*) : La rama que se debe comprimir. Por defecto, es la cabecera de la rama `"main"`. commit_message (`str`, *opcional*) : El mensaje de commit que se usará para el commit comprimido. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si está listando commits de un dataset o un Space, `None` o `"model"` si está listando de un modelo. El valor predeterminado es `None`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) o [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si no se puede encontrar la rama que se debe comprimir. - [BadRequestError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Si la referencia de la rama no es válida. No se puede comprimir el historial en etiquetas. Comprimir el historial de commits en una rama de un repositorio en el Hub. Comprimir el historial del repositorio es útil cuando sabes que realizarás cientos de commits y no quieres saturar el historial. La compresión de commits solo puede realizarse desde la punta de una rama. > [!WARNING] > Una vez comprimidos, el historial de commits no puede recuperarse. Esta es una operación irreversible. > [!WARNING] > Una vez que el historial de una rama se ha comprimido, no es posible volver a fusionarla con otra rama, ya que sus historiales habrán divergido. Ejemplo: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() # Create repo >>> repo_id = api.create_repo("test-squash").repo_id # Make a lot of commits. >>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content") >>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content") >>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content") # Squash history >>> api.super_squash_history(repo_id=repo_id) ``` #### suspend_scheduled_job[[huggingface_hub.HfApi.suspend_scheduled_job]] ```python suspend_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13354) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. Suspend (pausa) un Job de cómputo programado en la infraestructura de Hugging Face. #### sync_bucket[[huggingface_hub.HfApi.sync_bucket]] ```python sync_bucket(source: str | None = None, dest: str | None = None, delete: bool = False, ignore_times: bool = False, ignore_sizes: bool = False, existing: bool = False, ignore_existing: bool = False, include: list[str] | None = None, exclude: list[str] | None = None, filter_from: str | None = None, plan: str | None = None, apply: str | None = None, dry_run: bool = False, verbose: bool = False, quiet: bool = False, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15207) **Parámetros:** source (*str*, *opcional*) : Ruta de origen: directorio local o `hf://buckets/namespace/bucket_name(/prefix)`. Obligatorio a menos que se use `apply`. dest (*str*, *opcional*) : Ruta de destino: directorio local o `hf://buckets/namespace/bucket_name(/prefix)`. Obligatorio a menos que se use `apply`. delete (*bool*, *opcional*, valor predeterminado *False*) : Elimina los archivos de destino que no están presentes en el origen. ignore_times (*bool*, *opcional*, valor predeterminado *False*) : Omitir archivos solo en función de su tamaño, ignorando las fechas de modificación. ignore_sizes (*bool*, *opcional*, valor predeterminado *False*) : Omitir archivos solo en función de las horas de modificación, ignorando los tamaños. existing (*bool*, *opcional*, valor predeterminado *False*) : Omitir la creación de nuevos archivos en el receptor (solo actualizar archivos existentes). ignore_existing (*bool*, *opcional*, valor predeterminado *False*) : Omitir la actualización de archivos que ya existen en el receptor (solo crear archivos nuevos). include (*list[str]*, *opcional*) : Incluye archivos que coincidan con los patrones (estilo fnmatch). exclude (*list[str]*, *opcional*) : Excluye archivos que coincidan con los patrones (estilo fnmatch). filter_from (*str*, *opcional*) : Ruta a un archivo de filtro con reglas de inclusión/exclusión. plan (*str*, *opcional*) : Guarda el plan de sincronización en este archivo JSONL en lugar de ejecutarlo. apply (*str*, *opcional*) : Aplica un archivo de plan guardado previamente. Cuando se establece, `source` y `dest` no son necesarios. dry_run (*bool*, *opcional*, por defecto *False*) : Imprime el plan de sincronización en stdout como JSONL sin ejecutarlo. verbose (*bool*, *opcional*, por defecto *False*) : Muestra operaciones detalladas por archivo. quiet (*bool*, *opcional*, por defecto *False*) : Suprime toda la salida y las barras de progreso. token (Union[bool, str, None], opcional) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente. **Devuelve:** [*SyncPlan*] El plan de sincronización calculado (o cargado). Sincronizar archivos entre un directorio local y un bucket. Esto es equivalente al comando de CLI `hf buckets sync`. Uno de `source` o `dest` debe ser una ruta de bucket (`hf://buckets/...`) y el otro debe ser una ruta de directorio local. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # Upload local directory to bucket >>> api.sync_bucket("./data", "hf://buckets/username/my-bucket") # Download bucket to local directory >>> api.sync_bucket("hf://buckets/username/my-bucket", "./data") # Sync with delete and filtering >>> api.sync_bucket( ... "./data", ... "hf://buckets/username/my-bucket", ... delete=True, ... include=["*.safetensors"], ... ) # Dry run: preview what would be synced >>> plan = api.sync_bucket("./data", "hf://buckets/username/my-bucket", dry_run=True) >>> plan.summary() &lcub;'uploads': 3, 'downloads': 0, 'deletes': 0, 'skips': 1, 'total_size': 4096} # Save plan for review, then apply >>> api.sync_bucket("./data", "hf://buckets/username/my-bucket", plan="sync-plan.jsonl") >>> api.sync_bucket(apply="sync-plan.jsonl") ``` #### sync_job_volume[[huggingface_hub.HfApi.sync_job_volume]] ```python sync_job_volume(source: str | Path, mount_path: str, remote_name: str | None = None, read_only: bool = True, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13857) **Parámetros:** source (`str` o `Path`) : Ruta a un directorio local para sincronizar. mount_path (`str`) : Ruta de montaje dentro del contenedor del Job, p. ej. `"/inputs"`. Debe comenzar con `/`. remote_name (`str`, *opcional*) : Nombre de la subcarpeta del bucket a la que se sincronizará. Por defecto, se usa un nombre `{dirname}-{hash}` derivado de la ruta de origen y el nombre del equipo. read_only (`bool`, *opcional*, valor predeterminado `True`) : Monta el volumen en solo lectura en el Job. Pasa `False` para permitir que el Job escriba de vuelta en la carpeta del bucket (p. ej., para recuperar las salidas con [sync_bucket()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket) después). namespace (`str`, *opcional*) : El espacio de nombres que posee el bucket `jobs-artifacts`. Por defecto, es el espacio de nombres del usuario actual. Utilice el mismo espacio de nombres que el Job que montará el volumen. token (`Union[bool, str, None]`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) Un volumen de bucket limitado al subcarpeta sincronizada, para pasar en la lista `volumes` de [run_job()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.run_job), [run_uv_job()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.run_uv_job), [create_scheduled_job()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_scheduled_job) o [create_scheduled_uv_job()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_scheduled_uv_job). Sincronice un directorio local con un bucket y devuelva un [Volume](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.Volume) listo para montar en un Job. Los archivos se suben a una subcarpeta del bucket `{namespace}/jobs-artifacts` (creado automáticamente como privado; se emite una advertencia si ya existe y es público) utilizando la misma lógica de sincronización que [sync_bucket()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket): volver a sincronizar el mismo directorio solo sube archivos nuevos o modificados. De forma predeterminada, el nombre de la subcarpeta se deriva de la ruta del directorio y del nombre del host de la máquina, por lo que las llamadas repetidas desde el mismo directorio reutilizan la misma carpeta remota. Pasa `remote_name` para usar un nombre fijo en su lugar. Tenga en cuenta que los datos se *copian* al bucket, no se montan en vivo: los cambios realizados localmente después de la sincronización no son visibles para el Job (ejecute de nuevo `sync_job_volume` para actualizarlos) y el volumen se monta de solo lectura de forma predeterminada. Para recuperar los datos escritos por un Job en un volumen de lectura y escritura, sincronice la carpeta del bucket de vuelta con [sync_bucket()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket). Si el directorio de origen está vacío (por ejemplo, un directorio de salida), se sube un archivo `.keep` como marcador para que el volumen aún pueda montarse. Ejemplo: ```python >>> from huggingface_hub import run_uv_job, sync_job_volume # Upload ./training-data once, then run multiple jobs against it >>> volume = sync_job_volume("./training-data", "/data") >>> run_uv_job("train.py", script_args=["--learning-rate", "0.01"], volumes=[volume]) >>> run_uv_job("train.py", script_args=["--learning-rate", "0.05"], volumes=[volume]) # Read-write volume to retrieve outputs after the job completes >>> volume = sync_job_volume("./outputs", "/outputs", read_only=False) >>> job = run_uv_job("process.py", volumes=[volume]) ``` #### trigger_scheduled_job[[huggingface_hub.HfApi.trigger_scheduled_job]] ```python trigger_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13466) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) Información sobre la ejecución activada. **Excepciones:** [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- HTTP 409 si ya hay otra instancia en ejecución y `concurrency` está deshabilitado en el trabajo programado. Disparar un Job programado para que se ejecute de inmediato. Esto provoca una ejecución inmediata de la especificación del trabajo programado. No **modifica** el horario y no **afecta** a la próxima ejecución programada. Si ya hay una instancia en ejecución y el trabajo programado no permite ejecuciones concurrentes, la solicitud se rechaza (HTTP 409). #### a diferencia de[[huggingface_hub.HfApi.unlike]] ```python unlike(repo_id: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2937) **Parámetros:** repo_id (`str`) : El repositorio al que se le quitará el "me gusta". Ejemplo: `"user/my-cool-model"`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"` o `"space"` si se quita el me gusta a un dataset o space, `None` o `"model"` si se quita el me gusta a un modelo. El valor predeterminado es `None`. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. A diferencia de un repositorio dado en el Hub (p. ej. eliminar de la lista de favoritos). Para evitar el uso con fines de spam, no es posible `like` un repositorio desde un script. Véase también [list_liked_repos()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_liked_repos). Ejemplo: ```python >>> from huggingface_hub import list_liked_repos, unlike >>> "gpt2" in list_liked_repos().models # we assume you have already liked gpt2 True >>> unlike("gpt2") >>> "gpt2" in list_liked_repos().models False ``` #### update_bucket_settings[[huggingface_hub.HfApi.update_bucket_settings]] ```python update_bucket_settings(bucket_id: str, private: bool, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14256) **Parámetros:** bucket_id (`str`) : El ID del bucket (p. ej. `"username/my-bucket"`). private (`bool`) : Si se debe hacer el bucket privado. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Excepciones:** `BucketNotFoundError` o ``or`` - `BucketNotFoundError` -- Si no se puede encontrar el bucket. Esto puede deberse a que no existe, - ``or`` -- porque está configurado como `private` y no tienes acceso. Actualice la configuración de un bucket en el Hub. Actualmente, la única configuración admitida es la visibilidad del bucket. Ejemplo: ```python >>> from huggingface_hub import update_bucket_settings >>> # Make a bucket public >>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=False) >>> # Make it private again >>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=True) ``` #### update_collection_item[[huggingface_hub.HfApi.update_collection_item]] ```python update_collection_item(collection_slug: str, item_object_id: str, note: str | None = None, position: int | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10495) **Parámetros:** collection_slug (`str`) : Slug de la colección a actualizar. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_object_id (`str`) : ID del elemento en la colección. Este no es el id del elemento en el Hub (repo_id o paper id). Debe obtenerse de un objeto [CollectionItem](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.CollectionItem). Ejemplo: `collection.items[0].item_object_id`. note (`str`, *opcional*) : Una nota para adjuntar al elemento en la colección. El tamaño máximo de una nota es de 500 caracteres. position (`int`, *opcional*) : Nueva posición del elemento en la colección. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Actualizar un elemento en una colección. Ejemplo: ```py >>> from huggingface_hub import get_collection, update_collection_item # Get collection first >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") # Update item based on its ID (add note + update position) >>> update_collection_item( ... collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026", ... item_object_id=collection.items[-1].item_object_id, ... note="Newly updated model!", ... position=0, ... ) ``` #### update_collection_metadata[[huggingface_hub.HfApi.update_collection_metadata]] ```python update_collection_metadata(collection_slug: str, title: str | None = None, description: str | None = None, position: int | None = None, private: bool | None = None, theme: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10265) **Parámetros:** collection_slug (`str`) : Slug de la colección a actualizar. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. title (`str`) : Título de la colección a actualizar. description (`str`, *opcional*) : Descripción de la colección a actualizar. El tamaño máximo para una descripción es de 150 caracteres. position (`int`, *opcional*) : Nueva posición de la colección en la lista de colecciones del usuario. private (`bool`, *opcional*) : Si la colección debe ser privada o no. theme (`str`, *opcional*) : Tema de la colección en el Hub. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Actualizar los metadatos de una colección en el Hub. Todos los argumentos son opcionales. Solo se actualizarán los metadatos proporcionados. Devuelve: [Collection](/docs/huggingface_hub/v2.4.0/es/package_reference/collections#huggingface_hub.Collection) Ejemplo: ```py >>> from huggingface_hub import update_collection_metadata >>> collection = update_collection_metadata( ... collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026", ... title="ICCV Oct. 2023", ... description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023", ... private=False, ... theme="pink", ... ) >>> collection.slug "username/iccv-oct-2023-64f9a55bb3115b4f513ec026" # ^collection slug got updated but not the trailing ID ``` #### update_collection_resource_group[[huggingface_hub.HfApi.update_collection_resource_group]] ```python update_collection_resource_group(collection_slug: str, resource_group_id: str | None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10333) **Parámetros:** collection_slug (`str`) : Slug de la colección a actualizar. Ejemplo: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. resource_group_id (`str` o `None`) : El grupo de recursos al que se asignará la colección, como una cadena hexadecimal de 24 caracteres. Si es `None`, la colección se elimina de cualquier grupo de recursos. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. Asigne una colección a un grupo de recursos o elimínela de cualquier grupo de recursos. Válido solo para colecciones de propiedad de la organización. Ejemplo: ```py >>> from huggingface_hub import update_collection_resource_group >>> update_collection_resource_group( ... collection_slug="my-org/iccv-2023-64f9a55bb3115b4f513ec026", ... resource_group_id="66980ecfc1e12a49c8f0e42d", ... ) ``` #### update_inference_endpoint[[huggingface_hub.HfApi.update_inference_endpoint]] ```python update_inference_endpoint(name: str, accelerator: str | None = None, instance_size: str | None = None, instance_type: str | None = None, min_replica: int | None = None, max_replica: int | None = None, scale_to_zero_timeout: int | None = None, scaling_metric: InferenceEndpointScalingMetric | None = None, scaling_threshold: float | None = None, repository: str | None = None, framework: str | None = None, revision: str | None = None, task: str | None = None, custom_image: dict | None = None, container_command: list[str] | None = None, container_args: list[str] | None = None, tensor_parallel_size: int | None = None, data_parallel_size: int | None = None, env: dict[str, str] | None = None, secrets: dict[str, str] | None = None, domain: str | None = None, path: str | None = None, cache_http_responses: bool | None = None, tags: list[str] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9706) **Parámetros:** name (`str`) : El nombre del Inference Endpoint que se va a actualizar. accelerator (`str`, *opcional*) : El acelerador de hardware que se utilizará para la inferencia (p. ej. `"cpu"`). instance_size (`str`, *opcional*) : El tamaño o tipo de la instancia que se utilizará para alojar el modelo (p. ej., `"x4"`). instance_type (`str`, *opcional*) : El tipo de instancia en la nube donde se desplegará el Inference Endpoint (p. ej. `"intel-icl"`). min_replica (`int`, *opcional*) : El número mínimo de réplicas (instancias) que deben mantenerse en ejecución para el Inference Endpoint. max_replica (`int`, *opcional*) : El número máximo de réplicas (instancias) al que escalar el Inference Endpoint. scale_to_zero_timeout (`int`, *opcional*) : La duración en minutos antes de que un punto de acceso inactivo se escale a cero. scaling_metric (`str` o `InferenceEndpointScalingMetric `, *opcional*) : La referencia de la métrica para el escalado. Puede ser "pendingRequests" o "hardwareUsage" cuando se proporciona. El valor predeterminado es None. scaling_threshold (`float`, *opcional*) : Umbral de la métrica de escalado utilizado para activar un aumento de escala. Se ignora cuando no se proporciona la métrica de escalado. El valor predeterminado es None. repository (`str`, *opcional*) : El nombre del repositorio de modelos asociado con el Inference Endpoint (p. ej. `"gpt2"`). framework (`str`, *opcional*) : El marco de aprendizaje automático utilizado para el modelo (p. ej. `"custom"`). revision (`str`, *opcional*) : La revisión específica del modelo que se desplegará en el Inference Endpoint (p. ej. `"6c0e6080953db56375760c0471a8c5f2929baf11"`). task (`str`, *opcional*) : La tarea en la que se desplegará el modelo (p. ej. `"text-classification"`). custom_image (`dict`, *opcional*) : La imagen de contenedor que se va a ejecutar. Puede ser un diccionario con claves por variante de imagen (p. ej. `{"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}}`, también `sGLang`, `tgi`, `tei`, `llamacpp`, `hfServe`, ...), que se reenvía tal cual, o un diccionario plano que describe un contenedor personalizado (p. ej. `{"url": ..., "port": ...}`), que se envía como `{"custom": ...}`. container_command (`list[str]`, *opcional*) : Anula el comando de punto de entrada del contenedor (se corresponde con `model.command` en la carga de la API). Funciona tanto con imágenes de motor administradas (p. ej., vLLM, SGLang) como con imágenes personalizadas. container_args (`list[str]`, *opcional*) : Argumentos añadidos al punto de entrada del contenedor (corresponde a `model.args` en la carga de la API). Funciona tanto con imágenes de motor administradas (p. ej., vLLM, SGLang) como con imágenes personalizadas. tensor_parallel_size (`int`, *opcional*) : Número de aceleradores en los que dividir una copia única del modelo (imágenes de vLLM y SGLang). Se escribe dentro de la configuración de la imagen del motor. La API requiere `model.image` como un todo, por lo que, cuando no se proporciona `custom_image`, se recupera la imagen configurada actualmente en el punto de acceso y se actualiza en su lugar. data_parallel_size (`int`, *opcional*) : Número de copias del modelo a ejecutar, una por acelerador (imágenes de vLLM). Mismo manejo que `tensor_parallel_size`. env (`dict[str, str]`, *opcional*) : Variables de entorno no secretas para inyectar en el entorno del contenedor secrets (`dict[str, str]`, *opcional*) : Valores secretos para inyectar en el entorno del contenedor. domain (`str`, *opcional*) : El dominio personalizado para la implementación del Inference Endpoint; si se configura, el punto de inferencia estará disponible en este dominio (p. ej., `"my-new-domain.cool-website.woof"`). path (`str`, *opcional*) : La ruta personalizada del modelo desplegado, debe comenzar con `/` (p. ej. `"/models/google-bert/bert-base-uncased"`). cache_http_responses (`bool`, *opcional*) : Si se deben cachear las respuestas HTTP del Inference Endpoint. tags (`list[str]`, *opcional*) : Una lista de etiquetas para asociar con el Inference Endpoint. namespace (`str`, *opcional*) : El espacio de nombres donde se actualizará el Inference Endpoint. Por defecto, se utiliza el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) información sobre el Inference Endpoint actualizado. Actualizar un punto de inferencia. Este método permite actualizar la configuración de cómputo, el modelo desplegado, la ruta o cualquier combinación de estos. Todos los argumentos son opcionales, pero se debe proporcionar al menos uno. Por comodidad, también puede actualizar un Inference Endpoint usando [InferenceEndpoint.update()](/docs/huggingface_hub/v2.4.0/es/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.update). #### update_job_expose[[huggingface_hub.HfApi.update_job_expose]] ```python update_job_expose(job_id: str, expose: list[int] | None = None, expose_public: list[int] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12787) **Parámetros:** job_id (`str`) : ID del Job en ejecución. expose (`list[int]`, *opcional*) : Puertos para exponer a través del proxy de Jobs. El acceso requiere un token de HF con permiso de lectura en el espacio de nombres del Job. expose_public (`list[int]`, *opcional*) : Puertos para exponer a través del proxy de Jobs sin autenticación. No es necesario que estén listados en `expose`. namespace (`str`, *opcional*) : Espacio de nombres del trabajo. El valor predeterminado es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Token de acceso del usuario. Por defecto, se utiliza el token guardado localmente. **Devuelve:** [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) El trabajo actualizado. Reemplaza los puertos expuestos de un Job en ejecución sin volver a ejecutarlo. `expose` y `expose_public` forman juntos la configuración completa de puertos: los puertos que no están en ninguna de las dos listas quedan cerrados. No pases ninguno de los dos para cerrar todos los puertos expuestos. #### update_job_labels[[huggingface_hub.HfApi.update_job_labels]] ```python update_job_labels(job_id: str, labels: dict[str, str], namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12828) **Parámetros:** job_id (`str`) : ID del trabajo. labels (`dict[str, str]`) : Nuevas etiquetas para establecer en el trabajo. Reemplaza todas las etiquetas existentes. Tanto las claves como los valores deben tener un máximo de 100 caracteres y contener solo caracteres alfanuméricos, guiones y guiones bajos. namespace (`str`, *opcional*) : El espacio de nombres donde se está ejecutando el Job. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) La información actualizada del trabajo. Actualizar las etiquetas de un Job existente. Reemplaza todas las etiquetas proporcionadas por el usuario existentes con las nuevas etiquetas. #### update_repo_settings[[huggingface_hub.HfApi.update_repo_settings]] ```python update_repo_settings(repo_id: str, gated: Literal['auto', 'manual', False] | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, token: str | bool | None = None, repo_type: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4838) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una /. gated (`Literal["auto", "manual", False]`, *opcional*) : El estado de acceso restringido del repositorio. Si se establece en `None` (predeterminado), la configuración `gated` del repositorio no se actualizará. * "auto": El repositorio tiene acceso restringido y las solicitudes de acceso se aprueban o deniegan automáticamente según criterios predefinidos. * "manual": El repositorio tiene acceso restringido y las solicitudes de acceso requieren aprobación manual. * False : El repositorio no tiene acceso restringido y cualquier persona puede acceder a él. private (`bool`, *opcional*) : Si el repositorio debe ser privado. No se puede pasar junto con `visibility`. visibility (`Literal["public", "private", "protected"]`, *opcional*) : Visibilidad del repositorio. Puede ser `"public"` o `"private"`, o `"protected"` para Spaces. token (`Union[str, bool, None]`, *opcional*) : Un token de acceso de usuario válido (cadena). El valor predeterminado es el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase False. repo_type (`str`, *opcional*) : El tipo de repositorio del que se actualizarán los ajustes (`"model"`, `"dataset"` o `"space"`). El valor predeterminado es `"model"`. **Excepciones:** ``ValueError`` o [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) o [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si gated no es "auto", "manual" o False. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si repo_type no es uno de los valores de constants.REPO_TYPES. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Si la solicitud a la API de Hugging Face Hub falla. - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. Actualice la configuración de un repositorio, incluido el acceso restringido y la visibilidad. Para ofrecer un mayor control sobre el uso de los repositorios, el Hub permite a los autores habilitar solicitudes de acceso a sus repositorios y también cambiar la visibilidad del repositorio. #### update_scheduled_job_labels[[huggingface_hub.HfApi.update_scheduled_job_labels]] ```python update_scheduled_job_labels(scheduled_job_id: str, labels: dict[str, str], namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13508) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. labels (`dict[str, str]`) : Nuevas etiquetas para establecer en el trabajo programado. Reemplaza todas las etiquetas existentes. Tanto las claves como los valores deben tener un máximo de 100 caracteres y contener solo caracteres alfanuméricos, guiones y guiones bajos. namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** `ScheduledJobInfo` La información actualizada del trabajo programado. Actualice las etiquetas de un Job programado existente. Reemplaza todas las etiquetas proporcionadas por el usuario existentes con las nuevas etiquetas. #### update_scheduled_job_schedule[[huggingface_hub.HfApi.update_scheduled_job_schedule]] ```python update_scheduled_job_schedule(scheduled_job_id: str, schedule: str, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13414) **Parámetros:** scheduled_job_id (`str`) : ID del Job programado. schedule (`str`) : Uno de "@annually", "@yearly", "@monthly", "@weekly", "@daily", "@hourly", o una expresión de programación CRON (p. ej., '0 9 * * 1' para las 9:00 AM cada lunes). namespace (`str`, *opcional*) : El espacio de nombres donde se encuentra el Job programado. Por defecto, es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** `ScheduledJobInfo` La información actualizada del trabajo programado. Cambiar cuándo se ejecuta un Job programado existente. Solo se actualiza el programa: se conservan la especificación del Job, las etiquetas y el estado de suspensión. Para ejecutar el Job programado una vez ahora mismo sin cambiar su programa, usa [trigger_scheduled_job()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.trigger_scheduled_job) en su lugar. Ejemplo: ```python >>> from huggingface_hub import update_scheduled_job_schedule >>> scheduled_job = update_scheduled_job_schedule(scheduled_job_id="6abb8dc9c617607c354d45f4", schedule="@daily") >>> scheduled_job.schedule '@daily' ``` #### update_webhook[[huggingface_hub.HfApi.update_webhook]] ```python update_webhook(webhook_id: str, url: str | None = None, job_id: str | None = None, watched: list[dict | WebhookWatchedItem] | None = None, domains: list[constants.WEBHOOK_DOMAIN_T] | None = None, secret: str | None = None, secrets: dict[str, str] | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11319) **Parámetros:** webhook_id (`str`) : El identificador único del webhook que se actualizará. url (`str`, opcional) : La URL a la que se enviará la carga. job_id (`str`, opcional) : ID del Job de origen que se activará con la carga del webhook. Obligatorio al configurar `secrets`. watched (`list[WebhookWatchedItem]`, opcional) : Lista de elementos a vigilar. Pueden ser usuarios, organizaciones, modelos, conjuntos de datos o espacios. Consulte [WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookWatchedItem) para más detalles. Los elementos vigilados también pueden proporcionarse como diccionarios simples. domains (`list[Literal["repo", "discussion"]]`, opcional) : Los dominios a vigilar. Esto puede incluir "repo", "discussion" o ambos. secret (`str`, opcional) : Un secreto para firmar la carga útil, proporcionando una capa adicional de seguridad. secrets (`dict[str, str]`, opcional) : Variables de entorno secretas para el Job activado por el webhook. Las claves enumeradas reemplazan el valor almacenado, una cadena vacía elimina ese secreto y las claves omitidas conservan su valor almacenado. Requiere `job_id`. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookInfo) Información sobre el webhook actualizado. Actualizar un webhook existente. Ejemplo: ```python >>> from huggingface_hub import update_webhook >>> updated_payload = update_webhook( ... webhook_id="654bbbc16f2ec14d77f109cc", ... url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", ... watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}], ... domains=["repo"], ... secret="my-secret", ... ) >>> print(updated_payload) WebhookInfo( id="654bbbc16f2ec14d77f109cc", job=None, url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], domains=["repo"], secret="my-secret", disabled=False, ``` #### upload_attachment[[huggingface_hub.HfApi.upload_attachment]] ```python upload_attachment(path: str | Path, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8000) **Parámetros:** path (`str` o `Path`) : Ruta al archivo que se va a subir. Los formatos admitidos son PNG, JPEG, GIF, WebP, MP4, MOV, WebM, MP3 y WAV. Los archivos deben ser menores de 10 MB (50 MB para videos). token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena de caracteres). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). El token necesita el permiso `discussion.write`. Para subir de forma anónima, pase `False`. **Devuelve:** `str` la URL del archivo subido. **Excepciones:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si el formato del archivo no es compatible. Sube un archivo de imagen, video o audio al Hub y devuelve su URL. Esto es lo que hace el editor web de Hub cuando arrastras un archivo a un cuadro de comentarios de una Discusión o una Pull Request. Incrusta la URL devuelta en una descripción o un comentario: `![alt text](url)` para una imagen, la URL sin formato para un video y `` para un archivo de audio. Ejemplo: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> url = api.upload_attachment("screenshot.png") >>> api.create_discussion("username/my-model", title="Rendering bug", description=f"![screenshot]({url})") ``` #### upload_file[[huggingface_hub.HfApi.upload_file]] ```python upload_file(path_or_fileobj: str | Path | bytes | BinaryIO, path_in_repo: str, repo_id: str, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None, run_as_future: bool = False, _hot_reload: bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5621) **Parámetros:** path_or_fileobj (`str`, `Path`, `bytes` o `IO`) : Ruta a un archivo en la máquina local o flujo de datos binarios / fileobj / buffer. path_in_repo (`str`) : Ruta de archivo relativa en el repositorio, por ejemplo: `"checkpoints/1fec34a/weights.bin"` repo_id (`str`) : El repositorio al que se subirá el archivo, por ejemplo: `"username/custom_transformers"` token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"`, `"space"` o `"kernel"` si se sube a un repositorio de dataset, space o kernel, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. commit_message (`str`, *opcional*) : El resumen / título / primera línea del commit generado commit_description (`str`, *opcional*) : La descripción del commit generado create_pr (`boolean`, *opcional*) : Si se debe o no crear una Pull Request con ese commit. El valor predeterminado es `False`. Si `revision` no está establecido, la PR se abre contra la rama `"main"`. Si `revision` está establecido y es una rama, la PR se abre contra esta rama. Si `revision` está establecido y no es el nombre de una rama (por ejemplo, un oid de commit), el servidor devuelve un `RevisionNotFoundError`. parent_commit (`str`, *opcional*) : El OID / SHA del commit padre, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). Si se especifica y `create_pr` es `False`, el commit fallará si `revision` no apunta a `parent_commit`. Si se especifica y `create_pr` es `True`, la pull request se creará desde `parent_commit`. Especificar `parent_commit` garantiza que el repositorio no haya cambiado antes de confirmar los cambios, y puede ser especialmente útil si el repositorio se actualiza / confirma de forma concurrente. run_as_future (`bool`, *opcional*) : Indica si se debe ejecutar este método en segundo plano. Las tareas en segundo plano se ejecutan de forma secuencial sin bloquear el hilo principal. Si se pasa `run_as_future=True`, se devolverá un objeto [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects). El valor predeterminado es `False`. **Devuelve:** [CommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitInfo) o `Future` Instancia de [CommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitInfo) que contiene información sobre el commit recién creado (hash del commit, url del commit, url del pr, mensaje del commit, ...). Si se pasa `run_as_future=True`, devuelve un objeto Future que contendrá el resultado cuando se ejecute. Sube un archivo local (de hasta 50 GB) al repositorio indicado. La carga se realiza mediante una solicitud HTTP post y no requiere que git o git-lfs estén instalados. > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe o a que está configurado como `private` y no tienes acceso. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Si no se puede encontrar la revisión del que se va a descargar. > [!WARNING] > `upload_file` asume que el repositorio ya existe en el Hub. Si obtienes un error de cliente 404, asegúrate de que estás autenticado, de que tu token tiene los permisos necesarios y de que `repo_id` y `repo_type` están configurados correctamente. Si el repositorio no existe, créalo primero usando [create_repo()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_repo). Ejemplo: ```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", ... ) >>> upload_file( ... path_or_fileobj=".\\local\\file\\path", ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-model", ... token="my_token", ... ) >>> 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, ... ) ``` #### upload_folder[[huggingface_hub.HfApi.upload_folder]] ```python upload_folder(repo_id: str, folder_path: str | Path, path_in_repo: str | None = None, commit_message: str | None = None, commit_description: str | None = None, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, delete_patterns: list[str] | str | None = None, run_as_future: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5808) **Parámetros:** repo_id (`str`) : El repositorio al que se subirá el archivo, por ejemplo: `"username/custom_transformers"` folder_path (`str` o `Path`) : Ruta de la carpeta a subir en el sistema de archivos local path_in_repo (`str`, *opcional*) : Ruta relativa del directorio en el repositorio, por ejemplo: `"checkpoints/1fec34a/results"`. Por defecto, se utilizará la carpeta raíz del repositorio. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. repo_type (`str`, *opcional*) : Establezca `"dataset"`, `"space"` o `"kernel"` si se sube a un repositorio de dataset, space o kernel, `None` o `"model"` si se sube a un modelo. El valor predeterminado es `None`. revision (`str`, *opcional*) : La revisión de git desde la que se realizará el commit. Por defecto, es la cabecera de la rama `"main"`. commit_message (`str`, *opcional*) : El resumen / título / primera línea del commit generado. Valor predeterminado: `f"Upload {path_in_repo} with huggingface_hub"` commit_description (`str` *opcional*) : La descripción del commit generado create_pr (`boolean`, *opcional*) : Si se crea o no una Pull Request con ese commit. El valor predeterminado es `False`. La PR siempre se abre contra la rama predeterminada: establecer tanto `create_pr=True` como `revision` provoca un `ValueError`. Tenga en cuenta que cada llamada con `create_pr=True` abre una nueva pull request: para reanudar una carga interrumpida en la PR existente, vuelva a ejecutar con `revision="refs/pr/N"` en su lugar. parent_commit (`str`, *opcional*) : El OID / SHA del commit padre, como una cadena hexadecimal. También se admiten abreviaturas (los 7 primeros caracteres). Si se especifica y `create_pr` es `False`, el commit fallará si `revision` no apunta a `parent_commit`. Especificar `parent_commit` garantiza que el repositorio no haya cambiado antes de confirmar los cambios, y puede ser especialmente útil si el repositorio se actualiza / confirma de forma concurrente. Si la carga se divide en varios commits (carpetas grandes), `parent_commit` solo se aplica al primero. allow_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, solo se suben los archivos que coincidan con al menos un patrón. ignore_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, los archivos que coincidan con alguno de los patrones no se subirán. delete_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, los archivos remotos que coincidan con cualquiera de los patrones se eliminarán del repositorio al confirmar los nuevos archivos. Esto es útil si no sabe qué archivos ya se han subido. Nota: para evitar discrepancias, el archivo `.gitattributes` no se elimina aunque coincida con el patrón. run_as_future (`bool`, *opcional*) : Indica si se debe ejecutar este método en segundo plano. Las tareas en segundo plano se ejecutan de forma secuencial sin bloquear el hilo principal. Si se pasa `run_as_future=True`, se devolverá un objeto [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects). El valor predeterminado es `False`. **Devuelve:** [CommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitInfo) o `Future` Instancia de [CommitInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitInfo) que contiene información sobre el commit recién creado (hash del commit, url del commit, url del pr, mensaje del commit, ...). Si se pasa `run_as_future=True`, devuelve un objeto Future que contendrá el resultado cuando se ejecute. Sube una carpeta local al repositorio indicado. La carga se realiza mediante solicitudes HTTP y no requiere que git o git-lfs estén instalados. La estructura de la carpeta se conservará. Los archivos con el mismo nombre que ya estén presentes en el repositorio se sobrescribirán. Los demás se dejarán intactos. Use los argumentos `allow_patterns` y `ignore_patterns` para especificar qué archivos se deben subir. Estos parámetros aceptan un solo patrón o una lista de patrones. Los patrones son comodines estándar (patrones de globbing) tal como se documenta [aquí](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). Si se proporcionan tanto `allow_patterns` como `ignore_patterns`, se aplican ambas restricciones. De forma predeterminada, se suben todos los archivos de la carpeta. Use el argumento `delete_patterns` para especificar los archivos remotos que desea eliminar. El tipo de entrada es el mismo que para `allow_patterns` (véase arriba). Si también se proporciona `path_in_repo`, los patrones se comparan con las rutas relativas a esta carpeta. Por ejemplo, `upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*")` eliminará cualquier archivo remoto bajo `./experiment/logs/`. Tenga en cuenta que el archivo `.gitattributes` no se eliminará, incluso si coincide con los patrones. Cualquier carpeta `.git/` presente en cualquier subdirectorio se ignorará. Sin embargo, tenga en cuenta que el archivo `.gitignore` no se tiene en cuenta. Cuando `hf_xet` está instalado (el valor predeterminado), los archivos se suben a través de una canalización en streaming: las subidas comienzan mientras la carpeta aún se está verificando contra el Hub, los archivos se calculan su hash mientras se dividen en fragmentos para la subida (una sola pasada de lectura) y las carpetas grandes se commiten automáticamente en varios lotes para permanecer por debajo de los límites del servidor (los commits de seguimiento reciben un sufijo ` (part N)` en el mensaje del commit). Si la subida se interrumpe, volver a ejecutar la misma llamada la reanuda: los archivos ya commitados se omiten y los datos ya subidos se deduplican. Cuando `hf_xet` no está instalado, se recurre a un solo commit creado con [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit). > [!TIP] > Lanza los siguientes errores: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) si la API de HuggingFace devolvió un error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) si el valor de algún parámetro no es válido > [!WARNING] > `upload_folder` asume que el repositorio ya existe en el Hub. Si obtienes un error de cliente 404, asegúrate de que estás autenticado, de que tu token tiene los permisos necesarios y de que `repo_id` y `repo_type` están configurados correctamente. Si el repositorio no existe, créalo primero usando [create_repo()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_repo). Ejemplo: ```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", ... ) # 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", ... ) # 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, ... ) ``` #### verify_repo_checksums[[huggingface_hub.HfApi.verify_repo_checksums]] ```python verify_repo_checksums(repo_id: str, repo_type: str | None = None, revision: str | None = None, local_dir: str | Path | None = None, cache_dir: str | Path | None = None, token: str | bool | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4035) **Parámetros:** repo_id (`str`) : Un espacio de nombres (usuario u organización) y un nombre de repositorio separados por una `/`. repo_type (`str`, *opcional*) : El tipo de repositorio del que se obtiene el árbol (`"model"`, `"dataset"` o `"space"`. Por defecto, `"model"`. revision (`str`, *opcional*) : La revisión del repositorio desde la que se obtiene el árbol. El valor predeterminado es la rama `"main"`. local_dir (`str` o `Path`, *opcional*) : El directorio local a verificar. cache_dir (`str` o `Path`, *opcional*) : El directorio de caché a verificar. token (Union[bool, str, None], opcional) : Un token de acceso de usuario válido (cadena). El valor predeterminado es el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. **Devuelve:** `FolderVerification` un resultado estructurado que contiene los detalles de la verificación. **Excepciones:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) o [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Si no se encuentra el repositorio (error 404): repo_id/repo_type incorrectos, privado pero sin autenticación o el repositorio no existe. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/es/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Si la revisión no se encuentra (error 404) en el repositorio. Verifique los archivos locales de un repositorio en contra de las sumas de verificación del Hub. #### wait_for_job[[huggingface_hub.HfApi.wait_for_job]] ```python wait_for_job(job_id: str | list[str], timeout: float | None = None, poll_interval: float = 1.0, stages: list[JobStage] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12638) **Parámetros:** job_id (`str` o `list[str]`) : ID del trabajo, o una lista de IDs de trabajos para esperar. Si se pasa una lista, se devuelve una lista de [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) (en el mismo orden). timeout (`float`, *opcional*) : El tiempo máximo de espera para que el/los Job finalice(n), en segundos. Si es `None`, esperará indefinidamente. poll_interval (`float`, *opcional*) : El tiempo de espera entre cada comprobación de estado, en segundos. El valor predeterminado es 1 s. stages (`list[JobStage]`, *opcional*) : Las etapas para las que esperar. Por defecto, son las etapas terminales (`"COMPLETED"`, `"CANCELED"`, `"ERROR"`, `"DELETED"`). Pasa, por ejemplo, `[JobStage.RUNNING]` para esperar a que el Job comience a ejecutarse. Las etapas terminales siempre detienen la espera, independientemente de este valor. namespace (`str`, *opcional*) : El espacio de nombres donde se están ejecutando los Job(s). El valor predeterminado es el espacio de nombres del usuario actual. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Si no se proporciona, se utilizará el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte: https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) o `list[JobInfo]` la información final del Job. **Excepciones:** ``TimeoutError`` - ``TimeoutError`` -- Si al menos un Job no ha alcanzado una de las etapas objetivo después de `timeout` segundos. Espera hasta que uno o más Jobs de cómputo en la infraestructura de Hugging Face alcancen una etapa determinada. Cada estado de Job se consulta (con [inspect_job()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.inspect_job)) cada `poll_interval` segundos hasta que su etapa sea una de `stages` (las etapas terminales por defecto son: `"COMPLETED"`, `"CANCELED"`, `"ERROR"` o `"DELETED"`). El [JobInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/jobs#huggingface_hub.JobInfo) final se devuelve en todos los casos: un Job fallido o cancelado no **lanza** una excepción; compruebe `job.status.stage` para actuar según el resultado. Las etapas terminales siempre detienen la espera, incluso cuando no están listadas en `stages`. Esto evita esperar indefinidamente por una etapa que el Job nunca alcanzará (p. ej., esperar `"RUNNING"` en un Job que falla durante la programación). Ejemplo: ```python >>> from huggingface_hub import run_job, wait_for_job >>> job = run_job(image="python:3.12", command=["python", "-c", "print('Hello from HF compute!')"]) >>> wait_for_job(job_id=job.id).status.stage 'COMPLETED' ``` #### wait_for_space[[huggingface_hub.HfApi.wait_for_space]] ```python wait_for_space(repo_id: str, timeout: float | None = None, poll_interval: float = 1.0, token: bool | str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8803) **Parámetros:** repo_id (`str`) : ID del Space para el que esperar. Ejemplo: `"username/my-space"`. timeout (`float`, *opcional*) : Tiempo máximo de espera en segundos. Si es `None`, espera indefinidamente. poll_interval (`float`, *opcional*) : Segundos entre comprobaciones de estado. El valor predeterminado es 1 s. token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido. Por defecto, se utiliza el token guardado localmente, que es el método de autenticación recomendado. Establezca `False` para deshabilitar la autenticación. Consulte https://huggingface.co/docs/huggingface_hub/quick-start#authentication. **Devuelve:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) La información final de tiempo de ejecución una vez que el Space alcanza una etapa terminal. **Excepciones:** ``TimeoutError`` - ``TimeoutError`` -- Si el Space no ha alcanzado una etapa terminal después de `timeout` segundos. Espera hasta que un Space alcance una etapa terminal (no esté en construcción/iniciando). Las consultas [get_space_runtime()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_space_runtime) se realizan cada `poll_interval` segundos hasta que la etapa del Space ya no sea intermedia (`BUILDING`, `RUNNING_BUILDING`, `APP_STARTING`, `RUNNING_APP_STARTING`). Devuelve el [SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) final en todos los casos; compruebe `runtime.stage` para actuar según el resultado (p. ej., `RUNNING` frente a `BUILD_ERROR`). Ejemplo: ```python >>> from huggingface_hub import restart_space, wait_for_space >>> restart_space("username/my-space") >>> runtime = wait_for_space("username/my-space") >>> runtime.stage 'RUNNING' ``` #### whoami[[huggingface_hub.HfApi.whoami]] ```python whoami(token: bool | str | None = None, cache: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2218) **Parámetros:** token (`bool` o `str`, *opcional*) : Un token de acceso de usuario válido (cadena). Por defecto, se utiliza el token guardado localmente, que es el método recomendado para la autenticación (ver https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Para deshabilitar la autenticación, pase `False`. cache (`bool`, *opcional*) : Si se debe cachear el resultado de la llamada `whoami` para llamadas posteriores. Si se produce un error durante la primera llamada, no se cacheará. El valor predeterminado es `False`. Llama a la API de HF para saber "whoami". Si se pasa `cache=True`, el resultado se almacenará en caché para las llamadas posteriores durante la duración del proceso de Python. Esto es útil si se planea llamar a `whoami` varias veces, ya que este punto de acceso tiene un límite de tasa estricto por razones de seguridad. ## Clases de datos de la API ### AccessRequest[[huggingface_hub.hf_api.AccessRequest]] #### huggingface_hub.hf_api.AccessRequest[[huggingface_hub.hf_api.AccessRequest]] ```python huggingface_hub.hf_api.AccessRequest(username: str | None, request_id: str, fullname: str | None, email: str | None, timestamp: datetime, status: Literal['pending', 'accepted', 'rejected'], fields: dict[str, Any] | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L445) **Parámetros:** username (`str`, *opcional*) : Nombre de usuario del usuario que solicitó el acceso. `None` si el repositorio está configurado para no compartir los nombres de usuario de los solicitantes. En ese caso, use `request_id` para aceptar, rechazar o cancelar la solicitud. request_id (`str`) : Id de la solicitud de acceso. Siempre se establece, incluso si el nombre de usuario no se comparte. fullname (`str`, *opcional*) : Nombre completo del usuario que solicitó el acceso. `None` si el repositorio está configurado para no compartir los nombres de usuario de los solicitantes. email (`str`, *opcional*) : Correo electrónico del usuario que solicitó el acceso. `None` si el usuario fue concedido el acceso manualmente o si el repositorio está configurado para no compartir los correos electrónicos de los solicitantes. timestamp (`datetime`) : Marca de tiempo de la solicitud. status (`Literal["pending", "accepted", "rejected"]`) : Estado de la solicitud. Puede ser uno de `["pending", "accepted", "rejected"]`. fields (`dict[str, Any]`, *opcional*) : Campos adicionales que el usuario completa en el formulario de la puerta. Estructura de datos que contiene información sobre una solicitud de acceso de un usuario. ### BucketFile[[huggingface_hub.BucketFile]] #### huggingface_hub.BucketFile[[huggingface_hub.BucketFile]] ```python huggingface_hub.BucketFile(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L197) Contiene información sobre un archivo en un bucket en el Hub. Este objeto es devuelto por [list_bucket_tree()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_bucket_tree). Similar a [RepoFile](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.RepoFile) pero para archivos en buckets. ### BucketFileMetadata[[huggingface_hub.BucketFileMetadata]] #### huggingface_hub.BucketFileMetadata[[huggingface_hub.BucketFileMetadata]] ```python huggingface_hub.BucketFileMetadata(size: int, xet_file_data: XetFileData) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L140) **Parámetros:** size (`int`) : Tamaño del archivo en bytes. xet_file_data (`XetFileData`) : Información de Xet para el archivo (hash y ruta de actualización). Estructura de datos que contiene información sobre un archivo en un bucket. Devuelto por [get_bucket_file_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_bucket_file_metadata). ### BucketInfo[[huggingface_hub.BucketInfo]] #### huggingface_hub.BucketInfo[[huggingface_hub.BucketInfo]] ```python huggingface_hub.BucketInfo(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L65) **Parámetros:** id (`str`) : ID del bucket. private (`bool`) : Si el bucket es privado. created_at (`datetime`) : Fecha de creación del bucket en el Hub. size (`int`) : Tamaño del cubo en bytes. total_files (`int`) : Número total de archivos en el bucket. Contiene información sobre un bucket en el Hub. Este objeto es devuelto por [bucket_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.bucket_info) y [list_buckets()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_buckets). ### BucketUrl[[huggingface_hub.BucketUrl]] #### huggingface_hub.BucketUrl[[huggingface_hub.BucketUrl]] ```python huggingface_hub.BucketUrl(url: str, endpoint: str = '') ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L157) **Parámetros:** url (`str`) : Valor de cadena de la URL del bucket. endpoint (`str`, *opcional*) : Punto de acceso del Hub. El valor predeterminado es . Describe una URL de cubo en el Hub. `BucketUrl` es devuelto por [create_bucket()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_bucket). Durante la inicialización, la URL se analiza para poblar las propiedades: - endpoint (`str`) - namespace (`str`) - bucket_id (`str`) - url (`str`) - uri (`HfUri`) ### DatasetLeaderboardEntry[[huggingface_hub.DatasetLeaderboardEntry]] #### huggingface_hub.DatasetLeaderboardEntry[[huggingface_hub.DatasetLeaderboardEntry]] ```python huggingface_hub.DatasetLeaderboardEntry(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1948) **Parámetros:** rank (`int`) : Puesto del modelo en la clasificación (índice desde 1). model_id (`str`) : ID del modelo (p. ej. `"meta-llama/Llama-3-8b"`). value (`float`) : Valor de la puntuación de evaluación. filename (`str`) : Nombre del archivo de resultados que contiene los datos de evaluación. verified (`bool`) : Indica si el resultado ha sido verificado. source (`dict[str, Any]`, *opcional*) : Información sobre el origen del resultado de la evaluación. Contiene claves como `"url"`, `"name"` y `"isExternal"`. No todas las entradas tienen un origen. author (`User` o `Organization`) : El autor del modelo, analizado en función del campo `"type"` en la respuesta de la API. pull_request (`int`, *opcional*) : Número de solicitud de extracción (pull request) asociado con la entrada de la clasificación, si la hay. notes (`str`, *opcional*) : Notas asociadas a la entrada de la clasificación, si las hay. Contiene información sobre una única entrada en un tablero de clasificación de conjuntos de datos en el Hub. Un tablero de clasificación ordena los modelos según sus puntuaciones de evaluación en un conjunto de datos de referencia dado. Este objeto se devuelve mediante [get_dataset_leaderboard()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_dataset_leaderboard). Para obtener los resultados de evaluación de un modelo específico en varios conjuntos de datos de referencia, consulte `ModelInfo.eval_results` (mediante [model_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.model_info) con `expand=["evalResults"]`) y [EvalResultEntry](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.EvalResultEntry). ### EvalResultEntry[[huggingface_hub.EvalResultEntry]] #### huggingface_hub.EvalResultEntry[[huggingface_hub.EvalResultEntry]] ```python huggingface_hub.EvalResultEntry(dataset_id: str, task_id: str, value: typing.Any, dataset_revision: str | None = None, verify_token: str | None = None, date: str | None = None, source_url: str | None = None, source_name: str | None = None, source_user: str | None = None, source_org: str | None = None, notes: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_eval_results.py#L17) **Parámetros:** dataset_id (`str`) : ID del conjunto de datos de referencia del Hub. Ejemplo: "cais/hle", "Idavidrein/gpqa". task_id (`str`) : Identificador de la tarea dentro del benchmark. Ejemplo: "gpqa_diamond". value (`Any`) : El valor de la métrica. Ejemplo: 20.90. dataset_revision (`str`, *opcional*) : SHA de Git del conjunto de datos de referencia. verify_token (`str`, *opcional*) : Una firma que se puede utilizar para demostrar que la evaluación es auditable y reproducible de forma demostrable. date (`str`, *opcional*) : Momento en que se ejecutó la evaluación (fecha y hora ISO-8601). El valor predeterminado es la hora del commit de git. source_url (`str`, *opcional*) : Enlace a la fuente de evaluación (p. ej., https://huggingface.co/spaces/SaylorTwift/smollm3-mmlu-pro). Obligatorio si se proporciona `source_name`, `source_user` o `source_org`. source_name (`str`, *opcional*) : Nombre de visualización para la fuente. Ejemplo: "Eval Logs". source_user (`str`, *opcional*) : nombre de usuario de HF para la atribución. Ejemplo: "celinah". source_org (`str`, *opcional*) : nombre de la organización de HF para la atribución. Ejemplo: "cais". notes (`str`, *opcional*) : Detalles sobre la configuración de evaluación. Ejemplo: "tools", "no-tools", "chain-of-thought". Entrada de resultado de evaluación para el formato `.eval_results/*.yaml`. Representa las puntuaciones de evaluación almacenadas en los repositorios de modelos que aparecen automáticamente en la página del modelo y en la clasificación del conjunto de datos de referencia. Para el formato heredado `model-index` en `README.md`, usa [EvalResult](/docs/huggingface_hub/v2.4.0/es/package_reference/cards#huggingface_hub.EvalResult) en su lugar. Consulte https://huggingface.co/docs/hub/eval-results para más detalles. Ejemplo: ```python >>> from huggingface_hub import EvalResultEntry >>> # Minimal example with required fields only >>> result = EvalResultEntry( ... dataset_id="Idavidrein/gpqa", ... task_id="gpqa_diamond", ... value=0.412, ... ) >>> # Full example with all fields >>> result = EvalResultEntry( ... dataset_id="cais/hle", ... task_id="default", ... value=20.90, ... dataset_revision="5503434ddd753f426f4b38109466949a1217c2bb", ... verify_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", ... date="2025-01-15T10:30:00Z", ... source_url="https://huggingface.co/datasets/cais/hle", ... source_name="CAIS HLE", ... source_org="cais", ... notes="no-tools", ... ) ``` ### SyncOperation[[huggingface_hub.SyncOperation]] #### huggingface_hub.SyncOperation[[huggingface_hub.SyncOperation]] ```python huggingface_hub.SyncOperation(action: typing.Literal['upload', 'download', 'delete', 'skip'], path: str, size: int | None = None, reason: str = '', local_mtime: str | None = None, remote_mtime: str | None = None, bucket_file: huggingface_hub._buckets.BucketFile | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L289) Representa una operación de sincronización que se debe realizar. ### SyncPlan[[huggingface_hub.SyncPlan]] #### huggingface_hub.SyncPlan[[huggingface_hub.SyncPlan]] ```python huggingface_hub.SyncPlan(source: str, dest: str, timestamp: str, operations: list = ) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L302) Representa un plan de sincronización completo. ### CommitInfo[[huggingface_hub.CommitInfo]] #### huggingface_hub.CommitInfo[[huggingface_hub.CommitInfo]] ```python huggingface_hub.CommitInfo(commit_url: str, *args, **kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L362) **Parámetros:** commit_url (`str`) : Url donde encontrar el commit. commit_message (`str`) : El resumen (primera línea) del commit que se ha creado. commit_description (`str`) : Descripción del commit que se ha creado. Puede estar vacío. oid (`str`) : ID del hash del commit. Ejemplo: `"91c54ad1727ee830252e457677f467be0bfd8a57"`. pr_url (`str`, *opcional*) : URL de la PR que se ha creado, si la hay. Se rellena cuando se pasa `create_pr=True`. pr_revision (`str`, *opcional*) : Revisión de la PR que se ha creado, si la hay. Se rellena cuando se pasa `create_pr=True`. Ejemplo: `"refs/pr/1"`. pr_num (`int`, *opcional*) : Número de la discusión de la PR que se ha creado, si la hay. Se rellena cuando se pasa `create_pr=True`. Puede pasarse como `discussion_num` en [get_discussion_details()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_discussion_details). Ejemplo: `1`. repo_url (`RepoUrl`) : URL del repositorio del commit que contiene información como repo_id, repo_type, etc. Estructura de datos que contiene información sobre un commit recién creado. Devuelto por cualquier método que cree un commit en el Hub: [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit), [upload_file()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.upload_file), [upload_folder()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.upload_folder), [delete_file()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.delete_file), [delete_folder()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.delete_folder). Hereda de `str` por compatibilidad con versiones anteriores, pero el uso de métodos específicos de `str` está en desuso. ### DatasetInfo[[huggingface_hub.DatasetInfo]] #### huggingface_hub.DatasetInfo[[huggingface_hub.DatasetInfo]] ```python huggingface_hub.DatasetInfo(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1013) **Parámetros:** id (`str`) : ID del conjunto de datos. author (`str`) : Autor del conjunto de datos. card_data (`DatasetCardData`, *opcional*) : Metadatos de la tarjeta del conjunto de datos como un objeto [huggingface_hub.repocard_data.DatasetCardData](/docs/huggingface_hub/v2.4.0/es/package_reference/cards#huggingface_hub.DatasetCardData). citation (`str`, *opcional*) : Información de citación del conjunto de datos. created_at (`datetime`, *opcional*) : Fecha de creación del repositorio en el Hub. Tenga en cuenta que el valor más bajo es `2022-03-02T23:29:04.000Z`, que corresponde a la fecha en la que comenzamos a almacenar las fechas de creación. description (`str`, *opcional*) : Descripción del conjunto de datos. disabled (`bool`, *opcional*) : Indica si el repositorio está deshabilitado. downloads (`int`) : Número de descargas del conjunto de datos en los últimos 30 días. downloads_all_time (`int`) : Número acumulado de descargas del conjunto de datos desde su creación. gated (`Literal["auto", "manual", False]`, *opcional*) : Indica si el repositorio está restringido. De ser así, especifica si la aprobación es manual o automática. last_modified (`datetime`, *opcional*) : Fecha del último commit al repositorio. likes (`int`) : Número de "me gusta" del conjunto de datos. main_size (`int`, *opcional*) : Tamaño en bytes de la rama principal del conjunto de datos. paperswithcode_id (`str`, *opcional*) : ID de Papers with code del conjunto de datos. private (`bool`) : Si el repositorio es privado. resource_group (`dict`, *opcional*) : Información del grupo de recursos para el conjunto de datos. sha (`str`) : SHA del repositorio en esta revisión en particular. siblings (`list[RepoSibling]`) : Lista de objetos [huggingface_hub.hf_api.RepoSibling](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling) que constituyen el conjunto de datos. tags (`list[str]`) : Lista de etiquetas del conjunto de datos. trending_score (`int`, *opcional*) : Puntuación de tendencia del conjunto de datos. used_storage (`int`, *opcional*) : Tamaño en bytes del conjunto de datos en el Hub. Contiene información sobre un conjunto de datos en el Hub. Este objeto es devuelto por [dataset_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) y [list_datasets()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_datasets). > [!TIP] > La mayoría de los atributos de esta clase son opcionales. Esto se debe a que los datos devueltos por el Hub dependen de la consulta realizada. En general, cuanto más específica sea la consulta, más información se devuelve. Por el contrario, al listar conjuntos de datos con [list_datasets()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_datasets) solo se devuelve un subconjunto de los atributos. ### DryRunFileInfo[[huggingface_hub.DryRunFileInfo]] #### huggingface_hub.DryRunFileInfo[[huggingface_hub.DryRunFileInfo]] ```python huggingface_hub.DryRunFileInfo(commit_hash: str, file_size: int | None, filename: str, local_path: str, is_cached: bool, will_download: bool) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/file_download.py#L182) **Parámetros:** commit_hash (`str`) : El commit_hash relacionado con el archivo. file_size (`int`, *opcional*) : Tamaño del archivo, si se conoce. En el caso de un archivo LFS, contiene el tamaño del archivo LFS real, no el del puntero. filename (`str`) : Nombre del archivo en el repositorio. is_cached (`bool`) : Indica si el archivo ya está en caché localmente. will_download (`bool`) : Indica si el archivo se descargará si se llama a `hf_hub_download` con `dry_run=False`. En la práctica, will_download es `True` si el archivo no está en caché o si `force_download=True`. Información devuelta al realizar una ejecución de prueba de la descarga de un archivo. Devuelto por [hf_hub_download()](/docs/huggingface_hub/v2.4.0/es/package_reference/file_download#huggingface_hub.hf_hub_download) cuando `dry_run=True`. ### DuplicatedRepoUrl[[huggingface_hub.DuplicatedRepoUrl]] #### huggingface_hub.DuplicatedRepoUrl[[huggingface_hub.DuplicatedRepoUrl]] ```python huggingface_hub.DuplicatedRepoUrl(url: Any, endpoint: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L594) **Parámetros:** files_copy_pending (`bool`) : `True` si los archivos LFS/Xet del nuevo repositorio aún se están copiando en segundo plano. Hasta que la copia esté completa, la descarga de estos archivos puede fallar. [RepoUrl](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.RepoUrl) devuelto por [duplicate_repo()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.duplicate_repo). ### GitRefInfo[[huggingface_hub.GitRefInfo]] #### huggingface_hub.GitRefInfo[[huggingface_hub.GitRefInfo]] ```python huggingface_hub.GitRefInfo(name: str, ref: str, target_commit: str) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1444) **Parámetros:** name (`str`) : Nombre de la referencia (p. ej., nombre de etiqueta o nombre de rama). ref (`str`) : Referencia git completa en el Hub (p. ej. `"refs/heads/main"` o `"refs/tags/v1.0"`). target_commit (`str`) : OID del commit objetivo para la referencia (p. ej. `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`) Contiene información sobre una referencia de git para un repositorio en el Hub. ### GitCommitInfo[[huggingface_hub.GitCommitInfo]] #### huggingface_hub.GitCommitInfo[[huggingface_hub.GitCommitInfo]] ```python huggingface_hub.GitCommitInfo(commit_id: str, authors: list[str], created_at: datetime, title: str, message: str, formatted_title: str | None, formatted_message: str | None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1489) **Parámetros:** commit_id (`str`) : OID del commit (p. ej. `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`) authors (`list[str]`) : Lista de autores del commit. created_at (`datetime`) : Fecha y hora en la que se creó el commit. title (`str`) : Título del commit. Este es un valor de texto libre introducido por los autores. message (`str`) : Descripción del commit. Este es un valor de texto libre introducido por los autores. formatted_title (`str`) : Título del commit formateado como HTML. Solo se devuelve si se establece `formatted=True`. formatted_message (`str`) : Descripción del commit formateada como HTML. Solo se devuelve si se establece `formatted=True`. Contiene información sobre un commit de git para un repositorio en el Hub. Consulte [list_repo_commits()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_repo_commits) para más detalles. ### GitRefs[[huggingface_hub.GitRefs]] #### huggingface_hub.GitRefs[[huggingface_hub.GitRefs]] ```python huggingface_hub.GitRefs(branches: list[GitRefInfo], converts: list[GitRefInfo], tags: list[GitRefInfo], pull_requests: list[GitRefInfo] | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1463) **Parámetros:** branches (`list[GitRefInfo]`) : Una lista de [GitRefInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.GitRefInfo) que contiene información sobre las ramas del repositorio. converts (`list[GitRefInfo]`) : Una lista de [GitRefInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.GitRefInfo) que contiene información sobre las referencias "convert" del repositorio. Los conversores son referencias que se utilizan (internamente) para enviar datos preprocesados en los repositorios de Dataset. tags (`list[GitRefInfo]`) : Una lista de [GitRefInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.GitRefInfo) que contiene información sobre las etiquetas del repositorio. pull_requests (`list[GitRefInfo]`, *opcional*) : Una lista de [GitRefInfo](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.GitRefInfo) que contiene información sobre las solicitudes de extracción (pull requests) del repositorio. Solo se devuelve si se establece `include_prs=True`. Contiene información sobre todas las referencias de git de un repositorio en el Hub. El objeto es devuelto por [list_repo_refs()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_repo_refs). ### InferenceProviderMapping[[huggingface_hub.hf_api.InferenceProviderMapping]] #### huggingface_hub.hf_api.InferenceProviderMapping[[huggingface_hub.hf_api.InferenceProviderMapping]] ```python huggingface_hub.hf_api.InferenceProviderMapping(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L773) ### KernelInfo[[huggingface_hub.KernelInfo]] #### huggingface_hub.KernelInfo[[huggingface_hub.KernelInfo]] ```python huggingface_hub.KernelInfo(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1285) **Parámetros:** id (`str`) : ID del repositorio del kernel. author (`str`, *opcional*) : Autor del repositorio del kernel. downloads (`int`, *opcional*) : Número de descargas del repositorio del kernel en los últimos 30 días. gated (`Literal["auto", "manual", False]`, *opcional*) : Indica si el repositorio está restringido. De ser así, especifica si la aprobación es manual o automática. last_modified (`datetime`, *opcional*) : Fecha del último commit al repositorio. likes (`int`, *opcional*) : Número de me gusta del repositorio del kernel. private (`bool`, *opcional*) : Indica si el repositorio es privado. sha (`str`, *opcional*) : SHA del repositorio en esta revisión en particular. Contiene información sobre un repositorio de kernel en el Hub. Este objeto es devuelto por [kernel_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.kernel_info). ### LFSFileInfo[[huggingface_hub.hf_api.LFSFileInfo]] #### huggingface_hub.hf_api.LFSFileInfo[[huggingface_hub.hf_api.LFSFileInfo]] ```python huggingface_hub.hf_api.LFSFileInfo(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1887) **Parámetros:** file_oid (`str`) : ID de objeto SHA-256 del archivo. Este es el identificador que debe pasarse al eliminar el archivo de forma permanente. filename (`str`) : Nombre de archivo posible para el objeto LFS. Consulte la nota anterior para obtener más información. oid (`str`) : OID del objeto LFS. pushed_at (`datetime`) : Fecha en la que el objeto LFS se subió al repositorio. ref (`str`, *opcional*) : Ref donde se ha enviado el objeto LFS (si lo hay). size (`int`) : Tamaño del objeto LFS. Contiene información sobre un archivo almacenado como LFS en un repositorio de Hub. Se utiliza en el contexto de listar y eliminar permanentemente archivos LFS de un repositorio para liberar espacio. Consulte [list_lfs_files()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_lfs_files) y [permanently_delete_lfs_files()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.permanently_delete_lfs_files) para más detalles. Los archivos de Git LFS se rastrean mediante identificadores de objeto SHA-256, en lugar de rutas de archivo, para optimizar el rendimiento. Este enfoque es necesario porque un solo objeto puede ser referenciado por múltiples rutas a través de distintos commits, lo que hace impráctico buscar y resolver estas conexiones. Consulta [nuestra documentación](https://huggingface.co/docs/hub/storage-limits#advanced-track-lfs-file-references) para saber cómo identificar qué nombre(s) de archivo está(n) asociado(s) con cada SHA. Ejemplo: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> lfs_files = api.list_lfs_files("username/my-cool-repo") # Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`. # e.g. select only LFS files in the "checkpoints" folder >>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/")) # Permanently delete LFS files >>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete) ``` ### ModelInfo[[huggingface_hub.ModelInfo]] #### huggingface_hub.ModelInfo[[huggingface_hub.ModelInfo]] ```python huggingface_hub.ModelInfo(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L798) **Parámetros:** id (`str`) : ID del modelo. author (`str`, *opcional*) : Autor del modelo. base_models (`list[str]`, *opcional*) : Lista de modelos base de los que se deriva este modelo. card_data (`ModelCardData`, *opcional*) : Metadatos de la tarjeta del modelo como un objeto [huggingface_hub.repocard_data.ModelCardData](/docs/huggingface_hub/v2.4.0/es/package_reference/cards#huggingface_hub.ModelCardData). children_model_count (`int`, *opcional*) : Número de modelos hijos derivados de este modelo. config (`dict`, *opcional*) : Configuración del modelo. created_at (`datetime`, *opcional*) : Fecha de creación del repositorio en el Hub. Tenga en cuenta que el valor más bajo es `2022-03-02T23:29:04.000Z`, que corresponde a la fecha en la que comenzamos a almacenar las fechas de creación. disabled (`bool`, *opcional*) : Indica si el repositorio está deshabilitado. downloads (`int`) : Número de descargas del modelo en los últimos 30 días. downloads_all_time (`int`) : Número acumulado de descargas del modelo desde su creación. eval_results (`list[EvalResultEntry]`, *opcional*) : Resultados de evaluación del modelo. gated (`Literal["auto", "manual", False]`, *opcional*) : Indica si el repositorio está restringido. De ser así, especifica si la aprobación es manual o automática. gguf (`dict`, *opcional*) : información GGUF del modelo. inference (`Literal["warm"]`, *opcional*) : Estado del modelo en los proveedores de inferencia. Cálido si el modelo está servido por al menos un proveedor. inference_provider_mapping (`list[InferenceProviderMapping]`, *opcional*) : Una lista de `InferenceProviderMapping` ordenada según el orden de proveedores del usuario. last_modified (`datetime`, *opcional*) : Fecha del último commit al repositorio. library_name (`str`, *opcional*) : Biblioteca asociada con el modelo. likes (`int`) : Número de "me gusta" del modelo. mask_token (`str`, *opcional*) : Token de máscara utilizado por el modelo. model_index (`dict`, *opcional*) : Índice del modelo para la evaluación. pipeline_tag (`str`, *opcional*) : Etiqueta de pipeline asociada con el modelo. private (`bool`) : Si el repositorio es privado. resource_group (`dict`, *opcional*) : Información del grupo de recursos para el modelo. safetensors (`SafeTensorsInfo`, *opcional*) : Información de safetensors del modelo. security_repo_status (`dict`, *opcional*) : Estado del análisis de seguridad del modelo. sha (`str`, *opcional*) : SHA del repositorio en esta revisión en particular. siblings (`list[RepoSibling]`) : Lista de objetos [huggingface_hub.hf_api.RepoSibling](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling) que constituyen el modelo. spaces (`list[str]`, *opcional*) : Lista de espacios que utilizan el modelo. tags (`list[str]`) : Lista de etiquetas del modelo. En comparación con `card_data.tags`, contiene etiquetas adicionales calculadas por el Hub (p. ej., bibliotecas compatibles, arXiv del modelo). transformers_info (`TransformersInfo`, *opcional*) : Información específica de Transformers (clase automática, procesador, etc.) asociada al modelo. trending_score (`int`, *opcional*) : Puntuación de tendencia del modelo. used_storage (`int`, *opcional*) : Tamaño en bytes del modelo en el Hub. widget_data (`Any`, *opcional*) : Datos del widget asociados con el modelo. Contiene información sobre un modelo en el Hub. Este objeto es devuelto por [model_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.model_info) y [list_models()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_models). > [!TIP] > La mayoría de los atributos de esta clase son opcionales. Esto se debe a que los datos devueltos por el Hub dependen de la consulta realizada. En general, cuanto más específica sea la consulta, más información se devuelve. Por el contrario, al listar modelos usando [list_models()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_models) solo se devuelve un subconjunto de los atributos. ### RepoSibling[[huggingface_hub.hf_api.RepoSibling]] #### huggingface_hub.hf_api.RepoSibling[[huggingface_hub.hf_api.RepoSibling]] ```python huggingface_hub.hf_api.RepoSibling(rfilename: str, size: int | None = None, blob_id: str | None = None, lfs: BlobLfsInfo | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L648) **Parámetros:** rfilename (str) : nombre del archivo, relativo a la raíz del repositorio. size (`int`, *opcional*) : El tamaño del archivo, en bytes. Este atributo se define cuando el argumento `files_metadata` de [repo_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.repo_info) se establece en `True`. En caso contrario, es `None`. blob_id (`str`, *opcional*) : El OID de git del archivo. Este atributo se define cuando el argumento `files_metadata` de [repo_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.repo_info) se establece en `True`. En caso contrario, es `None`. lfs (`BlobLfsInfo`, *opcional*) : Metadatos de LFS del archivo. Este atributo se define cuando el argumento `files_metadata` de [repo_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.repo_info) se establece en `True` y el archivo se almacena con Git LFS. En caso contrario, es `None`. Contiene información básica sobre un archivo de un repositorio dentro de un repositorio en el Hub. > [!TIP] > Todos los atributos de esta clase son opcionales, excepto `rfilename`. Esto se debe a que, al listar repositorios en el Hub (con [list_models()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_models), [list_datasets()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_datasets) o [list_spaces()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_spaces)), solo se devuelven los nombres de los archivos. Si necesitas más información, como el tamaño del archivo, el id del blob o los detalles de lfs, debes solicitarla específicamente de un repositorio a la vez (usando [model_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.model_info), [dataset_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) o [space_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.space_info)), ya que recuperar estos datos impone más restricciones al servidor de backend. ### RepoFile[[huggingface_hub.RepoFile]] #### huggingface_hub.RepoFile[[huggingface_hub.RepoFile]] ```python huggingface_hub.RepoFile(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L680) **Parámetros:** path (str) : ruta de archivo relativa a la raíz del repositorio. size (`int`) : El tamaño del archivo, en bytes. blob_id (`str`) : OID de git del archivo. lfs (`BlobLfsInfo`, *opcional*) : Metadatos de LFS del archivo. xet_hash (`str`, *opcional*) : El hash Xet del archivo. last_commit (`LastCommitInfo`, *opcional*) : Metadatos del último commit del archivo. Solo se define si [list_repo_tree()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_repo_tree) y [get_paths_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_paths_info) se llaman con `expand=True`. security (`BlobSecurityInfo`, *opcional*) : Metadatos del análisis de seguridad del archivo. Solo se define si [list_repo_tree()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_repo_tree) y [get_paths_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_paths_info) se llaman con `expand=True`. Contiene información sobre un archivo en el Hub. ### RepoUrl[[huggingface_hub.RepoUrl]] #### huggingface_hub.RepoUrl[[huggingface_hub.RepoUrl]] ```python huggingface_hub.RepoUrl(url: Any, endpoint: str | None = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L527) **Parámetros:** url (`Any`) : valor de String de la URL del repositorio. endpoint (`str`, *opcional*) : Punto de acceso del Hub. El valor predeterminado es . **Excepciones:** `HfUriError` - `HfUriError` -- Si la URL no se puede analizar (p. ej., un repositorio canónico de un solo segmento, o un `repo_type` desconocido). Subclase de `str` que describe una URL de un repositorio en el Hub. `RepoUrl` es devuelto por `HfApi.create_repo`. Hereda de `str` por compatibilidad con versiones anteriores. En la inicialización, la URL se analiza para poblar las propiedades: - endpoint (`str`) - namespace (`str`) - repo_name (`str`) - repo_id (`str`) - repo_type (`Literal["model", "dataset", "space"]`) - url (`str`) Ejemplo: ```py >>> RepoUrl('https://huggingface.co/openai-community/gpt2') RepoUrl('https://huggingface.co/openai-community/gpt2', endpoint='https://huggingface.co', repo_type='model', repo_id='openai-community/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') ``` ### SafetensorsRepoMetadata[[huggingface_hub.utils.SafetensorsRepoMetadata]] #### huggingface_hub.utils.SafetensorsRepoMetadata[[huggingface_hub.utils.SafetensorsRepoMetadata]] ```python huggingface_hub.utils.SafetensorsRepoMetadata(metadata: dict | None, sharded: bool, weight_map: dict, files_metadata: dict) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L74) **Parámetros:** metadata (`dict`, *opcional*) : Los metadatos contenidos en el archivo 'model.safetensors.index.json', si existe. Solo se rellena para modelos fragmentados. sharded (`bool`) : Si el repositorio contiene un modelo fragmentado o no. weight_map (`dict[str, str]`) : Un mapa de todos los pesos. Las claves son los nombres de los tensores y los valores son los nombres de los archivos que contienen los tensores. files_metadata (`dict[str, SafetensorsFileMetadata]`) : Un mapa con los metadatos de todos los archivos. Las claves son los nombres de archivo y los valores son los metadatos del archivo correspondiente, como un objeto `SafetensorsFileMetadata`. parameter_count (`dict[str, int]`) : Un mapa con el número de parámetros por tipo de datos. Las claves son los tipos de datos y los valores son el número de parámetros de ese tipo de datos. Metadatos de un repositorio de Safetensors. Un repositorio se considera un repositorio de Safetensors si contiene en su raíz un archivo de pesos 'model.safetensors' (modelo no compartido) o un archivo de índice 'model.safetensors.index.json' (modelo fragmentado). Esta clase es devuelta por [get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata). Para más detalles sobre el formato safetensors, consulta https://huggingface.co/docs/safetensors/index#format. ### SafetensorsFileMetadata[[huggingface_hub.utils.SafetensorsFileMetadata]] #### huggingface_hub.utils.SafetensorsFileMetadata[[huggingface_hub.utils.SafetensorsFileMetadata]] ```python huggingface_hub.utils.SafetensorsFileMetadata(metadata: dict, tensors: dict) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L44) **Parámetros:** metadata (`dict`) : Los metadatos contenidos en el archivo. tensors (`dict[str, TensorInfo]`) : Un mapa de todos los tensores. Las claves son los nombres de los tensores y los valores son la información sobre el tensor correspondiente, como un objeto `TensorInfo`. parameter_count (`dict[str, int]`) : Un mapa con el número de parámetros por tipo de datos. Las claves son los tipos de datos y los valores son el número de parámetros de ese tipo de datos. Metadatos de un archivo Safetensors alojado en el Hub. Esta clase es devuelta por [parse_safetensors_file_metadata()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.parse_safetensors_file_metadata). Para más detalles sobre el formato safetensors, consulta https://huggingface.co/docs/safetensors/index#format. ### SpaceInfo[[huggingface_hub.SpaceInfo]] #### huggingface_hub.SpaceInfo[[huggingface_hub.SpaceInfo]] ```python huggingface_hub.SpaceInfo(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1147) **Parámetros:** id (`str`) : ID del Space. author (`str`, *opcional*) : Autor del Space. card_data (`SpaceCardData`, *opcional*) : Metadatos de la tarjeta del Espacio como un objeto [huggingface_hub.repocard_data.SpaceCardData](/docs/huggingface_hub/v2.4.0/es/package_reference/cards#huggingface_hub.SpaceCardData). created_at (`datetime`, *opcional*) : Fecha de creación del repositorio en el Hub. Tenga en cuenta que el valor más bajo es `2022-03-02T23:29:04.000Z`, que corresponde a la fecha en la que comenzamos a almacenar las fechas de creación. datasets (`list[str]`, *opcional*) : Lista de conjuntos de datos utilizados por el Space. disabled (`bool`, *opcional*) : Indica si el Space está deshabilitado. gated (`Literal["auto", "manual", False]`, *opcional*) : Indica si el repositorio está restringido. De ser así, especifica si la aprobación es manual o automática. host (`str`, *opcional*) : URL del host del Space. last_modified (`datetime`, *opcional*) : Fecha del último commit al repositorio. likes (`int`) : Número de "me gusta" del Space. models (`list[str]`, *opcional*) : Lista de modelos utilizados por el Space. private (`bool`) : Si el repositorio es privado. region (`Literal["us", "eu"]`, *opcional*) : Región de la nube en la que se almacena el Space. resource_group (`dict`, *opcional*) : Información del grupo de recursos del Space. runtime (`SpaceRuntime`, *opcional*) : información sobre el runtime del Space como un objeto [huggingface_hub.hf_api.SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime). sdk (`str`, *opcional*) : SDK utilizado por el Space. sha (`str`, *opcional*) : SHA del repositorio en esta revisión en particular. siblings (`list[RepoSibling]`) : Lista de objetos [huggingface_hub.hf_api.RepoSibling](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling) que constituyen el Space. subdomain (`str`, *opcional*) : Subdominio del Space. tags (`list[str]`) : Lista de etiquetas del Space. trending_score (`int`, *opcional*) : Puntuación de tendencia del Espacio. used_storage (`int`, *opcional*) : Tamaño en bytes del Space en el Hub. Contiene información sobre un Space en el Hub. Este objeto es devuelto por [space_info()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.space_info) y [list_spaces()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_spaces). > [!TIP] > La mayoría de los atributos de esta clase son opcionales. Esto se debe a que los datos devueltos por el Hub dependen de la consulta realizada. En general, cuanto más específica sea la consulta, más información se devuelve. Por el contrario, al listar espacios con [list_spaces()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.list_spaces) solo se devuelve un subconjunto de los atributos. ### SpaceSearchResult[[huggingface_hub.SpaceSearchResult]] #### huggingface_hub.SpaceSearchResult[[huggingface_hub.SpaceSearchResult]] ```python huggingface_hub.SpaceSearchResult(data: dict) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_space_api.py#L309) **Parámetros:** id (`str`) : ID del Space (p. ej. `"username/repo-name"`). author (`str`) : Autor del Space. title (`str`) : Título de visualización del Space. emoji (`str` o `None`) : Icono de emoji del Espacio. sdk (`str` o `None`) : SDK utilizado por el Space (p. ej., `"gradio"`, `"docker"`, `"static"`). likes (`int`) : Número de me gusta. private (`bool`) : Si el Space es privado. tags (`list[str]` o `None`) : Lista de etiquetas. runtime ([SpaceRuntime](/docs/huggingface_hub/v2.4.0/es/package_reference/space_runtime#huggingface_hub.SpaceRuntime) o `None`) : Información del tiempo de ejecución (etapa, hardware, etc.). ai_short_description (`str` o `None`) : Descripción breve generada por IA. ai_category (`str` o `None`) : Categoría generada por IA (p. ej., `"Image Generation"`). semantic_relevancy_score (`float` o `None`) : Puntuación de relevancia semántica (0-1) relativa a la consulta de búsqueda. trending_score (`int` o `None`) : Puntuación de tendencia. Un resultado individual de la API de búsqueda semántica de Spaces. Devuelto por [HfApi.search_spaces()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.search_spaces). ### TensorInfo[[huggingface_hub.utils.TensorInfo]] #### huggingface_hub.utils.TensorInfo[[huggingface_hub.utils.TensorInfo]] ```python huggingface_hub.utils.TensorInfo(dtype: typing.Literal['F64', 'F32', 'F16', 'BF16', 'I64', 'I32', 'I16', 'I8', 'U8', 'U3', 'BOOL'], shape: list, data_offsets: tuple) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L14) **Parámetros:** dtype (`str`) : El tipo de datos del tensor ("F64", "F32", "F16", "BF16", "I64", "I32", "I16", "I8", "U8", "U3", "BOOL"). shape (`list[int]`) : La forma del tensor. data_offsets (`tuple[int, int]`) : Los desplazamientos de los datos en el archivo como una tupla `[BEGIN, END]`. parameter_count (`int`) : El número de parámetros en el tensor. Información sobre un tensor. Para más detalles sobre el formato safetensors, consulta https://huggingface.co/docs/safetensors/index#format. ### Usuario[[huggingface_hub.User]] #### huggingface_hub.User[[huggingface_hub.User]] ```python huggingface_hub.User(**kwargs) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1658) **Parámetros:** username (`str`) : Nombre del usuario en el Hub (único). fullname (`str`) : Nombre completo del usuario. avatar_url (`str`) : URL del avatar del usuario. details (`str`, *opcional*) : Detalles del usuario. is_following (`bool`, *opcional*) : Indica si el usuario autenticado sigue a este usuario. is_pro (`bool`, *opcional*) : Indica si el usuario es un usuario pro. num_models (`int`, *opcional*) : Número de modelos creados por el usuario. num_datasets (`int`, *opcional*) : Número de conjuntos de datos creados por el usuario. num_spaces (`int`, *opcional*) : Número de espacios creados por el usuario. num_discussions (`int`, *opcional*) : Número de discusiones iniciadas por el usuario. num_papers (`int`, *opcional*) : Número de artículos escritos por el usuario. num_upvotes (`int`, *opcional*) : Número de votos positivos recibidos por el usuario. num_likes (`int`, *opcional*) : Número de me gusta dados por el usuario. num_following (`int`, *opcional*) : Número de usuarios a los que este usuario sigue. num_followers (`int`, *opcional*) : Número de usuarios que siguen a este usuario. orgs (lista de `Organization`) : Lista de organizaciones de las que el usuario es miembro. Contiene información sobre un usuario en el Hub. ### UserLikes[[huggingface_hub.UserLikes]] #### huggingface_hub.UserLikes[[huggingface_hub.UserLikes]] ```python huggingface_hub.UserLikes(user: str, total: int, datasets: list[str], kernels: list[str], models: list[str], spaces: list[str]) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1522) **Parámetros:** user (`str`) : Nombre del usuario para el que se obtuvieron los me gusta. total (`int`) : Número total de me gusta. datasets (`list[str]`) : Lista de conjuntos de datos que le gustan al usuario (como repo_ids). kernels (`list[str]`) : Lista de kernels que le gustan al usuario (como repo_ids). models (`list[str]`) : Lista de modelos que le gustan al usuario (como repo_ids). spaces (`list[str]`) : Lista de espacios que le gustan al usuario (como repo_ids). Contiene información sobre las publicaciones que un usuario ha marcado con "me gusta" en el Hub. ### WebhookInfo[[huggingface_hub.WebhookInfo]] #### huggingface_hub.WebhookInfo[[huggingface_hub.WebhookInfo]] ```python huggingface_hub.WebhookInfo(id: str, url: str | None, job: JobSpec | None, watched: list[WebhookWatchedItem], domains: list[constants.WEBHOOK_DOMAIN_T], secret: str | None, disabled: bool) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L496) **Parámetros:** id (`str`) : ID del webhook. url (`str`, *opcional*) : URL del webhook. job (`JobSpec`, *opcional*) : Especificaciones del Job a activar. watched (`list[WebhookWatchedItem]`) : Lista de elementos observados por el webhook, consulte [WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.WebhookWatchedItem). domains (`list[WEBHOOK_DOMAIN_T]`) : Lista de dominios que el webhook está observando. Puede ser uno de `["repo", "discussion"]`. secret (`str`, *opcional*) : Secreto del webhook. disabled (`bool`) : Indica si el webhook está deshabilitado o no. Estructura de datos que contiene información sobre un webhook. Se especifica uno de `url` o `job`, pero no ambos. ### WebhookWatchedItem[[huggingface_hub.WebhookWatchedItem]] #### huggingface_hub.WebhookWatchedItem[[huggingface_hub.WebhookWatchedItem]] ```python huggingface_hub.WebhookWatchedItem(type: Literal['bucket', 'dataset', 'model', 'org', 'space', 'user'], name: str) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L480) **Parámetros:** type (`Literal["bucket", "dataset", "model", "org", "space", "user"]`) : Tipo del elemento que se va a observar. Puede ser uno de `["bucket", "dataset", "model", "org", "space", "user"]`. name (`str`) : Nombre del elemento que se va a observar. Puede ser el nombre de usuario, el nombre de la organización, el nombre del modelo, el nombre del conjunto de datos, el nombre del espacio o el nombre del bucket. Estructura de datos que contiene información sobre los elementos observados por un webhook. ## CommitOperation[[huggingface_hub.CommitOperationAdd]] A continuación se muestran los valores admitidos para `CommitOperation()`: #### huggingface_hub.CommitOperationAdd[[huggingface_hub.CommitOperationAdd]] ```python huggingface_hub.CommitOperationAdd(path_in_repo: str, path_or_fileobj: str | pathlib.Path | bytes | typing.BinaryIO) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L141) **Parámetros:** path_in_repo (`str`) : Ruta de archivo relativa en el repositorio, por ejemplo: `"checkpoints/1fec34a/weights.bin"` path_or_fileobj (`str`, `Path`, `bytes` o `BinaryIO`) : Puede ser: - una ruta a un archivo local (como `str` o `pathlib.Path`) para subir - un búfer de bytes (`bytes`) que contiene el contenido del archivo a subir - un "objeto de archivo" (subclase de `io.BufferedIOBase`), generalmente obtenido con `open(path, "rb")`. Debe admitir los métodos `seek()` y `tell()`. **Excepciones:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si `path_or_fileobj` no es uno de `str`, `Path`, `bytes` o `io.BufferedIOBase`. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si `path_or_fileobj` es un `str` o un `Path` pero no es una ruta a un archivo existente. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Si `path_or_fileobj` es un `io.BufferedIOBase` pero no admite tanto `seek()` como `tell()`. Estructura de datos que contiene la información necesaria para subir un archivo a un repositorio en el Hub. #### as_file[[huggingface_hub.CommitOperationAdd.as_file]] ```python as_file(with_tqdm: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L223) **Parámetros:** with_tqdm (`bool`, *opcional*, valor predeterminado `False`) : Si es True, iterar sobre el objeto de archivo mostrará una barra de progreso. Solo funciona si el objeto similar a un archivo es una ruta a un archivo. No se admiten bytes puros ni búferes. Un gestor de contexto que devuelve un objeto similar a un archivo que permite leer los datos subyacentes de `path_or_fileobj`. Ejemplo: ```python >>> operation = CommitOperationAdd( ... path_in_repo="remote/dir/weights.h5", ... path_or_fileobj="./local/weights.h5", ... ) CommitOperationAdd(path_in_repo='remote/dir/weights.h5', path_or_fileobj='./local/weights.h5') >>> with operation.as_file() as file: ... content = file.read() >>> with operation.as_file(with_tqdm=True) as file: ... while True: ... data = file.read(1024) ... if not data: ... break config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s] >>> with operation.as_file(with_tqdm=True) as file: ... httpx2.put(..., data=file) config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s] ``` #### b64content[[huggingface_hub.CommitOperationAdd.b64content]] ```python b64content() ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L275) El contenido codificado en base64 de `path_or_fileobj` Devuelve: `bytes` #### huggingface_hub.CommitOperationDelete[[huggingface_hub.CommitOperationDelete]] ```python huggingface_hub.CommitOperationDelete(path_in_repo: str, is_folder: typing.Union[bool, typing.Literal['auto']] = 'auto') ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L56) **Parámetros:** path_in_repo (`str`) : Ruta de archivo relativa en el repositorio, por ejemplo: `"checkpoints/1fec34a/weights.bin"` para un archivo o `"checkpoints/1fec34a/"` para una carpeta. is_folder (`bool` o `Literal["auto"]`, *opcional*) : Si la operación de eliminación se aplica a una carpeta o no. Si es "auto", el tipo de ruta (archivo o carpeta) se infiere automáticamente comprobando si la ruta termina con "/" (carpeta) o no (archivo). Para establecer explícitamente el tipo de ruta, puede configurar `is_folder=True` o `is_folder=False`. Estructura de datos que contiene la información necesaria para eliminar un archivo o una carpeta de un repositorio en el Hub. #### huggingface_hub.CommitOperationCopy[[huggingface_hub.CommitOperationCopy]] ```python huggingface_hub.CommitOperationCopy(src_path_in_repo: str, path_in_repo: str, src_revision: str | None = None, src_repo_id: str | None = None, src_repo_type: str | None = None, _src_oid: str | None = None, _dest_oid: str | None = None, _is_duplicated: bool = False) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L87) **Parámetros:** src_path_in_repo (`str`) : Ruta de archivo relativa en el repositorio del archivo que se va a copiar, p. ej. `"checkpoints/1fec34a/weights.bin"`. path_in_repo (`str`) : Ruta de archivo relativa en el repositorio donde copiar el archivo, p. ej. `"checkpoints/1fec34a/weights_copy.bin"`. src_revision (`str`, *opcional*) : La revisión git del archivo que se copiará. Puede ser cualquier revisión git válida. Por defecto, se usa la revisión del commit de destino. src_repo_id (`str`, *opcional*) : El repositorio de origen del que copiar (p. ej. `"username/source-model"`). Por defecto, el repositorio de destino (copia intra-repo). src_repo_type (`str`, *opcional*) : El tipo del repositorio de origen (`"model"`, `"dataset"` o `"space"`). Obligatorio cuando se establece `src_repo_id`. Estructura de datos que contiene la información necesaria para copiar un archivo en un repositorio en el Hub. Se admiten tanto archivos LFS como archivos regulares. Los archivos LFS se copian en el servidor, mientras que los archivos regulares se descargan y se vuelven a subir como parte del commit. Las copias entre repositorios se admiten configurando `src_repo_id` y `src_repo_type`. En el caso de copias LFS entre repositorios, los objetos LFS se duplican en el repositorio de destino antes de crear el commit. Esto se gestiona automáticamente mediante [create_commit()](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi.create_commit). Tenga en cuenta que las copias entre repositorios solo funcionan dentro de la misma [región de almacenamiento](https://huggingface.co/docs/hub/storage-regions); no se admite la copia entre regiones. Nota: puede combinar un [CommitOperationCopy](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitOperationCopy) y un [CommitOperationDelete](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitOperationDelete) para renombrar un archivo LFS en el Hub. ## CommitScheduler[[huggingface_hub.CommitScheduler]] #### huggingface_hub.CommitScheduler[[huggingface_hub.CommitScheduler]] ```python huggingface_hub.CommitScheduler(repo_id: str, folder_path: str | pathlib.Path, every: int | float = 5, path_in_repo: str | None = None, repo_type: str | None = None, revision: str | None = None, private: bool | None = None, token: str | None = None, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, squash_history: bool = False, hf_api: typing.Optional[ForwardRef('HfApi')] = None) ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L30) **Parámetros:** repo_id (`str`) : El id del repositorio al que se va a hacer el commit. folder_path (`str` o `Path`) : Ruta a la carpeta local que se subirá periódicamente. every (`int` o `float`, *opcional*) : El número de minutos entre cada commit. El valor predeterminado es 5 minutos. path_in_repo (`str`, *opcional*) : Ruta relativa del directorio en el repositorio, por ejemplo: `"checkpoints/"`. Por defecto, es la carpeta raíz del repositorio. repo_type (`str`, *opcional*) : El tipo de repositorio al que se va a realizar el commit. El valor predeterminado es `model`. revision (`str`, *opcional*) : La revisión del repositorio a la que se realizará el commit. El valor predeterminado es `main`. private (`bool`, *opcional*) : Si se debe hacer el repositorio privado. Si es `None` (predeterminado), el repositorio será público a menos que el valor predeterminado de la organización sea privado. Este valor se ignora si el repositorio ya existe. token (`str`, *opcional*) : El token que se usará para confirmar en el repositorio. Por defecto, se usa el token guardado en la máquina. allow_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, solo se suben los archivos que coincidan con al menos un patrón. ignore_patterns (`list[str]` o `str`, *opcional*) : Si se proporciona, los archivos que coincidan con alguno de los patrones no se subirán. squash_history (`bool`, *opcional*) : Si se debe comprimir el historial del repositorio después de cada commit. El valor predeterminado es `False`. Comprimir los commits es útil para evitar un deterioro del rendimiento en el repositorio cuando este crece demasiado. hf_api (`HfApi`, *opcional*) : El cliente [HfApi](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.HfApi) que se usará para hacer commit en el Hub. Puede configurarse con ajustes personalizados (user agent, token, ...). Programador para subir una carpeta local al Hub a intervalos regulares (p. ej., enviar al hub cada 5 minutos). La forma recomendada de usar el programador es utilizarlo como un gestor de contexto. Esto garantiza que el programador se detenga correctamente y que se active el último commit cuando el script termina. El programador también se puede detener manualmente con el método `stop`. Consulta la [guía de carga](https://huggingface.co/docs/huggingface_hub/guides/upload#scheduled-uploads) para aprender más sobre cómo usarlo. Ejemplo: ```py >>> from pathlib import Path >>> from huggingface_hub import CommitScheduler # Scheduler uploads every 10 minutes >>> csv_path = Path("watched_folder/data.csv") >>> CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path=csv_path.parent, every=10) >>> with csv_path.open("a") as f: ... f.write("first line") # Some time later (...) >>> with csv_path.open("a") as f: ... f.write("second line") ``` Ejemplo usando un administrador de contexto: ```py >>> from pathlib import Path >>> from huggingface_hub import CommitScheduler >>> with CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path="watched_folder", every=10) as scheduler: ... csv_path = Path("watched_folder/data.csv") ... with csv_path.open("a") as f: ... f.write("first line") ... (...) ... with csv_path.open("a") as f: ... f.write("second line") # Scheduler is now stopped and last commit have been triggered ``` #### push_to_hub[[huggingface_hub.CommitScheduler.push_to_hub]] ```python push_to_hub() ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L204) Sube la carpeta al Hub y devuelve la información del commit. > [!WARNING] > Este método no está diseñado para ser llamado directamente. Se ejecuta en segundo plano por el programador, respetando un mecanismo de cola para evitar commits concurrentes. Hacer una llamada directa al método podría provocar problemas de concurrencia. El comportamiento predeterminado de `push_to_hub` es asumir una carpeta de solo adición. Enumera todos los archivos de la carpeta y solo sube los archivos modificados. Si no se encuentran cambios, el método devuelve sin confirmar nada. Si deseas cambiar este comportamiento, puedes heredar de [CommitScheduler](/docs/huggingface_hub/v2.4.0/es/package_reference/hf_api#huggingface_hub.CommitScheduler) y sobrescribir este método. Esto puede ser útil, por ejemplo, para comprimir los datos juntos en un solo archivo antes de confirmar. Para más detalles y ejemplos, consulta nuestra [guía de integración](https://huggingface.co/docs/huggingface_hub/main/en/guides/upload#scheduled-uploads). #### stop[[huggingface_hub.CommitScheduler.stop]] ```python stop() ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L157) Detenga el programador. Un programador detenido no se puede reiniciar. Principalmente para fines de pruebas. #### disparador[[huggingface_hub.CommitScheduler.trigger]] ```python trigger() ``` [Fuente](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L181) Disparar un `push_to_hub` y devolver un futuro. Este método se llama automáticamente cada `every` minutos. También puedes llamarlo manualmente para activar un commit de inmediato, sin esperar al próximo commit programado.