AutoProcessor

AutoProcessor

class transformers.AutoProcessor

<source>

( )

This is a generic processor class that will be instantiated as one of the processor classes of the library when created with the AutoProcessor.from_pretrained() class method.

This class cannot be instantiated directly using __init__() (throws an error).

from_pretrained

<source>

( pretrained_model_name_or_path**kwargs )

Parameters

• pretrained_model_name_or_path (str or os.PathLike) — This can be either:

  • a string, the model id of a pretrained feature_extractor hosted inside a model repo on huggingface.co. Valid model ids can be located at the root-level, like bert-base-uncased, or namespaced under a user or organization name, like dbmdz/bert-base-german-cased.

  • a path to a directory containing a processor files saved using the save_pretrained() method, e.g., ./my_model_directory/.

• cache_dir (str or os.PathLike, optional) — Path to a directory in which a downloaded pretrained model feature extractor should be cached if the standard cache should not be used.

• force_download (bool, optional, defaults to False) — Whether or not to force to (re-)download the feature extractor files and override the cached versions if they exist.

• resume_download (bool, optional, defaults to False) — Whether or not to delete incompletely received file. Attempts to resume the download if such a file exists.

• proxies (Dict[str, str], optional) — A dictionary of proxy servers to use by protocol or endpoint, e.g., {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}. The proxies are used on each request.

• token (str or bool, optional) — The token to use as HTTP bearer authorization for remote files. If True, will use the token generated when running huggingface-cli login (stored in ~/.huggingface).

• revision (str, optional, defaults to "main") — The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a git-based system for storing models and other artifacts on huggingface.co, so revision can be any identifier allowed by git.

• return_unused_kwargs (bool, optional, defaults to False) — If False, then this function returns just the final feature extractor object. If True, then this functions returns a Tuple(feature_extractor, unused_kwargs) where unused_kwargs is a dictionary consisting of the key/value pairs whose keys are not feature extractor attributes: i.e., the part of kwargs which has not been used to update feature_extractor and is otherwise ignored.

• trust_remote_code (bool, optional, defaults to False) — Whether or not to allow for custom models defined on the Hub in their own modeling files. This option should only be set to True for repositories you trust and in which you have read the code, as it will execute code present on the Hub on your local machine.

• kwargs (Dict[str, Any], optional) — The values in kwargs of any keys which are feature extractor attributes will be used to override the loaded values. Behavior concerning key/value pairs whose keys are not feature extractor attributes is controlled by the return_unused_kwargs keyword parameter.

Instantiate one of the processor classes of the library from a pretrained model vocabulary.

The processor class to instantiate is selected based on the model_type property of the config object (either passed as an argument or loaded from pretrained_model_name_or_path if possible):

• align — AlignProcessor (ALIGN model)

• altclip — AltCLIPProcessor (AltCLIP model)

• bark — BarkProcessor (Bark model)

• blip — BlipProcessor (BLIP model)

• blip-2 — Blip2Processor (BLIP-2 model)

• bridgetower — BridgeTowerProcessor (BridgeTower model)

• chinese_clip — ChineseCLIPProcessor (Chinese-CLIP model)

• clap — ClapProcessor (CLAP model)

• clip — CLIPProcessor (CLIP model)

• clipseg — CLIPSegProcessor (CLIPSeg model)

• flava — FlavaProcessor (FLAVA model)

• git — GitProcessor (GIT model)

• groupvit — CLIPProcessor (GroupViT model)

• hubert — Wav2Vec2Processor (Hubert model)

• idefics — IdeficsProcessor (IDEFICS model)

• instructblip — InstructBlipProcessor (InstructBLIP model)

• layoutlmv2 — LayoutLMv2Processor (LayoutLMv2 model)

• layoutlmv3 — LayoutLMv3Processor (LayoutLMv3 model)

• markuplm — MarkupLMProcessor (MarkupLM model)

• mctct — MCTCTProcessor (M-CTC-T model)

• mgp-str — MgpstrProcessor (MGP-STR model)

• oneformer — OneFormerProcessor (OneFormer model)

• owlvit — OwlViTProcessor (OWL-ViT model)

• pix2struct — Pix2StructProcessor (Pix2Struct model)

• pop2piano — Pop2PianoProcessor (Pop2Piano model)

• sam — SamProcessor (SAM model)

• sew — Wav2Vec2Processor (SEW model)

• sew-d — Wav2Vec2Processor (SEW-D model)

• speech_to_text — Speech2TextProcessor (Speech2Text model)

• speech_to_text_2 — Speech2Text2Processor (Speech2Text2 model)

• speecht5 — SpeechT5Processor (SpeechT5 model)

• trocr — TrOCRProcessor (TrOCR model)

• tvlt — TvltProcessor (TVLT model)

• unispeech — Wav2Vec2Processor (UniSpeech model)

• unispeech-sat — Wav2Vec2Processor (UniSpeechSat model)

• vilt — ViltProcessor (ViLT model)

• vision-text-dual-encoder — VisionTextDualEncoderProcessor (VisionTextDualEncoder model)

• wav2vec2 — Wav2Vec2Processor (Wav2Vec2 model)

• wav2vec2-conformer — Wav2Vec2Processor (Wav2Vec2-Conformer model)

• wavlm — Wav2Vec2Processor (WavLM model)

• whisper — WhisperProcessor (Whisper model)

• xclip — XCLIPProcessor (X-CLIP model)

Passing token=True is required when you want to use a private model.

Examples:

Copied

>>> from transformers import AutoProcessor

>>> # Download processor from huggingface.co and cache.
>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-base-960h")

>>> # If processor files are in a directory (e.g. processor was saved using *save_pretrained('./test/saved_model/')*)
>>> # processor = AutoProcessor.from_pretrained("./test/saved_model/")

register

<source>

( config_classprocessor_classexist_ok = False )

Parameters

• config_class (PretrainedConfig) — The configuration corresponding to the model to register.

• processor_class (FeatureExtractorMixin) — The processor to register.

Register a new processor for this class.