Transformers documentation

Registro

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Registro

🤗 Transformers tiene un sistema de registro centralizado, por lo que puedes configurar la verbosidad de la biblioteca fácilmente.

Actualmente, el nivel de detalle predeterminado de la biblioteca es WARNING.

Para cambiar el nivel de verbosidad, simplemente use uno de los setters directos. Por ejemplo, así se cambia la verbosidad al nivel INFO.

import transformers

transformers.logging.set_verbosity_info()

También puede usar la variable de entorno TRANSFORMERS_VERBOSITY para anular la verbosidad predeterminada. Puede configurarla con uno de los siguientes valores: debug, info, warning, error, critical, fatal. Por ejemplo:

TRANSFORMERS_VERBOSITY=error ./myprogram.py

Además, algunas warnings se pueden desactivar estableciendo la variable de entorno TRANSFORMERS_NO_ADVISORY_WARNINGS en un valor verdadero, como 1. Esto desactivará cualquier advertencia registrada mediante logger.warning_advice. Por ejemplo:

TRANSFORMERS_NO_ADVISORY_WARNINGS=1 ./myprogram.py

A continuación se muestra un ejemplo de cómo usar el mismo registrador que la biblioteca en su propio módulo o script:

from transformers.utils import logging

logging.set_verbosity_info()
logger = logging.get_logger("transformers")
logger.info("INFO")
logger.warning("WARN")

Todos los métodos de este módulo de registro están documentados a continuación; los principales son logging.get_verbosity() para obtener el nivel de verbosidad actual del registrador y logging.set_verbosity() para establecer la verbosidad en el nivel que desee. En orden (del menos verboso al más verboso), esos niveles (con sus valores int correspondientes entre paréntesis) son:

  • transformers.logging.CRITICAL o transformers.logging.FATAL (valor entero, 50): solo informa sobre los errores más críticos.
  • transformers.logging.ERROR (valor int, 40): solo informa sobre errores.
  • transformers.logging.WARNING o transformers.logging.WARN (valor entero, 30): solo informa sobre errores y advertencias. Este es el nivel predeterminado utilizado por la biblioteca.
  • transformers.logging.INFO (valor int, 20): informa sobre errores, advertencias e información básica.
  • transformers.logging.DEBUG (valor int, 10): informa toda la información.

Por defecto, las barras de progreso de tqdm se mostrarán durante la descarga del modelo. logging.disable_progress_bar() y logging.enable_progress_bar() se pueden usar para suprimir o reactivar este comportamiento.

logging frente a warnings

Python tiene dos sistemas de registro que a menudo se usan en conjunto: logging, que se explica arriba, y warnings, que permite clasificar las advertencias en categorías específicas, por ejemplo, FutureWarning para una función o ruta que ya está en desuso y DeprecationWarning para indicar una futura obsolescencia.

Utilizamos ambos en la biblioteca transformers. Aprovechamos y adaptamos el método captureWarnings de logging para permitir la gestión de estos mensajes de advertencia mediante los configuradores de verbosidad anteriores.

¿Qué significa eso para los desarrolladores de la biblioteca? Deberíamos respetar las siguientes heurísticas:

  • warnings deben ser preferidos por los desarrolladores de la biblioteca y de las bibliotecas dependientes de transformers
  • logging debe usarse para los usuarios finales de la biblioteca que la emplean en proyectos cotidianos

Vea la referencia del método captureWarnings a continuación.

transformers.utils.logging.captureWarnings

< >

( capture )

Llama al método captureWarnings de la biblioteca de registro para habilitar la gestión de las advertencias emitidas por la biblioteca warnings.

Puede leer más sobre este método aquí: https://docs.python.org/3/library/logging.html#integration-with-the-warnings-module

Todas las advertencias se registrarán a través del registrador py.warnings.

Precaución: este método también añade un manejador a este registrador si aún no tiene uno, y actualiza el nivel de registro de ese registrador al del registrador raíz de la biblioteca.

Configuradores base

transformers.utils.logging.set_verbosity_error

< >

( )

Establezca la verbosidad en el nivel ERROR.

transformers.utils.logging.set_verbosity_warning

< >

( )

Establezca la verbosidad en el nivel WARNING.

transformers.utils.logging.set_verbosity_info

< >

( )

Establezca la verbosidad en el nivel INFO.

transformers.utils.logging.set_verbosity_debug

< >

( )

Establezca la verbosidad en el nivel DEBUG.

Otras funciones

transformers.utils.logging.get_verbosity

< >

( ) → int

Devuelve

int

El nivel de registro.

Devuelve el nivel actual del registrador raíz de 🤗 Transformers como un int.

🤗 Transformers tiene los siguientes niveles de registro:

  • 50: transformers.logging.CRITICAL o transformers.logging.FATAL
  • 40: transformers.logging.ERROR
  • 30: transformers.logging.WARNING o transformers.logging.WARN
  • 20: transformers.logging.INFO
  • 10: transformers.logging.DEBUG

transformers.utils.logging.set_verbosity

< >

( verbosity: int )

Parámetros

  • verbosity (int) — Nivel de registro, por ejemplo, uno de:
    • transformers.logging.CRITICAL o transformers.logging.FATAL
    • transformers.logging.ERROR
    • transformers.logging.WARNING o transformers.logging.WARN
    • transformers.logging.INFO
    • transformers.logging.DEBUG

Establece el nivel de verbosidad del registrador raíz de 🤗 Transformers.

transformers.utils.logging.get_logger

< >

( name: str | None = None )

Devuelve un registrador con el nombre especificado.

Esta función no está destinada a ser accedida directamente, a menos que esté escribiendo un módulo personalizado de transformers.

transformers.utils.logging.enable_default_handler

< >

( )

Habilite el controlador predeterminado del registro raíz de HuggingFace Transformers.

transformers.utils.logging.disable_default_handler

< >

( )

Desactive el controlador predeterminado del registro raíz de HuggingFace Transformers.

transformers.utils.logging.enable_explicit_format

< >

( )

Habilita el formato explícito para cada registro de HuggingFace Transformers. El formateador explícito es el siguiente:

    [LEVELNAME|FILENAME|LINE NUMBER] TIME >> MESSAGE
All handlers currently bound to the root logger are affected by this method.

transformers.utils.logging.reset_format

< >

( )

Restablece el formato de los registradores de HuggingFace Transformers.

Todos los manejadores actualmente vinculados al registro principal se ven afectados por este método.

transformers.utils.logging.enable_progress_bar

< >

( )

Activar la barra de progreso de tqdm.

transformers.utils.logging.disable_progress_bar

< >

( )

Desactivar la barra de progreso de tqdm.

Update on GitHub