@huggingface/transformers 3.0.0-alpha.4 → 3.0.0-alpha.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@huggingface/transformers",
-  "version": "3.0.0-alpha.4",
+  "version": "3.0.0-alpha.6",
   "description": "State-of-the-art Machine Learning for the web. Run 🤗 Transformers directly in your browser, with no need for a server!",
   "main": "./src/transformers.js",
   "types": "./types/transformers.d.ts",
@@ -8,17 +8,17 @@
   "exports": {
     "node": {
       "import": {
-        "default": "./dist/transformers.mjs",
-        "types": "./types/transformers.d.ts"
+        "types": "./types/transformers.d.ts",
+        "default": "./dist/transformers.mjs"
       },
       "require": {
-        "default": "./dist/transformers.cjs",
-        "types": "./types/transformers.d.ts"
+        "types": "./types/transformers.d.ts",
+        "default": "./dist/transformers.cjs"
       }
     },
     "default": {
-      "default": "./dist/transformers.js",
-      "types": "./types/transformers.d.ts"
+      "types": "./types/transformers.d.ts",
+      "default": "./dist/transformers.js"
     }
   },
   "scripts": {

package/src/backends/onnx.js

@@ -33,6 +33,27 @@ let defaultExecutionProviders;
 let ONNX;
 if (apis.IS_NODE_ENV) {
     ONNX = ONNX_NODE.default ?? ONNX_NODE;
+
+    // Updated as of ONNX Runtime 1.18.0
+    // The following table lists the supported versions of ONNX Runtime Node.js binding provided with pre-built binaries.
+    // | EPs/Platforms | Windows x64 | Windows arm64 | Linux x64         | Linux arm64 | MacOS x64 | MacOS arm64 |
+    // | ------------- | ----------- | ------------- | ----------------- | ----------- | --------- | ----------- |
+    // | CPU           | ✔️          | ✔️            | ✔️                | ✔️          | ✔️        | ✔️          |
+    // | DirectML      | ✔️          | ✔️            | ❌                | ❌          | ❌        | ❌          |
+    // | CUDA          | ❌          | ❌            | ✔️ (CUDA v11.8)   | ❌          | ❌        | ❌          |
+    switch (process.platform) {
+        case 'win32': // Windows x64 and Windows arm64
+            supportedExecutionProviders.push('dml');
+            break;
+        case 'linux': // Linux x64 and Linux arm64
+            if (process.arch === 'x64') {
+                supportedExecutionProviders.push('cuda');
+            }
+            break;
+        case 'darwin': // MacOS x64 and MacOS arm64
+            break;
+    }
+
     supportedExecutionProviders.push('cpu');
     defaultExecutionProviders = ['cpu'];
 } else {
@@ -76,7 +97,7 @@ let wasmInitPromise = null;
 /**
  * Create an ONNX inference session.
  * @param {Uint8Array} buffer The ONNX model buffer.
- * @param {Object} session_options ONNX inference session options.
+ * @param {import('onnxruntime-common').InferenceSession.SessionOptions} session_options ONNX inference session options.
  * @returns {Promise<import('onnxruntime-common').InferenceSession>} The ONNX inference session.
  */
 export async function createInferenceSession(buffer, session_options) {

package/src/env.js

@@ -26,7 +26,7 @@ import fs from 'fs';
 import path from 'path';
 import url from 'url';
 
-const VERSION = '3.0.0-alpha.4';
+const VERSION = '3.0.0-alpha.6';
 
 // Check if various APIs are available (depends on environment)
 const IS_BROWSER_ENV = typeof self !== 'undefined';

package/src/utils/devices.js

@@ -1,9 +1,11 @@
 
 export const DEVICE_TYPES = Object.freeze({
-    cpu: 'cpu',
-    gpu: 'gpu',
-    wasm: 'wasm',
-    webgpu: 'webgpu',
+    cpu: 'cpu', // CPU
+    gpu: 'gpu', // Auto-detect GPU
+    wasm: 'wasm', // WebAssembly
+    webgpu: 'webgpu', // WebGPU
+    cuda: 'cuda', // CUDA
+    dml: 'dml', // DirectML
 });
 
 /**

package/src/utils/dtypes.js

@@ -47,6 +47,8 @@ export const DEFAULT_DEVICE_DTYPE_MAPPING = Object.freeze({
     [DEVICE_TYPES.gpu]: DATA_TYPES.fp32,
     [DEVICE_TYPES.wasm]: DATA_TYPES.q8,
     [DEVICE_TYPES.webgpu]: DATA_TYPES.fp32,
+    [DEVICE_TYPES.cuda]: DATA_TYPES.fp32,
+    [DEVICE_TYPES.dml]: DATA_TYPES.fp32,
 });
 
 /** @type {Record<DataType, string>} */

package/src/utils/hub.js

@@ -32,28 +32,29 @@ import { dispatchCallback } from './core.js';
  * @property {import("./devices.js").DeviceType|Record<string, import("./devices.js").DeviceType>} [device=null] The device to run the model on. If not specified, the device will be chosen from the environment settings.
  * @property {import("./dtypes.js").DataType|Record<string, import("./dtypes.js").DataType>} [dtype=null] The data type to use for the model. If not specified, the data type will be chosen from the environment settings.
  * @property {boolean|Record<string, boolean>} [use_external_data_format=false] Whether to load the model using the external data format (used for models >= 2GB in size).
- * @property {Object} [session_options] (Optional) User-specified session options passed to the runtime. If not provided, suitable defaults will be chosen.
+ * @property {import('onnxruntime-common').InferenceSession.SessionOptions} [session_options] (Optional) User-specified session options passed to the runtime. If not provided, suitable defaults will be chosen.
  */
 
 /**
  * @typedef {PretrainedOptions & ModelSpecificPretrainedOptions} PretrainedModelOptions Options for loading a pretrained model.
  */
 
+/**
+ * Mapping from file extensions to MIME types.
+ */
+const CONTENT_TYPE_MAP = {
+    'txt': 'text/plain',
+    'html': 'text/html',
+    'css': 'text/css',
+    'js': 'text/javascript',
+    'json': 'application/json',
+    'png': 'image/png',
+    'jpg': 'image/jpeg',
+    'jpeg': 'image/jpeg',
+    'gif': 'image/gif',
+}
 class FileResponse {
-    /**
-     * Mapping from file extensions to MIME types.
-     */
-    _CONTENT_TYPE_MAP = {
-        'txt': 'text/plain',
-        'html': 'text/html',
-        'css': 'text/css',
-        'js': 'text/javascript',
-        'json': 'application/json',
-        'png': 'image/png',
-        'jpg': 'image/jpeg',
-        'jpeg': 'image/jpeg',
-        'gif': 'image/gif',
-    }
+
     /**
      * Creates a new `FileResponse` object.
      * @param {string|URL} filePath
@@ -96,7 +97,7 @@ class FileResponse {
     updateContentType() {
         // Set content-type header based on file extension
         const extension = this.filePath.toString().split('.').pop().toLowerCase();
-        this.headers.set('content-type', this._CONTENT_TYPE_MAP[extension] ?? 'application/octet-stream');
+        this.headers.set('content-type', CONTENT_TYPE_MAP[extension] ?? 'application/octet-stream');
     }
 
     /**

package/types/backends/onnx.d.ts

@@ -7,10 +7,10 @@ export function deviceToExecutionProviders(device?: import("../utils/devices.js"
 /**
  * Create an ONNX inference session.
  * @param {Uint8Array} buffer The ONNX model buffer.
- * @param {Object} session_options ONNX inference session options.
+ * @param {import('onnxruntime-common').InferenceSession.SessionOptions} session_options ONNX inference session options.
  * @returns {Promise<import('onnxruntime-common').InferenceSession>} The ONNX inference session.
  */
-export function createInferenceSession(buffer: Uint8Array, session_options: any): Promise<import('onnxruntime-common').InferenceSession>;
+export function createInferenceSession(buffer: Uint8Array, session_options: import('onnxruntime-common').InferenceSession.SessionOptions): Promise<import('onnxruntime-common').InferenceSession>;
 /**
  * Check if an object is an ONNX tensor.
  * @param {any} x The object to check

package/types/backends/onnx.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onnx.d.ts","sourceRoot":"","sources":["../../src/backends/onnx.js"],"names":[],"mappings":"AAiDA;;;;GAIG;AACH,oDAHW,OAAO,qBAAqB,EAAE,UAAU,GACtC,OAAO,qBAAqB,EAAE,UAAU,EAAE,CAYtD;AAWD;;;;;GAKG;AACH,+CAJW,UAAU,yBAER,QAAQ,OAAO,oBAAoB,EAAE,gBAAgB,CAAC,CAYlE;AAED;;;;GAIG;AACH,gCAHW,GAAG,GACD,OAAO,CAInB;AAwCD;;;GAGG;AACH,+BAFa,OAAO,CAKnB"}
+{"version":3,"file":"onnx.d.ts","sourceRoot":"","sources":["../../src/backends/onnx.js"],"names":[],"mappings":"AAsEA;;;;GAIG;AACH,oDAHW,OAAO,qBAAqB,EAAE,UAAU,GACtC,OAAO,qBAAqB,EAAE,UAAU,EAAE,CAYtD;AAWD;;;;;GAKG;AACH,+CAJW,UAAU,mBACV,OAAO,oBAAoB,EAAE,gBAAgB,CAAC,cAAc,GAC1D,QAAQ,OAAO,oBAAoB,EAAE,gBAAgB,CAAC,CAYlE;AAED;;;;GAIG;AACH,gCAHW,GAAG,GACD,OAAO,CAInB;AAwCD;;;GAGG;AACH,+BAFa,OAAO,CAKnB"}

package/types/utils/devices.d.ts

@@ -3,6 +3,8 @@ export const DEVICE_TYPES: Readonly<{
     gpu: "gpu";
     wasm: "wasm";
     webgpu: "webgpu";
+    cuda: "cuda";
+    dml: "dml";
 }>;
 export type DeviceType = keyof typeof DEVICE_TYPES;
 //# sourceMappingURL=devices.d.ts.map

package/types/utils/devices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../../src/utils/devices.js"],"names":[],"mappings":"AACA;;;;;GAKG;yBAGU,MAAM,mBAAmB"}
+{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../../src/utils/devices.js"],"names":[],"mappings":"AACA;;;;;;;GAOG;yBAGU,MAAM,mBAAmB"}

package/types/utils/dtypes.d.ts

@@ -15,6 +15,8 @@ export const DEFAULT_DEVICE_DTYPE_MAPPING: Readonly<{
     gpu: "fp32";
     wasm: "q8";
     webgpu: "fp32";
+    cuda: "fp32";
+    dml: "fp32";
 }>;
 /** @type {Record<DataType, string>} */
 export const DEFAULT_DTYPE_SUFFIX_MAPPING: Record<DataType, string>;

package/types/utils/dtypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dtypes.d.ts","sourceRoot":"","sources":["../../src/utils/dtypes.js"],"names":[],"mappings":"AAeW,0DAcN;AAGL;;;;;;;;;GASG;AACH,kDAAkD;AAElD;;;;;GAKG;AAEH,uCAAuC;AACvC,2CADW,OAAO,QAAQ,EAAE,MAAM,CAAC,CAUhC;uBAnBW,MAAM,iBAAiB"}
+{"version":3,"file":"dtypes.d.ts","sourceRoot":"","sources":["../../src/utils/dtypes.js"],"names":[],"mappings":"AAeW,0DAcN;AAGL;;;;;;;;;GASG;AACH,kDAAkD;AAElD;;;;;;;GAOG;AAEH,uCAAuC;AACvC,2CADW,OAAO,QAAQ,EAAE,MAAM,CAAC,CAUhC;uBArBW,MAAM,iBAAiB"}

package/types/utils/hub.d.ts

@@ -89,57 +89,18 @@ export type ModelSpecificPretrainedOptions = {
     /**
      * (Optional) User-specified session options passed to the runtime. If not provided, suitable defaults will be chosen.
      */
-    session_options?: any;
+    session_options?: import('onnxruntime-common').InferenceSession.SessionOptions;
 };
 /**
  * Options for loading a pretrained model.
  */
 export type PretrainedModelOptions = PretrainedOptions & ModelSpecificPretrainedOptions;
-/**
- * @typedef {Object} PretrainedOptions Options for loading a pretrained model.
- * @property {function} [progress_callback=null] If specified, this function will be called during model construction, to provide the user with progress updates.
- * @property {Object} [config=null] Configuration for the model to use instead of an automatically loaded configuration. Configuration can be automatically loaded when:
- * - The model is a model provided by the library (loaded with the *model id* string of a pretrained model).
- * - The model is loaded by supplying a local directory as `pretrained_model_name_or_path` and a configuration JSON file named *config.json* is found in the directory.
- * @property {string} [cache_dir=null] Path to a directory in which a downloaded pretrained model configuration should be cached if the standard cache should not be used.
- * @property {boolean} [local_files_only=false] Whether or not to only look at local files (e.g., not try downloading the model).
- * @property {string} [revision='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.
- * NOTE: This setting is ignored for local requests.
- */
-/**
- * @typedef {Object} ModelSpecificPretrainedOptions Options for loading a pretrained model.
- * @property {string} [subfolder='onnx'] In case the relevant files are located inside a subfolder of the model repo on huggingface.co,
- * you can specify the folder name here.
- * @property {string} [model_file_name=null] If specified, load the model with this name (excluding the .onnx suffix). Currently only valid for encoder- or decoder-only models.
- * @property {import("./devices.js").DeviceType|Record<string, import("./devices.js").DeviceType>} [device=null] The device to run the model on. If not specified, the device will be chosen from the environment settings.
- * @property {import("./dtypes.js").DataType|Record<string, import("./dtypes.js").DataType>} [dtype=null] The data type to use for the model. If not specified, the data type will be chosen from the environment settings.
- * @property {boolean|Record<string, boolean>} [use_external_data_format=false] Whether to load the model using the external data format (used for models >= 2GB in size).
- * @property {Object} [session_options] (Optional) User-specified session options passed to the runtime. If not provided, suitable defaults will be chosen.
- */
-/**
- * @typedef {PretrainedOptions & ModelSpecificPretrainedOptions} PretrainedModelOptions Options for loading a pretrained model.
- */
 declare class FileResponse {
     /**
      * Creates a new `FileResponse` object.
      * @param {string|URL} filePath
      */
     constructor(filePath: string | URL);
-    /**
-     * Mapping from file extensions to MIME types.
-     */
-    _CONTENT_TYPE_MAP: {
-        txt: string;
-        html: string;
-        css: string;
-        js: string;
-        json: string;
-        png: string;
-        jpg: string;
-        jpeg: string;
-        gif: string;
-    };
     filePath: string | URL;
     headers: Headers;
     exists: any;

package/types/utils/hub.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hub.d.ts","sourceRoot":"","sources":["../../src/utils/hub.js"],"names":[],"mappings":"AAsLA;;;;;GAKG;AACH,mCAHW,GAAG,GAAC,MAAM,GACR,QAAQ,YAAY,GAAC,QAAQ,CAAC,CAgC1C;AA2GD;;;;;;;;;;;;;;GAcG;AACH,8CAVW,MAAM,YAGN,MAAM,UACN,OAAO,YACP,iBAAiB,GAGf,QAAQ,UAAU,CAAC,CAyO/B;AAED;;;;;;;;;GASG;AACH,wCAPW,MAAM,YACN,MAAM,UACN,OAAO,YACP,iBAAiB,GACf,YAAe,CAc3B;;;;;;;;;;;;;;;;;;gBA/jBa,MAAM;;;;uBACN,OAAO;;;;;;eACP,MAAM;;;;;;;;;;gBAON,MAAM;;;;sBAEN,MAAM;;;;aACN,OAAO,cAAc,EAAE,UAAU,GAAC,OAAO,MAAM,EAAE,OAAO,cAAc,EAAE,UAAU,CAAC;;;;YACnF,OAAO,aAAa,EAAE,QAAQ,GAAC,OAAO,MAAM,EAAE,OAAO,aAAa,EAAE,QAAQ,CAAC;;;;+BAC7E,OAAO,GAAC,OAAO,MAAM,EAAE,OAAO,CAAC;;;;;;;;;qCAKhC,iBAAiB,GAAG,8BAA8B;AAzB/D;;;;;;;;;;;GAWG;AAEH;;;;;;;;;GASG;AAEH;;GAEG;AAEH;IAeI;;;OAGG;IACH,sBAFW,MAAM,GAAC,GAAG,EA8BpB;IA9CD;;OAEG;IACH;;;;;;;;;;MAUC;IAMG,uBAAwB;IACxB,iBAA4B;IAE5B,YAAqC;IAEjC,eAAiB;IACjB,mBAAsB;IAQtB,0BAOE;IAQV;;;;OAIG;IACH,qBAFa,IAAI,CAMhB;IAED;;;OAGG;IACH,SAFa,YAAY,CASxB;IAED;;;;;OAKG;IACH,eAHa,QAAQ,WAAW,CAAC,CAMhC;IAED;;;;;OAKG;IACH,QAHa,QAAQ,IAAI,CAAC,CAMzB;IAED;;;;;OAKG;IACH,QAHa,QAAQ,MAAM,CAAC,CAM3B;IAED;;;;;;OAMG;IACH,QAHa,YAAe,CAK3B;CACJ"}
+{"version":3,"file":"hub.d.ts","sourceRoot":"","sources":["../../src/utils/hub.js"],"names":[],"mappings":"AAuLA;;;;;GAKG;AACH,mCAHW,GAAG,GAAC,MAAM,GACR,QAAQ,YAAY,GAAC,QAAQ,CAAC,CAgC1C;AA2GD;;;;;;;;;;;;;;GAcG;AACH,8CAVW,MAAM,YAGN,MAAM,UACN,OAAO,YACP,iBAAiB,GAGf,QAAQ,UAAU,CAAC,CAyO/B;AAED;;;;;;;;;GASG;AACH,wCAPW,MAAM,YACN,MAAM,UACN,OAAO,YACP,iBAAiB,GACf,YAAe,CAc3B;;;;;;;;;;;;;;;;;;gBAhkBa,MAAM;;;;uBACN,OAAO;;;;;;eACP,MAAM;;;;;;;;;;gBAON,MAAM;;;;sBAEN,MAAM;;;;aACN,OAAO,cAAc,EAAE,UAAU,GAAC,OAAO,MAAM,EAAE,OAAO,cAAc,EAAE,UAAU,CAAC;;;;YACnF,OAAO,aAAa,EAAE,QAAQ,GAAC,OAAO,MAAM,EAAE,OAAO,aAAa,EAAE,QAAQ,CAAC;;;;+BAC7E,OAAO,GAAC,OAAO,MAAM,EAAE,OAAO,CAAC;;;;sBAC/B,OAAO,oBAAoB,EAAE,gBAAgB,CAAC,cAAc;;;;;qCAI7D,iBAAiB,GAAG,8BAA8B;AAiB/D;IAEI;;;OAGG;IACH,sBAFW,MAAM,GAAC,GAAG,EA8BpB;IA3BG,uBAAwB;IACxB,iBAA4B;IAE5B,YAAqC;IAEjC,eAAiB;IACjB,mBAAsB;IAQtB,0BAOE;IAQV;;;;OAIG;IACH,qBAFa,IAAI,CAMhB;IAED;;;OAGG;IACH,SAFa,YAAY,CASxB;IAED;;;;;OAKG;IACH,eAHa,QAAQ,WAAW,CAAC,CAMhC;IAED;;;;;OAKG;IACH,QAHa,QAAQ,IAAI,CAAC,CAMzB;IAED;;;;;OAKG;IACH,QAHa,QAAQ,MAAM,CAAC,CAM3B;IAED;;;;;;OAMG;IACH,QAHa,YAAe,CAK3B;CACJ"}