Hugging Face's logo

Transformers documentation

Extracción de características

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

Extracción de características

Un extractor de características se encarga de preparar las características de entrada para los modelos de audio. Esto incluye la extracción de características de secuencias, por ejemplo, el preprocesamiento de archivos de audio para generar características de Espectrograma Log-Mel, y la conversión a tensores de NumPy y PyTorch.

FeatureExtractionMixin

clase transformers.FeatureExtractionMixin

< >

( **kwargs )

Esta es una mezcla de extracción de características que se utiliza para proporcionar funcionalidad de guardado/carga para extractores de características secuenciales y de audio.

from_pretrained

< >

( pretrained_model_name_or_path: str | os.PathLikecache_dir: str | os.PathLike | None = Noneforce_download: bool = Falselocal_files_only: bool = Falsetoken: str | bool | None = Nonerevision: str = 'main'**kwargs )

Parámetros

  • pretrained_model_name_or_path (str o os.PathLike) — Puede ser:
    • una cadena, el model id de un feature_extractor preentrenado alojado en un repositorio de modelos en huggingface.co.
    • una ruta a un directorio que contenga un archivo de extractor de características guardado usando el método save_pretrained(), por ejemplo, ./my_model_directory/.
    • una ruta a un archivo JSON de extractor de características guardado, archivo, p. ej., ./my_model_directory/preprocessor_config.json.
  • cache_dir (str o os.PathLike, opcional) — Ruta a un directorio en el que se debe almacenar en caché el extractor de características de un modelo preentrenado descargado si no se debe utilizar la caché estándar.
  • force_download (bool, opcional, valor predeterminado False) — Indica si se debe forzar la (re)descarga de los archivos del extractor de características y sobrescribir las versiones en caché si existen.
  • proxies (dict[str, str], opcional) — Un diccionario de servidores proxy a utilizar por protocolo o punto de acceso, p. ej., {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Los proxies se utilizan en cada solicitud.
  • token (str o bool, opcional) — El token que se usará como autorización HTTP bearer para archivos remotos. Si es True, o no se especifica, se usará el token generado al ejecutar hf auth login (almacenado en ~/.huggingface).
  • revision (str, opcional, valor predeterminado "main") — La versión específica del modelo que se va a utilizar. Puede ser el nombre de una rama, el nombre de una etiqueta o un id de commit, ya que utilizamos un sistema basado en git para almacenar modelos y otros artefactos en huggingface.co, por lo que revision puede ser cualquier identificador permitido por git.

Instancie un tipo de FeatureExtractionMixin a partir de un extractor de características, por ejemplo, una clase derivada de SequenceFeatureExtractor.

Ejemplos:

# We can't instantiate directly the base class *FeatureExtractionMixin* nor *SequenceFeatureExtractor* so let's show the examples on a
# derived class: *Wav2Vec2FeatureExtractor*
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained(
    "facebook/wav2vec2-base-960h"
)  # Download feature_extraction_config from huggingface.co and cache.
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained(
    "./test/saved_model/"
)  # E.g. feature_extractor (or model) was saved using *save_pretrained('./test/saved_model/')*
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained("./test/saved_model/preprocessor_config.json")
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained(
    "facebook/wav2vec2-base-960h", return_attention_mask=False, foo=False
)
assert feature_extractor.return_attention_mask is False
feature_extractor, unused_kwargs = Wav2Vec2FeatureExtractor.from_pretrained(
    "facebook/wav2vec2-base-960h", return_attention_mask=False, foo=False, return_unused_kwargs=True
)
assert feature_extractor.return_attention_mask is False
assert unused_kwargs == {"foo": False}

save_pretrained

< >

( save_directory: str | os.PathLikepush_to_hub: bool = False**kwargs )

Parámetros

  • save_directory (str o os.PathLike) — Directorio donde se guardará el archivo JSON del extractor de características (se creará si no existe).
  • push_to_hub (bool, opcional, valor predeterminado False) — Indica si se debe subir el modelo al hub de modelos de Hugging Face después de guardarlo. Puedes especificar el repositorio al que deseas subirlo con repo_id (por defecto, usará el nombre de save_directory en tu espacio de nombres).
  • kwargs (dict[str, Any], opcional) — Argumentos de palabra clave adicionales que se pasan al método push_to_hub().

Guarde un objeto feature_extractor en el directorio save_directory para que pueda recargarse mediante el método de clase from_pretrained().

SequenceFeatureExtractor

clase transformers.SequenceFeatureExtractor

< >

( feature_size: intsampling_rate: intpadding_value: float**kwargs )

Parámetros

  • feature_size (int) — La dimensión de las características de las características extraídas.
  • sampling_rate (int) — La tasa de muestreo a la que deben digitalizarse los archivos de audio, expresada en hercios (Hz).
  • padding_value (float) — El valor que se utiliza para rellenar los valores / vectores de relleno.

Esta es una clase general de extracción de características para el reconocimiento de voz.

pad

< >

( processed_features: transformers.feature_extraction_utils.BatchFeature | list[transformers.feature_extraction_utils.BatchFeature] | dict[str, transformers.feature_extraction_utils.BatchFeature] | dict[str, list[transformers.feature_extraction_utils.BatchFeature]] | list[dict[str, transformers.feature_extraction_utils.BatchFeature]]padding: bool | str | transformers.utils.generic.PaddingStrategy = Truemax_length: int | None = Nonetruncation: bool = Falsepad_to_multiple_of: int | None = Nonereturn_attention_mask: bool | None = Nonereturn_tensors: str | transformers.utils.generic.TensorType | None = None )

Parámetros

  • processed_features (BatchFeature, lista de BatchFeature, dict[str, list[float]], dict[str, list[list[float]] o list[dict[str, list[float]]]) — Entradas procesadas. Puede representar una entrada (BatchFeature o dict[str, list[float]]) o un lote de valores / vectores de entrada (lista de BatchFeature, dict[str, list[list[float]]] o list[dict[str, list[float]]]) de modo que puedes usar este método tanto durante el preprocesamiento como en una función de collate de un Dataloader de PyTorch.

    En lugar de list[float] puede tener tensores (arrays de numpy o tensores de PyTorch), consulte la nota anterior sobre el tipo de retorno.

  • padding (bool, str o PaddingStrategy, opcional, por defecto True) — Seleccione una estrategia para rellenar las secuencias devueltas (según el lado de relleno y el índice de relleno del modelo) entre:
    • True o 'longest': Rellena hasta la secuencia más larga del lote (o no aplica relleno si solo se proporciona una secuencia).
    • 'max_length': Rellena hasta una longitud máxima especificada con el argumento max_length o hasta la longitud de entrada máxima aceptable para el modelo si no se proporciona dicho argumento.
    • False o 'do_not_pad' (predeterminado): Sin relleno (es decir, puede generar un lote con secuencias de diferentes longitudes).
  • max_length (int, opcional) — Longitud máxima de la lista devuelta y, opcionalmente, longitud de relleno (véase arriba).
  • truncation (bool) — Activa la truncación para recortar las secuencias de entrada más largas que max_length a max_length.
  • pad_to_multiple_of (int, opcional) — Si se establece, rellenará la secuencia hasta un múltiplo del valor proporcionado.

    Esto resulta especialmente útil para habilitar el uso de Tensor Cores en hardware de NVIDIA con capacidad de cálculo >= 7.5 (Volta), o en TPUs, que se benefician de que las longitudes de secuencia sean un múltiplo de 128.

  • return_attention_mask (bool, opcional) — Si se debe devolver la máscara de atención. Si se deja en el valor predeterminado, se devolverá la máscara de atención según el valor predeterminado del feature_extractor específico.

    ¿Qué son las máscaras de atención?

  • return_tensors (str o TensorType, opcional) — Si se establece, devolverá tensores en lugar de una lista de enteros de Python. Los valores aceptables son:
    • 'pt': Devuelve objetos torch.Tensor de PyTorch.
    • 'np': Devuelve objetos Numpy np.ndarray.

Rellena los valores de entrada / vectores de entrada o un lote de valores de entrada / vectores de entrada hasta la longitud predefinida o hasta la longitud máxima de secuencia del lote.

Los valores de relleno (izquierda/derecha) se definen a nivel del extractor de características (con self.padding_side, self.padding_value)

Si las processed_features pasadas son un diccionario de arrays de numpy o tensores de PyTorch, el resultado usará el mismo tipo, a menos que proporciones un tipo de tensor diferente con return_tensors. En el caso de los tensores de PyTorch, sin embargo, perderás el dispositivo específico de tus tensores.

BatchFeature

clase transformers.BatchFeature

< >

( data: dict[str, typing.Any] | None = Nonetensor_type: None | str | transformers.utils.generic.TensorType = Noneskip_tensor_conversion: list[str] | set[str] | None = None )

Parámetros

  • data (dict, opcional) — Diccionario de listas/arrays/tensores devueltos por los métodos call/pad (‘input_values’, ‘attention_mask’, etc.).
  • tensor_type (Union[None, str, TensorType], opcional) — Puede indicar un tensor_type aquí para convertir las listas de enteros en Tensors de PyTorch/Numpy durante la inicialización.
  • skip_tensor_conversion (list[str] o set[str], opcional) — Lista o conjunto de claves que NO deben convertirse en tensores, incluso cuando se especifica tensor_type.

Contiene la salida de los métodos pad() y __call__ específicos del extractor de características.

Esta clase se deriva de un diccionario de Python y puede usarse como un diccionario.

convert_to_tensors

< >

( tensor_type: str | transformers.utils.generic.TensorType | None = Noneskip_tensor_conversion: list[str] | set[str] | None = None )

Parámetros

  • tensor_type (str o TensorType, opcional) — El tipo de tensores a utilizar. Si es str, debe ser uno de los valores del enum TensorType. Si es None, no se realiza ninguna modificación.
  • skip_tensor_conversion (list[str] o set[str], opcional) — Lista o conjunto de claves que NO deben convertirse en tensores, incluso cuando se especifica tensor_type.

Convierte el contenido interno en tensores.

Nota: Los valores que no tienen una estructura similar a un array (p. ej., cadenas, diccionarios, listas de cadenas) se omiten automáticamente y no se convierten en tensores. Se intenta convertir los arrays irregulares (listas de arrays con longitudes diferentes), aunque pueden generar errores durante la conversión.

hasta

< >

( *args**kwargs ) → BatchFeature

Parámetros

  • args (Tuple) — Se pasará a la función to(...) de los tensores.
  • kwargs (Dict, opcional) — Se pasará a la función to(...) de los tensores. Para habilitar la transferencia de datos asíncrona, establezca la bandera non_blocking en kwargs (el valor predeterminado es False).

Devuelve

BatchFeature

La misma instancia después de la modificación.

Envía todos los valores al dispositivo llamando a v.to(*args, **kwargs) (solo PyTorch). Esto debería admitir el cambio a diferentes dtypes y enviar el BatchFeature a un device diferente.

ImageFeatureExtractionMixin

clase transformers.ImageFeatureExtractionMixin

< >

( )

Mixin que contiene utilidades para preparar características de imagen.

center_crop

< >

( imagesize ) → new_image

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor de forma (n_channels, height, width) o (height, width, n_channels)) — La imagen que se debe redimensionar.
  • size (int o tuple[int, int]) — El tamaño al que recortar la imagen.

Devuelve

new_image

Un PIL.Image.Image o np.ndarray o torch.Tensor recortado al centro de forma: (n_channels, height, width).

Recorta la image al tamaño indicado mediante un recorte central. Ten en cuenta que si la imagen es demasiado pequeña para recortarla al tamaño indicado, se rellenará (de modo que el resultado devuelto tenga el tamaño solicitado).

convert_rgb

< >

( image )

Parámetros

  • image (PIL.Image.Image) — La imagen a convertir.

Convierte PIL.Image.Image al formato RGB.

expand_dims

< >

( image )

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor) — La imagen que se va a expandir.

Expande la image de 2 dimensiones a 3 dimensiones.

flip_channel_order

< >

( image )

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor) — La imagen cuyos canales de color se deben invertir. Si es np.ndarray o torch.Tensor, la dimensión de canal debe ser la primera.

Flips the channel order of image from RGB to BGR, or vice versa. Note that this will trigger a conversion of image to a NumPy array if it’s a PIL Image.

normalize

< >

( imagemeanstdrescale = False )

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor) — La imagen a normalizar.
  • mean (list[float] o np.ndarray o torch.Tensor) — La media (por canal) a utilizar para la normalización.
  • std (list[float] o np.ndarray o torch.Tensor) — La desviación estándar (por canal) que se utilizará para la normalización.
  • rescale (bool, opcional, valor predeterminado False) — Indica si se debe reescalar la imagen para que esté entre 0 y 1. Si se proporciona una imagen PIL, el reescalado se realizará automáticamente.

Normalizes image with mean and std. Note that this will trigger a conversion of image to a NumPy array if it’s a PIL Image.

rescale

< >

( image: ndarrayscale: float | int )

Escalar una imagen de numpy por una cantidad de escala

resize

< >

( imagesizeresample = Nonedefault_to_square = Truemax_size = None ) → image

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor) — La imagen que se debe redimensionar.
  • size (int o tuple[int, int]) — El tamaño que se usará para redimensionar la imagen. Si size es una secuencia como (h, w), el tamaño de salida se ajustará a este valor.

    Si size es un int y default_to_square es True, la imagen se redimensionará a (size, size). Si size es un int y default_to_square es False, el lado más corto de la imagen se ajustará a este número. Es decir, si height > width, la imagen se reescalará a (size * height / width, size).

  • resample (int, opcional, valor predeterminado PILImageResampling.BILINEAR) — El filtro que se usa para el remuestreo.
  • default_to_square (bool, opcional, valor predeterminado True) — Cómo convertir size cuando es un solo int. Si se establece en True, size se convertirá en un cuadrado (size,size). Si se establece en False, replicará torchvision.transforms.Resize con soporte para redimensionar solo el borde más pequeño y proporcionando un max_size opcional.
  • max_size (int, opcional, valor predeterminado None) — El valor máximo permitido para el lado más largo de la imagen redimensionada: si el lado más largo de la imagen es mayor que max_size después de ser redimensionada según size, la imagen se redimensiona de nuevo para que el lado más largo sea igual a max_size. Como resultado, size puede verse anulado, es decir, el lado más corto puede ser más corto que size. Solo se utiliza si default_to_square es False.

Devuelve

image

Una PIL.Image.Image redimensionada.

Redimensiona image. Fuerza la conversión de la entrada a PIL.Image.

rotate

< >

( imageangleresample = Noneexpand = 0center = Nonetranslate = Nonefillcolor = None ) → image

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor) — La imagen que se va a rotar. Si es np.ndarray o torch.Tensor, se convertirá a PIL.Image.Image antes de rotarla.

Devuelve

image

Una PIL.Image.Image rotada.

Devuelve una copia rotada de image. Este método devuelve una copia de image, rotada el número de grados indicado en sentido antihorario alrededor de su centro.

to_numpy_array

< >

( imagerescale = Nonechannel_first = True )

Parámetros

  • image (PIL.Image.Image o np.ndarray o torch.Tensor) — La imagen que se convertirá en un array de NumPy.
  • rescale (bool, opcional) — Indica si se debe aplicar el factor de escalado (para que los valores de píxeles sean flotantes entre 0. y 1.). Por defecto será True si la imagen es una imagen PIL o un array/tensor de enteros, y False en caso contrario.
  • channel_first (bool, opcional, valor predeterminado True) — Si se deben o no permutar las dimensiones de la imagen para colocar la dimensión de canal al principio.

Convierte image en un array de numpy. Opcionalmente, lo reescala y coloca la dimensión de canal como la primera dimensión.

to_pil_image

< >

( imagerescale = None )

Parámetros

  • image (PIL.Image.Image o numpy.ndarray o torch.Tensor) — La imagen que se convertirá al formato PIL Image.
  • rescale (bool, opcional) — Indica si se debe aplicar el factor de escala (para que los valores de píxeles sean enteros entre 0 y 255). El valor predeterminado será True si el tipo de imagen es de punto flotante, y False en caso contrario.

Converts image to a PIL Image. Optionally rescales it and puts the channel dimension back as the last axis if needed.

Update on GitHub

←ExecuTorch Procesador de imágenes→