Devuelve el nivel actual del registrador raíz de HuggingFace Hub.

HuggingFace Hub tiene los siguientes niveles de registro:

• huggingface_hub.logging.CRITICAL, huggingface_hub.logging.FATAL
• huggingface_hub.logging.ERROR
• huggingface_hub.logging.WARNING, huggingface_hub.logging.WARN
• huggingface_hub.logging.INFO
• huggingface_hub.logging.DEBUG

Establece el nivel del registrador raíz de HuggingFace Hub.

Establece la verbosidad en logging.INFO.

Establece la verbosidad en logging.DEBUG.

Establece la verbosidad en logging.WARNING.

Establece la verbosidad en logging.ERROR.

Desactive la propagación de las salidas de registro de la biblioteca. Tenga en cuenta que la propagación de registros está desactivada de forma predeterminada.

Habilite la propagación de las salidas de registro de la biblioteca. Desactive el controlador predeterminado de HuggingFace Hub para evitar el registro duplicado si el registro raíz se ha configurado.

Devuelve un registrador con el nombre especificado. Esta función no está destinada a ser accedida directamente por los usuarios de la biblioteca.

>>> from huggingface_hub import logging

>>> logger = logging.get_logger(__name__)
>>> logging.set_verbosity_info()

Comprueba si las barras de progreso están deshabilitadas globalmente o para un grupo específico.

Esta función devuelve si las barras de progreso están desactivadas para un grupo dado o de forma global. Primero comprueba la variable de entorno HF_HUB_DISABLE_PROGRESS_BARS y luego las configuraciones programáticas.

Desactiva las barras de progreso de forma global o para un grupo especificado.

Esta función actualiza el estado de las barras de progreso en función de un nombre de grupo. Si no se proporciona un nombre de grupo, se desactivan todas las barras de progreso. La operación respeta la configuración de la variable de entorno HF_HUB_DISABLE_PROGRESS_BARS.

Funciona tanto como una llamada regular como como un gestor de contexto: disable_progress_bars() # desactiva hasta enable_progress_bars() with disable_progress_bars(): # desactiva para el bloque, reactiva al salir …

Habilite las barras de progreso de forma global o para un grupo especificado.

Esta función habilita las barras de progreso para el grupo especificado o de forma global si no se especifica ningún grupo. La operación está sujeta a la configuración de entorno HF_HUB_DISABLE_PROGRESS_BARS.

Establezca la fábrica de clientes HTTP que usará huggingface_hub.

La fábrica de clientes es un método que devuelve un objeto httpx2.Client. En la primera llamada a get_session(), la fábrica de clientes se utilizará para crear un nuevo objeto httpx2.Client que se compartirá entre todas las llamadas realizadas por huggingface_hub.

Esto puede ser útil si ejecutas tus scripts en un entorno específico que requiere una configuración personalizada (p. ej., un proxy o certificados personalizados).

Use get_session() para obtener un httpx2.Client correctamente configurado.

Obtenga un objeto httpx2.Client utilizando la fábrica de transporte del usuario.

Este cliente se comparte entre todas las llamadas realizadas por huggingface_hub. Por lo tanto, no debe cerrarse manualmente.

Use set_client_factory() para personalizar el httpx2.Client.

Cierra el httpx2.Client global utilizado por huggingface_hub.

Si un Client se cierra, se volverá a crear en la siguiente llamada a get_session().

Puede ser útil, por ejemplo, si se ha actualizado un certificado SSL.

Establezca la fábrica de clientes HTTP asíncronos que usará huggingface_hub.

La fábrica de clientes asíncronos es un método que devuelve un objeto httpx2.AsyncClient. Esto puede ser útil si ejecutas tus scripts en un entorno específico que requiera una configuración personalizada (p. ej., un proxy o certificados personalizados). Usa get_async_session() para obtener un httpx2.AsyncClient correctamente configurado.

A diferencia del httpx2.Client, que se comparte entre todas las llamadas realizadas por huggingface_hub, el httpx2.AsyncClient no se comparte. Se recomienda usar un gestor de contexto asíncrono para garantizar que el cliente se cierre correctamente al salir del contexto.

Devuelve un objeto httpx2.AsyncClient, utilizando la fábrica de transporte del usuario.

Use set_async_client_factory() para personalizar el httpx2.AsyncClient.

A diferencia del httpx2.Client, que se comparte entre todas las llamadas realizadas por huggingface_hub, el httpx2.AsyncClient no se comparte. Se recomienda usar un gestor de contexto asíncrono para garantizar que el cliente se cierre correctamente al salir del contexto.

Versión interna de response.raise_for_status() que refinará un posible HTTPError. La excepción lanzada será una instancia de HfHubHTTPError.

Este helper está diseñado para ser el método único para raise_for_status al realizar una llamada al Hugging Face Hub.

Se lanza cuando la solicitud ha fallado:

• RepositoryNotFoundError Si no se puede encontrar el repositorio del que se va a descargar. Esto puede deberse a que no existe, a que repo_type no está configurado correctamente o a que el repositorio es private y no tienes acceso.
• GatedRepoError Si el repositorio existe pero está restringido y el usuario no está en la lista de autorizados.
• RevisionNotFoundError Si el repositorio existe pero no se pudo encontrar la revisión.
• EntryNotFoundError Si el repositorio existe pero no se pudo encontrar la entrada (p. ej., el archivo solicitado).
• BadRequestError Si la solicitud falló con un error HTTP 400 BadRequest.
• HfHubHTTPError Si la solicitud falló por un motivo no listado anteriormente.

Indica si estamos en modo sin conexión para el Hub.

Cuando el modo sin conexión está habilitado, todas las solicitudes HTTP realizadas con get_session lanzarán una excepción OfflineModeIsEnabled.

from huggingface_hub import is_offline_mode

def list_files(repo_id: str):
    if is_offline_mode():
        ... # list files from local cache (degraded experience but still functional)
    else:
        ... # list files from Hub (complete experience)

HTTPError para heredar en cualquier error HTTP personalizado lanzado en HF Hub.

Cualquier HTTPError se convierte al menos en un HfHubHTTPError. Si el servidor devuelve alguna información, se añadirá al mensaje de error.

Detalles añadidos:

• El ID de solicitud se obtiene de las cabeceras en el siguiente orden de precedencia: “X-Request-Id”, “X-Amzn-Trace-Id”, “X-Amz-Cf-Id”.
• Mensaje de error del servidor de la cabecera “X-Error-Message”.
• Mensaje de error del servidor si se encuentra uno en el cuerpo de la respuesta.

    import httpx2
    from huggingface_hub.utils import get_session, hf_raise_for_status, HfHubHTTPError

    response = get_session().post(...)
    try:
        hf_raise_for_status(response)
    except HfHubHTTPError as e:
        print(str(e)) # formatted message
        e.request_id, e.server_message # details returned by server

        # Complete the error message with additional information once it's raised
        e.append_to_message("
ate_commit` expects the repository to exist.")
        raise

Se lanza al intentar acceder a una URL de hf.co con un nombre de repositorio no válido, o con el nombre de un repositorio privado al que el usuario no tiene acceso.

>>> from huggingface_hub import model_info
>>> model_info("<non_existent_repository>")
(...)
huggingface_hub.errors.RepositoryNotFoundError: 401 Client Error. (Request ID: PvMw_VjBMjVdMz53WKIzP)

Repository Not Found for url: https://huggingface.co/api/models/%3Cnon_existent_repository%3E.
Please make sure you specified the correct `repo_id` and `repo_type`.
If the repo is private, make sure you are authenticated and your token has the required permissions.
Invalid username or password.

Se genera al intentar acceder a un repositorio con acceso restringido para el cual el usuario no está en la lista de autorizados.

Nota: deriva de RepositoryNotFoundError para garantizar la compatibilidad hacia atrás.

>>> from huggingface_hub import model_info
>>> model_info("<gated_repository>")
(...)
huggingface_hub.errors.GatedRepoError: 403 Client Error. (Request ID: ViT1Bf7O_026LGSQuVqfa)

Cannot access gated repo for url https://huggingface.co/api/models/ardent-figment/gated-model.
Access to model ardent-figment/gated-model is restricted and you are not in the authorized list.
Visit https://huggingface.co/ardent-figment/gated-model to ask for access.

Se genera al intentar acceder a una URL de hf.co con un repositorio válido pero una revisión no válida.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', 'config.json', revision='<non-existent-revision>')
(...)
huggingface_hub.errors.RevisionNotFoundError: 404 Client Error. (Request ID: Mwhe_c3Kt650GcdKEFomX)

Revision Not Found for url: https://huggingface.co/bert-base-cased/resolve/%3Cnon-existent-revision%3E/config.json.

Se genera mediante HfApi.resolve_revision() cuando una revisión no se puede resolver a un hash de commit: no se pudo acceder al Hub (modo sin conexión, error de conexión, tiempo de espera agotado, caída del Hub, …) y no se encontró ninguna entrada coincidente en la caché local.

Se genera mediante hf_raise_for_status cuando el servidor devuelve un error HTTP 400.

>>> resp = httpx2.post("hf.co/api/check", ...)
>>> hf_raise_for_status(resp, endpoint_name="check")
huggingface_hub.errors.BadRequestError: Bad request for check endpoint: {details} (Request ID: XXX)

Se genera cuando la entrada no se encuentra, ya sea local o remotamente.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', '<non-existent-file>')
(...)
huggingface_hub.errors.RemoteEntryNotFoundError (...)
>>> hf_hub_download('bert-base-cased', '<non-existent-file>', local_files_only=True)
(...)
huggingface_hub.utils.errors.LocalEntryNotFoundError (...)

Se lanza al intentar acceder a una URL de hf.co con un repositorio y una revisión válidos, pero con un nombre de archivo no válido.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', '<non-existent-file>')
(...)
huggingface_hub.errors.EntryNotFoundError: 404 Client Error. (Request ID: 53pNl6M0MxsnG5Sw8JA6x)

Entry Not Found for url: https://huggingface.co/bert-base-cased/resolve/main/%3Cnon-existent-file%3E.

Se genera al intentar acceder a un archivo o instantánea que no está en el disco cuando la red está deshabilitada o no está disponible (problema de conexión). La entrada puede existir en el Hub.

>>> from huggingface_hub import hf_hub_download
>>> hf_hub_download('bert-base-cased', '<non-cached-file>',  local_files_only=True)
(...)
huggingface_hub.errors.LocalEntryNotFoundError: Cannot find the requested files in the disk cache and outgoing traffic has been disabled. To enable hf.co look-ups and downloads online, set 'local_files_only' to False.

Se lanza mediante snapshot_download() cuando no se puede acceder al Hub (sin conexión, problema de conexión o local_files_only=True) y se sabe que la instantánea en caché está incompleta: faltan en la instantánea local algunos de los archivos enumerados en el listado de árbol en caché del repositorio.

Esta es una subclase de LocalEntryNotFoundError por compatibilidad con versiones anteriores.

El atributo snapshot_path contiene la ruta de la instantánea local incompleta, de modo que una biblioteca de nivel inferior pueda localizar los archivos más recientes en caché, aunque se sepa que están incompletos.

Se genera mediante get_cached_repo_tree() cuando no hay un listado de árbol en caché para la revisión solicitada.

La lista del árbol se genera como efecto secundario de snapshot_download().

Se produce cuando se realiza una solicitud pero HF_HUB_OFFLINE=1 está establecido como variable de entorno.

Envía telemetría que ayuda a rastrear el uso de diferentes bibliotecas de HF.

Estos datos de uso nos ayudan a depurar problemas y a priorizar nuevas funciones. Sin embargo, entendemos que no todo el mundo desea compartir información adicional y respetamos su privacidad. Puede deshabilitar la recopilación de telemetría estableciendo HF_HUB_DISABLE_TELEMETRY=1 como variable de entorno. La telemetría también se deshabilita en modo sin conexión (es decir, al establecer HF_HUB_OFFLINE=1).

La recopilación de telemetría se ejecuta en un hilo separado para minimizar el impacto en el usuario.

>>> from huggingface_hub.utils import send_telemetry

# Send telemetry without library information
>>> send_telemetry("ping")

# Send telemetry to subtopic with library information
>>> send_telemetry("gradio/local_link", library_name="gradio", library_version="3.22.1")

# Send telemetry with additional data
>>> send_telemetry(
...     topic="examples",
...     library_name="transformers",
...     library_version="4.26.0",
...     user_agent={"pipeline": "text_classification", "framework": "flax"},
... )

Valida los valores recibidos como argumento para cualquier método público de huggingface_hub.

El objetivo de este decorador es armonizar la validación de argumentos reutilizados en todas partes. De forma predeterminada, se prueban todos los validadores definidos.

Validadores:

• validate_repo_id(): repo_id debe ser "repo_name" o "namespace/repo_name". El namespace es un nombre de usuario o una organización.
• ~utils.smoothly_deprecate_legacy_arguments: Ignorar proxies al descargar archivos (debe configurarse de forma global).

>>> from huggingface_hub.utils import validate_hf_hub_args

>>> @validate_hf_hub_args
... def my_cool_method(repo_id: str):
...     print(repo_id)

>>> my_cool_method(repo_id="valid_repo_id")
valid_repo_id

>>> my_cool_method("other..repo..id")
huggingface_hub.utils._validators.HFValidationError: Cannot have -- or .. in repo_id: 'other..repo..id'.

>>> my_cool_method(repo_id="other..repo..id")
huggingface_hub.utils._validators.HFValidationError: Cannot have -- or .. in repo_id: 'other..repo..id'.

Excepción genérica lanzada por los validadores de huggingface_hub.

Hereda de ValueError.

Valida que repo_id sea válido.

Esto no pretende sustituir la validación adecuada realizada en el Hub, sino evitar las inconsistencias locales siempre que sea posible (por ejemplo: pasar repo_type en repo_id está prohibido).

Reglas:

• Entre 1 y 96 caracteres.
• “repo_name” o “namespace/repo_name”
• [a-zA-Z0-9] o ”-”, ”_”, ”.”
• ”—” y “..” están prohibidos

Válido: "foo", "foo/bar", "123", "Foo-BAR_foo.bar123"

No válido: "datasets/foo/bar", ".repo_id", "foo--bar", "foo.git"

>>> from huggingface_hub.utils import validate_repo_id
>>> validate_repo_id(repo_id="valid_repo_id")
>>> validate_repo_id(repo_id="other..repo..id")
huggingface_hub.utils._validators.HFValidationError: Cannot have -- or .. in repo_id: 'other..repo..id'.

Discutido en https://github.com/huggingface/huggingface_hub/issues/1008. En moon-landing (repositorio interno):

• https://github.com/huggingface/moon-landing/blob/main/server/lib/Names.ts#L27
• https://github.com/huggingface/moon-landing/blob/main/server/views/components/NewRepoForm/NewRepoForm.svelte#L138

Deprecar de forma gradual los argumentos heredados en la base de código de huggingface_hub.

Esta función ignora algunos argumentos obsoletos de los kwargs y avisa al usuario de que se ignoran. El objetivo es evitar romper el código existente mientras se guía al usuario hacia la nueva forma de hacer las cosas.

Lista de argumentos obsoletos:

• proxies: Para configurar los proxies, el usuario debe usar la variable de entorno HTTP_PROXY o configurar manualmente el httpx2.Client mediante la función set_client_factory().

  En huggingface_hub 0.x, proxies era un diccionario que se pasaba directamente a requests.request. Desde huggingface_hub 1.x, ya no se admiten proxies por solicitud. En particular, no es posible configurar proxies a nivel de solicitud. La solución es configurarlo globalmente mediante la función set_client_factory() o mediante la variable de entorno HTTP_PROXY.

  Para más detalles, consulte:

  • https://httpx2.pydantic.dev/advanced/proxies/

• resume_download: obsoleto sin reemplazo. huggingface_hub siempre reanuda las descargas cuando es posible.

• force_filename: obsoleto sin reemplazo. El nombre de archivo siempre es el mismo que en el Hub.

• local_dir_use_symlinks: obsoleto sin reemplazo. La descarga en un directorio local ya no utiliza enlaces simbólicos.