processors

Processors are used to prepare non-textual inputs (e.g., image or audio) for a model.

Example: Using a WhisperProcessor to prepare an audio input for a model.

import { AutoProcessor, read_audio } from '@huggingface/transformers';

let processor = await AutoProcessor.from_pretrained('openai/whisper-tiny.en');
let audio = await read_audio('https://huggingface.co/datasets/Narsil/asr_dummy/resolve/v3.0.0/mlk.flac', 16000);
let { input_features } = await processor(audio);
// Tensor {
//   data: Float32Array(240000) [0.4752984642982483, 0.5597258806228638, 0.56434166431427, ...],
//   dims: [1, 80, 3000],
//   type: 'float32',
//   size: 240000,
// }

• processors
  • static
    • .FeatureExtractor ⇐ Callable
      • new FeatureExtractor(config)
      • ._call(...args)
    • .ImageFeatureExtractor ⇐ FeatureExtractor
      • new ImageFeatureExtractor(config)
      • .thumbnail(image, size, [resample]) ⇒ Promise.<RawImage>
      • .crop_margin(image, gray_threshold) ⇒ Promise.<RawImage>
      • .pad_image(pixelData, imgDims, padSize, options) ⇒ *
      • .rescale(pixelData) ⇒ void
      • .get_resize_output_image_size(image, size) ⇒ *
      • .resize(image) ⇒ Promise.<RawImage>
      • .preprocess(image, overrides) ⇒ Promise.<PreprocessedImage>
      • ._call(images, ...args) ⇒ Promise.<ImageFeatureExtractorResult>
    • .DetrFeatureExtractor ⇐ ImageFeatureExtractor
      • ._call(images) ⇒ Promise.<DetrFeatureExtractorResult>
      • .post_process_object_detection() : *
      • .post_process_panoptic_segmentation() : *
    • .Processor ⇐ Callable
      • new Processor(feature_extractor)
      • ._call(input, ...args) ⇒ Promise.<any>
    • .WhisperProcessor ⇐ Processor
      • ._call(audio) ⇒ Promise.<any>
    • .AutoProcessor
      • .from_pretrained(pretrained_model_name_or_path, options) ⇒ Promise.<Processor>
    • .data : Float32Array
  • inner
    • ~center_to_corners_format(arr) ⇒ Array.<number>
    • ~post_process_semantic_segmentation(outputs, [target_sizes]) ⇒ *
      • ~labels : Array.<number>
    • ~post_process_panoptic_segmentation(outputs, [threshold], [mask_threshold], [overlap_mask_area_threshold], [label_ids_to_fuse], [target_sizes]) ⇒ Array.<{segmentation: Tensor, segments_info: Array<{id: number, label_id: number, score: number}>}>
    • ~post_process_instance_segmentation(outputs, [threshold], [target_sizes]) ⇒ Array.<{segmentation: Tensor, segments_info: Array<{id: number, label_id: number, score: number}>}>
    • ~enforce_size_divisibility(size, divisor) ⇒ *
    • ~HeightWidth : *
    • ~ImageFeatureExtractorResult : object
    • ~PreprocessedImage : object
    • ~DetrFeatureExtractorResult : object
    • ~SamImageProcessorResult : object

processors.FeatureExtractor ⇐ <code> Callable </code>

Base class for feature extractors.

Kind: static class of processors
Extends: Callable

• .FeatureExtractor ⇐ Callable
  • new FeatureExtractor(config)
  • ._call(...args)

new FeatureExtractor(config)

Constructs a new FeatureExtractor instance.

featureExtractor._call(...args)

This method should be implemented in subclasses to provide the functionality of the callable object.

Kind: instance method of FeatureExtractor
Overrides: _call
Throws:

• Error If the subclass does not implement the `_call` method.

processors.ImageFeatureExtractor ⇐ <code> FeatureExtractor </code>

Feature extractor for image models.

Kind: static class of processors
Extends: FeatureExtractor

• .ImageFeatureExtractor ⇐ FeatureExtractor
  • new ImageFeatureExtractor(config)
  • .thumbnail(image, size, [resample]) ⇒ Promise.<RawImage>
  • .crop_margin(image, gray_threshold) ⇒ Promise.<RawImage>
  • .pad_image(pixelData, imgDims, padSize, options) ⇒ *
  • .rescale(pixelData) ⇒ void
  • .get_resize_output_image_size(image, size) ⇒ *
  • .resize(image) ⇒ Promise.<RawImage>
  • .preprocess(image, overrides) ⇒ Promise.<PreprocessedImage>
  • ._call(images, ...args) ⇒ Promise.<ImageFeatureExtractorResult>

new ImageFeatureExtractor(config)

Constructs a new ImageFeatureExtractor instance.

imageFeatureExtractor.thumbnail(image, size, [resample]) ⇒ <code> Promise. < RawImage > </code>

Resize the image to make a thumbnail. The image is resized so that no dimension is larger than any corresponding dimension of the specified size.

Kind: instance method of ImageFeatureExtractor
Returns: Promise.<RawImage> - The resized image.

imageFeatureExtractor.crop_margin(image, gray_threshold) ⇒ <code> Promise. < RawImage > </code>

Crops the margin of the image. Gray pixels are considered margin (i.e., pixels with a value below the threshold).

Kind: instance method of ImageFeatureExtractor
Returns: Promise.<RawImage> - The cropped image.

imageFeatureExtractor.pad_image(pixelData, imgDims, padSize, options) ⇒ <code> * </code>

Pad the image by a certain amount.

Kind: instance method of ImageFeatureExtractor
Returns: * - The padded pixel data and image dimensions.

imageFeatureExtractor.rescale(pixelData) ⇒ <code> void </code>

Rescale the image’ pixel values by this.rescale_factor.

Kind: instance method of ImageFeatureExtractor

imageFeatureExtractor.get_resize_output_image_size(image, size) ⇒ <code> * </code>

Find the target (width, height) dimension of the output image after resizing given the input image and the desired size.

Kind: instance method of ImageFeatureExtractor
Returns: * - The target (width, height) dimension of the output image after resizing.

imageFeatureExtractor.resize(image) ⇒ <code> Promise. < RawImage > </code>

Resizes the image.

Kind: instance method of ImageFeatureExtractor
Returns: Promise.<RawImage> - The resized image.

imageFeatureExtractor.preprocess(image, overrides) ⇒ <code> Promise. < PreprocessedImage > </code>

Preprocesses the given image.

Kind: instance method of ImageFeatureExtractor
Returns: Promise.<PreprocessedImage> - The preprocessed image.

imageFeatureExtractor._call(images, ...args) ⇒ <code> Promise. < ImageFeatureExtractorResult > </code>

Calls the feature extraction process on an array of images, preprocesses each image, and concatenates the resulting features into a single Tensor.

Kind: instance method of ImageFeatureExtractor
Returns: Promise.<ImageFeatureExtractorResult> - An object containing the concatenated pixel values (and other metadata) of the preprocessed images.

processors.DetrFeatureExtractor ⇐ <code> ImageFeatureExtractor </code>

Detr Feature Extractor.

Kind: static class of processors
Extends: ImageFeatureExtractor

• .DetrFeatureExtractor ⇐ ImageFeatureExtractor
  • ._call(images) ⇒ Promise.<DetrFeatureExtractorResult>
  • .post_process_object_detection() : *
  • .post_process_panoptic_segmentation() : *

detrFeatureExtractor._call(images) ⇒ <code> Promise. < DetrFeatureExtractorResult > </code>

Calls the feature extraction process on an array of images, preprocesses each image, and concatenates the resulting features into a single Tensor.

Kind: instance method of DetrFeatureExtractor
Returns: Promise.<DetrFeatureExtractorResult> - An object containing the concatenated pixel values of the preprocessed images.

detrFeatureExtractor.post_process_object_detection() : <code> * </code>

Kind: instance method of DetrFeatureExtractor

detrFeatureExtractor.post_process_panoptic_segmentation() : <code> * </code>

Kind: instance method of DetrFeatureExtractor

processors.Processor ⇐ <code> Callable </code>

Represents a Processor that extracts features from an input.

Kind: static class of processors
Extends: Callable

• .Processor ⇐ Callable
  • new Processor(feature_extractor)
  • ._call(input, ...args) ⇒ Promise.<any>

new Processor(feature_extractor)

Creates a new Processor with the given feature extractor.

processor._call(input, ...args) ⇒ <code> Promise. < any > </code>

Calls the feature_extractor function with the given input.

Kind: instance method of Processor
Overrides: _call
Returns: Promise.<any> - A Promise that resolves with the extracted features.

processors.WhisperProcessor ⇐ <code> Processor </code>

Represents a WhisperProcessor that extracts features from an audio input.

Kind: static class of processors
Extends: Processor

whisperProcessor._call(audio) ⇒ <code> Promise. < any > </code>

Calls the feature_extractor function with the given audio input.

Kind: instance method of WhisperProcessor
Returns: Promise.<any> - A Promise that resolves with the extracted features.

processors.AutoProcessor

Helper class which is used to instantiate pretrained processors with the from_pretrained function. The chosen processor class is determined by the type specified in the processor config.

Example: Load a processor using from_pretrained.

let processor = await AutoProcessor.from_pretrained('openai/whisper-tiny.en');

Example: Run an image through a processor.

let processor = await AutoProcessor.from_pretrained('Xenova/clip-vit-base-patch16');
let image = await RawImage.read('https://huggingface.co/datasets/Xenova/transformers.js-docs/resolve/v3.0.0/football-match.jpg');
let image_inputs = await processor(image);
// {
//   "pixel_values": {
//     "dims": [ 1, 3, 224, 224 ],
//     "type": "float32",
//     "data": Float32Array [ -1.558687686920166, -1.558687686920166, -1.5440893173217773, ... ],
//     "size": 150528
//   },
//   "original_sizes": [
//     [ 533, 800 ]
//   ],
//   "reshaped_input_sizes": [
//     [ 224, 224 ]
//   ]
// }

Kind: static class of processors

AutoProcessor.from_pretrained(pretrained_model_name_or_path, options) ⇒ <code> Promise. < Processor > </code>

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

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

Kind: static method of AutoProcessor
Returns: Promise.<Processor> - A new instance of the Processor class.

processors.data : <code> Float32Array </code>

Kind: static property of processors

processors~center_to_corners_format(arr) ⇒ <code> Array. < number > </code>

Converts bounding boxes from center format to corners format.

Kind: inner method of processors
Returns: Array.<number> - The coodinates for the top-left and bottom-right corners of the box (top_left_x, top_left_y, bottom_right_x, bottom_right_y)

processors~post_process_semantic_segmentation(outputs, [target_sizes]) ⇒ <code> * </code>

Post-processes the outputs of the model (for semantic segmentation).

Kind: inner method of processors
Returns: * - The semantic segmentation maps.

post_process_semantic_segmentation~labels : <code> Array. < number > </code>

The unique list of labels that were detected

Kind: inner constant of post_process_semantic_segmentation

processors~post_process_panoptic_segmentation(outputs, [threshold], [mask_threshold], [overlap_mask_area_threshold], [label_ids_to_fuse], [target_sizes]) ⇒ <code> Array. < {segmentation: Tensor, segments_info: Array < {id: number, label_id: number, score: number} > } > </code>

Post-process the model output to generate the final panoptic segmentation.

Kind: inner method of processors

processors~post_process_instance_segmentation(outputs, [threshold], [target_sizes]) ⇒ <code> Array. < {segmentation: Tensor, segments_info: Array < {id: number, label_id: number, score: number} > } > </code>

Post-processes the outputs of the model (for instance segmentation).

Kind: inner method of processors

processors~enforce_size_divisibility(size, divisor) ⇒ <code> * </code>

Rounds the height and width down to the closest multiple of size_divisibility

Kind: inner method of processors
Returns: * - The rounded size.

processors~HeightWidth : <code> * </code>

Named tuple to indicate the order we are using is (height x width), even though the Graphics’ industry standard is (width x height).

Kind: inner typedef of processors

processors~ImageFeatureExtractorResult : <code> object </code>

Kind: inner typedef of processors
Properties

processors~PreprocessedImage : <code> object </code>

Kind: inner typedef of processors
Properties

processors~DetrFeatureExtractorResult : <code> object </code>

Kind: inner typedef of processors
Properties

processors~SamImageProcessorResult : <code> object </code>

Kind: inner typedef of processors
Properties