Utilitaires pour les processeurs d'images

Cette page répertorie toutes les fonctions utilitaires utilisées par les processeurs d'images, principalement les transformations fonctionnelles utilisées pour traiter les images.

La plupart de ces éléments ne sont utiles que si vous étudiez le code des processeurs d’images de la bibliothèque.

Transformations d'images

transformers.image_transforms.center_crop

< source >

( image: ndarraysize: tupledata_format: str | transformers.image_utils.ChannelDimension | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Paramètres

image (np.ndarray) — L’image à recadrer.
size (tuple[int, int]) — La taille cible de l'image recadrée.
data_format (str ou ChannelDimension, facultatif) — Le format de la dimension des canaux pour l'image de sortie. Peut être l'un des éléments suivants :
- "channels_first" ou ChannelDimension.FIRST : image au format (num_channels, height, width).
- "channels_last" ou ChannelDimension.LAST : image au format (hauteur, largeur, nombre de canaux). Si non défini, le format déduit de l'image d'entrée sera utilisé.
input_data_format (str ou ChannelDimension, facultatif) — Le format de la dimension des canaux pour l'image d'entrée. Peut être l'un des éléments suivants :
- "channels_first" ou ChannelDimension.FIRST : image au format (num_channels, height, width).
- "channels_last" ou ChannelDimension.LAST : image au format (hauteur, largeur, nombre de canaux). Si non défini, le format déduit de l'image d'entrée sera utilisé.

Retourne

np.ndarray

L'image recadrée.

Effectue un recadrage central de l'image à la size spécifiée. Notez que si l'image est trop petite pour être recadrée à la taille donnée, elle sera rembourrée (le résultat renvoyé sera donc toujours de taille size).

transformers.image_transforms.center_to_corners_format

< source >

( bboxes_center: TensorType )

Convertit les boîtes englobantes du format centre au format coins.

format center : contient la coordonnée du centre de la boîte ainsi que ses dimensions largeur et hauteur (center_x, center_y, width, height) format corners : contient les coordonnées des coins haut-gauche et bas-droite de la boîte (top_left_x, top_left_y, bottom_right_x, bottom_right_y)

transformers.image_transforms.corners_to_center_format

< source >

( bboxes_corners: TensorType )

Convertit les boîtes englobantes du format coins au format centre.

format corners : contient les coordonnées des coins en haut à gauche et en bas à droite de la boîte (top_left_x, top_left_y, bottom_right_x, bottom_right_y) format center : contient la coordonnée du centre de la boîte ainsi que ses dimensions largeur et hauteur (center_x, center_y, width, height)

transformers.image_transforms.id_to_rgb

< source >

( id_map )

Convertit un identifiant unique en couleur RVB.

transformers.image_transforms.normalize

< source >

Paramètres

image (np.ndarray) — L’image à normaliser.
mean (float ou Collection[float]) — La moyenne à utiliser pour la normalisation.
std (float ou Collection[float]) — L'écart-type à utiliser pour la normalisation.
data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image de sortie. Si non défini, le format déduit à partir de l'entrée est utilisé.
input_data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image d'entrée. Si non défini, le format déduit à partir de l'entrée sera utilisé.

Normalise image à l'aide de la moyenne et de l'écart-type spécifiés par mean et std.

image = (image - mean) / std

transformers.image_transforms.pad

< source >

( image: ndarraypadding: int | tuple[int, int] | collections.abc.Iterable[tuple[int, int]]mode: PaddingMode = <PaddingMode.CONSTANT: 'constant'>constant_values: float | collections.abc.Iterable[float] = 0.0data_format: str | transformers.image_utils.ChannelDimension | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Paramètres

image (np.ndarray) — L’image à compléter.
padding (int ou tuple[int, int] ou Iterable[tuple[int, int]]) — Rembourrage à appliquer aux bords des axes de hauteur et de largeur. Peut prendre l'une des trois formes suivantes :
- ((before_height, after_height), (before_width, after_width)) largeurs de bourrage uniques pour chaque axe.
- ((before, after),) génère le même padding avant et après pour la hauteur et la largeur.
- (pad,) ou int est un raccourci pour before = after = pad width pour tous les axes.
mode (PaddingMode) — Le mode de bourrage à utiliser. Peut être l'un des suivants :
- "constant" : remplit avec une valeur constante.
- "reflect" : remplit par la réflexion du vecteur, miroir sur les première et dernière valeurs du vecteur le long de chaque axe.
- "replicate" : remplit en répétant la dernière valeur sur le bord du tableau le long de chaque axe.
- "symmetric" : remplit avec la réflexion du vecteur miroir le long du bord du tableau.
constant_values (float ou Iterable[float], facultatif) — La valeur à utiliser pour le bourrage si mode est "constant".
data_format (str ou ChannelDimension, facultatif) — Le format de la dimension des canaux pour l'image de sortie. Peut être l'un des éléments suivants :
- "channels_first" ou ChannelDimension.FIRST : image au format (num_channels, height, width).
- "channels_last" ou ChannelDimension.LAST : image au format (hauteur, largeur, nombre de canaux). Si non défini, utilise le même format que l'image d'entrée.
input_data_format (str ou ChannelDimension, facultatif) — Le format de la dimension des canaux pour l'image d'entrée. Peut être l'un des éléments suivants :
- "channels_first" ou ChannelDimension.FIRST : image au format (num_channels, height, width).
- "channels_last" ou ChannelDimension.LAST : image au format (hauteur, largeur, nombre de canaux). Si non défini, le format déduit de l'image d'entrée sera utilisé.

Retourne

np.ndarray

L'image rembourrée.

Remplit l'image avec le padding (hauteur, largeur) et le mode spécifiés.

transformers.image_transforms.rgb_to_id

< source >

( color )

Convertit une couleur RGB en identifiant unique.

transformers.image_transforms.rescale

< source >

( image: ndarrayscale: floatdata_format: transformers.image_utils.ChannelDimension | None = Nonedtype: dtype = <class 'numpy.float32'>input_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Paramètres

image (np.ndarray) — L’image à remasquer.
scale (float) — L'échelle à utiliser pour redimensionner l'image.
data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image. S'il n'est pas fourni, il sera identique à celui de l'image d'entrée.
dtype (np.dtype, facultatif, par défaut np.float32) — Le dtype de l'image de sortie. Par défaut, np.float32. Utilisé pour la compatibilité ascendante avec les extracteurs de caractéristiques.
input_data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image d'entrée. S'il n'est pas fourni, il sera déduit de l'image d'entrée.

Retourne

np.ndarray

L'image redimensionnée.

Redimensionne image par scale.

transformers.image_transforms.resize

< source >

( image: ndarraysize: tupleresample: typing.Optional[ForwardRef('PILImageResampling')] = Nonereducing_gap: int | None = Nonedata_format: transformers.image_utils.ChannelDimension | None = Nonereturn_numpy: bool = Trueinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → np.ndarray

Paramètres

image (np.ndarray) — L’image à redimensionner.
size (tuple[int, int]) — La taille à utiliser pour redimensionner l'image.
resample (int, facultatif, par défaut PILImageResampling.BILINEAR) — Le filtre à utiliser pour le rééchantillonnage.
reducing_gap (int, facultatif) — Applique une optimisation en redimensionnant l'image en deux étapes. Plus le reducing_gap est grand, plus le résultat est proche de l'échantillonnage équitable. Consultez la documentation correspondante de Pillow pour plus de détails.
data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image de sortie. Si non défini, le format déduit à partir de l'entrée est utilisé.
return_numpy (bool, facultatif, par défaut True) — Indique s'il faut ou non retourner l'image redimensionnée sous forme de tableau numpy. Si False, un objet PIL.Image.Image est retourné.
input_data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image d'entrée. Si non défini, le format déduit à partir de l'entrée sera utilisé.

Retourne

np.ndarray

L'image redimensionnée.

Redimensionne image en (height, width) spécifié par size à l'aide de la bibliothèque PIL.

transformers.image_transforms.to_pil_image

< source >

( image: typing.Union[numpy.ndarray, ForwardRef('PIL.Image.Image'), ForwardRef('torch.Tensor')]do_rescale: bool | None = Noneimage_mode: str | None = Noneinput_data_format: str | transformers.image_utils.ChannelDimension | None = None ) → PIL.Image.Image

Paramètres

image (PIL.Image.Image ou numpy.ndarray ou torch.Tensor) — L’image à convertir au format PIL.Image.
do_rescale (bool, facultatif) — Indique s'il faut appliquer le facteur d'échelle (pour rendre les valeurs de pixels des entiers compris entre 0 et 255). La valeur par défaut est True si le type d'image est un type à virgule flottante et que le passage en int entraînerait une perte de précision, et False dans le cas contraire.
image_mode (str, facultatif) — Le mode à utiliser pour l’image PIL. S’il n’est pas défini, le mode par défaut du type d’image d’entrée est utilisé.
input_data_format (ChannelDimension, facultatif) — Le format de la dimension des canaux de l'image d'entrée. Si non défini, le format déduit à partir de l'entrée sera utilisé.

Retourne

PIL.Image.Image

L'image convertie.

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

ImageProcessingMixin

classe transformers.ImageProcessingMixin

< source >

( **kwargs )

Il s’agit d’un mixin de processeur d’images utilisé pour fournir la fonctionnalité d’enregistrement/chargement pour les extracteurs de caractéristiques séquentiels et d’images.

fetch_images

< source >

( image_url_or_urls: str | list[str] | list[list[str]] )

Convertit une URL unique ou une liste d'URL en objets PIL.Image correspondants.

Si une seule url est passée, la valeur retournée sera un seul objet. Si une liste est passée, une liste d'objets est retournée.

from_dict

< source >

( image_processor_dict: dict**kwargs ) → ImageProcessingMixin

Paramètres

image_processor_dict (dict[str, Any]) — Dictionnaire qui sera utilisé pour instancier l'objet de processeur d'images. Un tel dictionnaire peut être récupéré à partir d'un point de contrôle préentraîné en utilisant la méthode to_dict().
kwargs (dict[str, Any]) — Paramètres supplémentaires à partir desquels initialiser l'objet de processeur d'images.

Retourne

ImageProcessingMixin

L'objet de processeur d'images instancié à partir de ces paramètres.

Instancie un type de ImageProcessingMixin à partir d'un dictionnaire Python de paramètres.

from_json_file

< source >

( json_file: str | os.PathLike ) → A image processor of type ImageProcessingMixin

Paramètres

json_file (str ou os.PathLike) — Chemin vers le fichier JSON contenant les paramètres.

Retourne

Un processeur d'image de type ImageProcessingMixin

L'objet image_processor instancié à partir de ce fichier JSON.

Instancie un processeur d'image de type ImageProcessingMixin à partir du chemin vers un fichier JSON de paramètres.

from_pretrained

< source >

Paramètres

pretrained_model_name_or_path (str ou os.PathLike) — Cela peut être l'un des éléments suivants :
- une chaîne de caractères, l'identifiant du modèle d'un image_processor préentraîné hébergé dans un dépôt de modèles sur huggingface.co.
- un chemin vers un dossier contenant un fichier de processeur d’images enregistré à l’aide de la méthode save_pretrained(), par exemple ./my_model_directory/.
- un chemin vers un fichier JSON de processeur d’images enregistré fichier, par exemple ./my_model_directory/preprocessor_config.json.
cache_dir (str ou os.PathLike, facultatif) — Chemin vers un répertoire dans lequel un processeur d’images de modèle pré-entraîné téléchargé doit être mis en cache si le cache standard ne doit pas être utilisé.
force_download (bool, facultatif, par défaut False) — Indique s'il faut forcer le (re)téléchargement des fichiers du processeur d'images et remplacer les versions en cache si elles existent.
proxies (dict[str, str], facultatif) — Un dictionnaire de serveurs proxy à utiliser par protocole ou point de terminaison, par exemple {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. Les proxys sont utilisés pour chaque requête.
token (str ou bool, facultatif) — Le jeton à utiliser comme autorisation bearer HTTP pour les fichiers distants. Si True, ou non spécifié, utilisera le jeton généré lors de l’exécution de hf auth login (stocké dans ~/.huggingface).
revision (str, facultatif, par défaut "main") — La version spécifique du modèle à utiliser. Il peut s’agir du nom d’une branche, du nom d’une étiquette ou d’un identifiant de commit, car nous utilisons un système basé sur git pour stocker les modèles et autres artefacts sur huggingface.co, de sorte que revision peut être n’importe quel identifiant autorisé par git.

Instanciez un type de ImageProcessingMixin à partir d'un processeur d'images.

Exemples :

# We can't instantiate directly the base class *ImageProcessingMixin* so let's show the examples on a
# derived class: *CLIPImageProcessor*
image_processor = CLIPImageProcessor.from_pretrained(
    "openai/clip-vit-base-patch32"
)  # Download image_processing_config from huggingface.co and cache.
image_processor = CLIPImageProcessor.from_pretrained(
    "./test/saved_model/"
)  # E.g. image processor (or model) was saved using *save_pretrained('./test/saved_model/')*
image_processor = CLIPImageProcessor.from_pretrained("./test/saved_model/preprocessor_config.json")
image_processor = CLIPImageProcessor.from_pretrained(
    "openai/clip-vit-base-patch32", do_normalize=False, foo=False
)
assert image_processor.do_normalize is False
image_processor, unused_kwargs = CLIPImageProcessor.from_pretrained(
    "openai/clip-vit-base-patch32", do_normalize=False, foo=False, return_unused_kwargs=True
)
assert image_processor.do_normalize is False
assert unused_kwargs == {"foo": False}

get_image_processor_dict

< source >

( pretrained_model_name_or_path: str | os.PathLike**kwargs ) → tuple[Dict, Dict]

Paramètres

pretrained_model_name_or_path (str ou os.PathLike) — L'identifiant du point de contrôle pré-entraîné à partir duquel nous voulons obtenir le dictionnaire des paramètres.
subfolder (str, facultatif, par défaut "") — Si les fichiers pertinents se trouvent dans un sous-dossier du dépôt de modèle sur huggingface.co, vous pouvez spécifier le nom du dossier ici.
image_processor_filename (str, facultatif, par défaut "config.json") — Le nom du fichier dans le répertoire du modèle à utiliser pour la configuration du processeur d'images.

Retourne

tuple[Dict, Dict]

Le(s) dictionnaire(s) qui sera(ont) utilisé(s) pour instancier l'objet de processeur d'images.

À partir de pretrained_model_name_or_path, résout en un dictionnaire de paramètres, à utiliser pour instancier un processeur d’images de type ~image_processor_utils.ImageProcessingMixin à l’aide de from_dict.

push_to_hub

< source >

Paramètres

repo_id (str) — Le nom du dépôt vers lequel vous souhaitez pousser votre image processor. Il doit contenir le nom de votre organisation lors d’une poussée vers une organisation donnée.
commit_message (str, facultatif) — Message à committer lors de la poussée. La valeur par défaut est "Upload image processor".
commit_description (str, facultatif) — La description du commit qui sera créé
private (bool, facultatif) — Indique s'il faut rendre le dépôt privé. Si None (par défaut), le dépôt sera public sauf si le paramètre par défaut de l'organisation est privé. Cette valeur est ignorée si le dépôt existe déjà.
token (bool ou str, facultatif) — Le jeton à utiliser comme autorisation bearer HTTP pour les fichiers distants. Si True (par défaut), le jeton généré lors de l’exécution de hf auth login (stocké dans ~/.huggingface) sera utilisé.
revision (str, facultatif) — Branche vers laquelle pousser les fichiers téléversés.
create_pr (bool, facultatif, par défaut False) — Indique s'il faut créer une PR avec les fichiers téléversés ou effectuer un commit direct.
max_shard_size (int ou str, facultatif, par défaut "50GB") — Applicable uniquement aux modèles. La taille maximale d'un point de contrôle avant son fractionnement. Les points de contrôle fractionnés auront chacun une taille inférieure à cette valeur. S'il est exprimé sous forme de chaîne, il doit être composé de chiffres suivis d'une unité (comme "5MB").
tags (list[str], facultatif) — Liste des tags à pousser sur le Hub.

Téléchargez le fichier du processeur d'images sur le 🤗 Model Hub.

Exemples :

from transformers import AutoImageProcessor

image processor = AutoImageProcessor.from_pretrained("google-bert/bert-base-cased")

# Push the image processor to your namespace with the name "my-finetuned-bert".
image processor.push_to_hub("my-finetuned-bert")

# Push the image processor to an organization with the name "my-finetuned-bert".
image processor.push_to_hub("huggingface/my-finetuned-bert")

register_for_auto_class

< source >

( auto_class = 'AutoImageProcessor' )

Paramètres

auto_class (str ou type, facultatif, par défaut "AutoImageProcessor ") — La classe automatique avec laquelle enregistrer ce nouveau processeur d'images.

Enregistrez cette classe avec une classe auto donnée. Cela ne doit être utilisé que pour les processeurs d’images personnalisés, car ceux de la bibliothèque sont déjà associés à AutoImageProcessor.

save_pretrained

< source >

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

Paramètres

save_directory (str ou os.PathLike) — Répertoire où le fichier JSON du processeur d'images sera enregistré (sera créé s'il n'existe pas).
push_to_hub (bool, facultatif, par défaut False) — Indique s'il faut ou non pousser votre modèle sur le hub de modèles Hugging Face après l'avoir enregistré. Vous pouvez spécifier le dépôt auquel vous souhaitez pousser avec repo_id (par défaut, il s'agit du nom de save_directory dans votre espace de noms).
kwargs (dict[str, Any], facultatif) — Arguments supplémentaires passés à la méthode push_to_hub().

Enregistrer un objet de processeur d’images dans le répertoire save_directory afin qu’il puisse être rechargé à l’aide de la méthode de classe from_pretrained().

to_dict

< source >

( ) → dict[str, Any]

Retourne

dict[str, Any]

Dictionnaire de tous les attributs qui composent cette instance de processeur d'image.

Sérialise cette instance en dictionnaire Python.

to_json_file

< source >

( json_file_path: str | os.PathLike )

Paramètres

json_file_path (str ou os.PathLike) — Chemin du fichier JSON dans lequel les paramètres de cette instance d’image_processor seront enregistrés.

Enregistrez cette instance dans un fichier JSON.

to_json_string

< source >

( ) → str

Retourne

str

Chaîne de caractères contenant tous les attributs qui composent cette instance de feature_extractor au format JSON.

Sérialise cette instance en chaîne JSON.

Update on GitHub

Transformers

Utilitaires pour les processeurs d'images

Transformations d'images

transformers.image_transforms.center_crop

transformers.image_transforms.center_to_corners_format

transformers.image_transforms.corners_to_center_format

transformers.image_transforms.id_to_rgb

transformers.image_transforms.normalize

transformers.image_transforms.pad

transformers.image_transforms.rgb_to_id

transformers.image_transforms.rescale

transformers.image_transforms.resize

transformers.image_transforms.to_pil_image

ImageProcessingMixin

classe transformers.ImageProcessingMixin

fetch_images

from_dict

from_json_file

from_pretrained

get_image_processor_dict

push_to_hub

register_for_auto_class

save_pretrained

to_dict

to_json_file

to_json_string