Replace CommonJS imports/exports with ES6

Author: praxiao

jsconfig.json

@@ -1,5 +1,8 @@
 {
     "compilerOptions": {
-        "checkJs": true
+        "checkJs": true,
+        "target": "esnext",
+        "module": "esnext",
+        "moduleResolution": "nodenext",
     }
 }

package.json

@@ -3,6 +3,7 @@
   "version": "1.4.2",
   "description": "Run 🤗 Transformers in your browser! We currently support BERT, ALBERT, DistilBERT, MobileBERT, SqueezeBERT, T5, T5v1.1, FLAN-T5, mT5, BART, MarianMT, GPT2, GPT Neo, CodeGen, Whisper, CLIP, Vision Transformer, VisionEncoderDecoder, and DETR models, for a variety of tasks including: masked language modelling, text classification, token classification, zero-shot classification, text-to-text generation, translation, summarization, question answering, text generation, automatic speech recognition, image classification, zero-shot image classification, image-to-text, image segmentation, and object detection.",
   "main": "./src/transformers.js",
+  "type": "module",
   "directories": {
     "test": "tests"
   },

src/backends/onnx.js

@@ -1,13 +1,13 @@
-let ONNX;
+export let ONNX;
 
 // TODO support more execution providers (e.g., webgpu)
-const executionProviders = ['wasm'];
+export const executionProviders = ['wasm'];
 
 if (typeof process !== 'undefined') {
     // Running in a node-like environment.
     // Try to import onnxruntime-node, using onnxruntime-web as a fallback
     try {
-        ONNX = require('onnxruntime-node');
+        ONNX = (await import('onnxruntime-node')).default;
     } catch (err) {
         console.warn(
             "Node.js environment detected, but `onnxruntime-node` was not found. " +
@@ -20,7 +20,7 @@ if (typeof process !== 'undefined') {
         // @ts-ignore
         global.self = global;
 
-        ONNX = require('onnxruntime-web');
+        ONNX = (await import('onnxruntime-web')).default;
 
         // Disable spawning worker threads for testing.
         // This is done by setting numThreads to 1
@@ -33,10 +33,6 @@ if (typeof process !== 'undefined') {
 
 } else {
     // Running in a browser-environment, so we just import `onnxruntime-web`
-    ONNX = require('onnxruntime-web');
+    ONNX = (await import('onnxruntime-web')).default;
 }
 
-module.exports = {
-    ONNX,
-    executionProviders,
-}

src/env.js

@@ -1,7 +1,11 @@
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
-const { env: onnx_env } = require('./backends/onnx.js').ONNX;
+import { ONNX } from './backends/onnx.js';
+const { env: onnx_env } = ONNX;
+
+const __dirname = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
 
 // check if various APIs are available (depends on environment)
 const CACHE_AVAILABLE = typeof self !== 'undefined' && 'caches' in self;
@@ -13,20 +17,20 @@ const RUNNING_LOCALLY = FS_AVAILABLE && PATH_AVAILABLE;
 // set local model path, based on available APIs
 const DEFAULT_LOCAL_PATH = '/models/onnx/quantized/';
 const localURL = RUNNING_LOCALLY
-    ? path.join(path.dirname(__dirname), DEFAULT_LOCAL_PATH)
+    ? path.join(__dirname, DEFAULT_LOCAL_PATH)
     : DEFAULT_LOCAL_PATH;
 
 // First, set path to wasm files. This is needed when running in a web worker.
 // https://onnxruntime.ai/docs/api/js/interfaces/Env.WebAssemblyFlags.html#wasmPaths
 // We use remote wasm files by default to make it easier for newer users.
 // In practice, users should probably self-host the necessary .wasm files.
 onnx_env.wasm.wasmPaths = RUNNING_LOCALLY
-    ? path.join(path.dirname(__dirname), '/dist/')
+    ? path.join(__dirname, '/dist/')
     : 'https://cdn.jsdelivr.net/npm/@xenova/transformers/dist/';
 
 
 // Global variable used to control exection, with suitable defaults
-const env = {
+export const env = {
     // access onnxruntime-web's environment variables
     onnx: onnx_env,
 
@@ -44,6 +48,9 @@ const env = {
 
     // Whether to use the file system to load files. By default, it is true available.
     useFS: FS_AVAILABLE,
+
+    // Directory name of module. Useful for resolving local paths.
+    __dirname,
 }
 
 
@@ -54,6 +61,3 @@ function isEmpty(obj) {
     return Object.keys(obj).length === 0;
 }
 
-module.exports = {
-    env
-}

src/fft.js

@@ -3,7 +3,7 @@
  * FFT class provides functionality for performing Fast Fourier Transform on arrays
  * Code adapted from https://www.npmjs.com/package/fft.js
  */
-class FFT {
+export default class FFT {
     /**
      * @param {number} size - The size of the input array. Must be a power of two and bigger than 1.
      * @throws {Error} FFT size must be a power of two and bigger than 1.
@@ -494,5 +494,3 @@ class FFT {
         out[outOff + 7] = T3r;
     }
 }
-
-module.exports = FFT

src/generation.js

@@ -1,9 +1,9 @@
-const { Tensor } = require("./tensor_utils.js");
-const {
+import { Tensor } from './tensor_utils.js';
+import {
     Callable,
     exists,
     log_softmax
-} = require("./utils.js");
+} from './utils.js';
 
 /**
  * A class representing a list of logits processors. A logits processor is a function that modifies the logits
@@ -12,7 +12,7 @@ const {
  *
  * @extends Callable
  */
-class LogitsProcessorList extends Callable {
+export class LogitsProcessorList extends Callable {
     /**
      * Constructs a new instance of `LogitsProcessorList`.
      */
@@ -66,7 +66,7 @@ class LogitsProcessorList extends Callable {
  * Base class for processing logits.
  * @extends Callable
  */
-class LogitsProcessor extends Callable {
+export class LogitsProcessor extends Callable {
     /**
      * Apply the processor to the input logits.
      *
@@ -85,7 +85,7 @@ class LogitsProcessor extends Callable {
  * 
  * @extends LogitsProcessor
  */
-class ForceTokensLogitsProcessor extends LogitsProcessor {
+export class ForceTokensLogitsProcessor extends LogitsProcessor {
     /**
      * Constructs a new instance of `ForceTokensLogitsProcessor`.
      * 
@@ -117,7 +117,7 @@ class ForceTokensLogitsProcessor extends LogitsProcessor {
  * A LogitsProcessor that forces a BOS token at the beginning of the generated sequence.
  * @extends LogitsProcessor
  */
-class ForcedBOSTokenLogitsProcessor extends LogitsProcessor {
+export class ForcedBOSTokenLogitsProcessor extends LogitsProcessor {
     /**
      * Create a ForcedBOSTokenLogitsProcessor.
      * @param {number} bos_token_id - The ID of the beginning-of-sequence token to be forced.
@@ -146,7 +146,7 @@ class ForcedBOSTokenLogitsProcessor extends LogitsProcessor {
  * 
  * @extends LogitsProcessor
  */
-class ForcedEOSTokenLogitsProcessor extends LogitsProcessor {
+export class ForcedEOSTokenLogitsProcessor extends LogitsProcessor {
     /**
      * Create a ForcedEOSTokenLogitsProcessor.
      * @param {number} max_length - Max length of the sequence.
@@ -174,7 +174,7 @@ class ForcedEOSTokenLogitsProcessor extends LogitsProcessor {
  * A LogitsProcessor that handles adding timestamps to generated text.
  * @extends LogitsProcessor
  */
-class WhisperTimeStampLogitsProcessor extends LogitsProcessor {
+export class WhisperTimeStampLogitsProcessor extends LogitsProcessor {
     /**
      * Constructs a new WhisperTimeStampLogitsProcessor.
      * @param {object} generate_config - The config object passed to the `generate()` method of a transformer model.
@@ -249,7 +249,7 @@ class WhisperTimeStampLogitsProcessor extends LogitsProcessor {
  * 
  * @extends LogitsProcessor
  */
-class NoRepeatNGramLogitsProcessor extends LogitsProcessor {
+export class NoRepeatNGramLogitsProcessor extends LogitsProcessor {
     /**
      * Create a NoRepeatNGramLogitsProcessor.
      * @param {number} no_repeat_ngram_size - The no-repeat-ngram size. All ngrams of this size can only occur once.
@@ -340,7 +340,7 @@ class NoRepeatNGramLogitsProcessor extends LogitsProcessor {
  * 
  * @extends LogitsProcessor
  */
-class RepetitionPenaltyLogitsProcessor extends LogitsProcessor {
+export class RepetitionPenaltyLogitsProcessor extends LogitsProcessor {
     /**
      * Create a RepetitionPenaltyLogitsProcessor.
      * @param {number} penalty - The penalty to apply for repeated tokens.
@@ -372,7 +372,7 @@ class RepetitionPenaltyLogitsProcessor extends LogitsProcessor {
 }
 
 
-class GenerationConfig {
+export class GenerationConfig {
     constructor(kwargs = {}) {
         // Parameters that control the length of the output
         // TODO: extend the configuration with correct types
@@ -465,15 +465,3 @@ class GenerationConfig {
         this.generation_kwargs = kwargs.generation_kwargs ?? {};
     }
 }
-
-module.exports = {
-    LogitsProcessor,
-    LogitsProcessorList,
-    GenerationConfig,
-    ForcedBOSTokenLogitsProcessor,
-    ForcedEOSTokenLogitsProcessor,
-    WhisperTimeStampLogitsProcessor,
-    ForceTokensLogitsProcessor,
-    NoRepeatNGramLogitsProcessor,
-    RepetitionPenaltyLogitsProcessor
-};

src/image_utils.js

@@ -1,10 +1,10 @@
 
-const fs = require('fs');
-const { getFile, isString } = require('./utils.js');
-const { env } = require('./env.js');
+import fs from 'fs';
+import { getFile, isString } from './utils.js';
+import { env } from './env.js';
 
 let CanvasClass;
-let ImageClass = typeof Image !== 'undefined' ? Image : null; // Only used for type-checking
+let ImageClass = typeof Image !== 'undefined' ? Image : null;
 
 let ImageDataClass;
 let loadImageFunction;
@@ -14,15 +14,15 @@ if (typeof self !== 'undefined') {
     ImageDataClass = ImageData;
 
 } else {
-    const { Canvas, loadImage, ImageData, Image } = require('canvas');
+    const { Canvas, loadImage, ImageData, Image } = await import('canvas');
     CanvasClass = Canvas;
     loadImageFunction = async (/**@type {Blob}*/ b) => await loadImage(Buffer.from(await b.arrayBuffer()));
     ImageDataClass = ImageData;
     ImageClass = Image;
 }
 
 
-class CustomImage {
+export class CustomImage {
 
     /**
      * Create a new CustomImage object.
@@ -277,7 +277,3 @@ class CustomImage {
         fs.writeFileSync(path, buffer);
     }
 }
-
-module.exports = {
-    CustomImage,
-};

src/math_utils.js

@@ -8,7 +8,7 @@
 /**
  * @param {TypedArray} input
  */
-function interpolate(input, [in_channels, in_height, in_width], [out_height, out_width], mode = 'bilinear', align_corners = false) {
+export function interpolate(input, [in_channels, in_height, in_width], [out_height, out_width], mode = 'bilinear', align_corners = false) {
     // TODO use mode and align_corners
 
     // Output image dimensions
@@ -86,7 +86,7 @@ function interpolate(input, [in_channels, in_height, in_width], [out_height, out
  * @param {number[]} axes 
  * @returns {[T, number[]]} The transposed array and the new shape.
  */
-function transpose_data(array, dims, axes) {
+export function transpose_data(array, dims, axes) {
     // Calculate the new shape of the transposed array
     // and the stride of the original array
     const shape = new Array(axes.length);
@@ -117,8 +117,3 @@ function transpose_data(array, dims, axes) {
 
     return [transposedData, shape];
 }
-
-module.exports = {
-    interpolate,
-    transpose: transpose_data,
-}