Webpack: add/build RTI target

jsconfig.json

@@ -6,6 +6,8 @@
     "compilerOptions": {
         // Tells the compiler to check JS files
         "checkJs": true,
+        "strict": true,
+        "noImplicitAny": true,
         "target": "esnext",
         "module": "esnext",
         "moduleResolution": "nodenext",

package.json

@@ -46,6 +46,7 @@
     "onnxruntime-node": "1.14.0"
   },
   "devDependencies": {
+    "@runtime-type-inspector/plugin-webpack5": "^3.3.7",
     "@types/jest": "^29.5.1",
     "catharsis": "github:xenova/catharsis",
     "copy-webpack-plugin": "^11.0.0",

src/models.js

@@ -1288,7 +1288,7 @@ export class PreTrainedModel extends Callable {
      * Adds past key values to the decoder feeds object. If pastKeyValues is null, creates new tensors for past key values.
      *
      * @param {Object} decoderFeeds The decoder feeds object to add past key values to.
-     * @param {Object} pastKeyValues An object containing past key values.
+     * @param {Object} [pastKeyValues] An object containing past key values.
      */
     addPastKeyValues(decoderFeeds, pastKeyValues) {
         if (pastKeyValues) {

src/pipelines.js

@@ -3132,7 +3132,7 @@ const TASK_ALIASES = Object.freeze({
  * @typedef {keyof typeof TASK_ALIASES} AliasType
  * @typedef {TaskType | AliasType} PipelineType All possible pipeline types.
  * @typedef {{[K in TaskType]: InstanceType<typeof SUPPORTED_TASKS[K]["pipeline"]>}} SupportedTasks A mapping of pipeline names to their corresponding pipeline classes.
- * @typedef {{[K in AliasType]: InstanceType<typeof SUPPORTED_TASKS[TASK_ALIASES[K]]["pipeline"]>}} AliasTasks A mapping from pipeline aliases to their corresponding pipeline classes.
+ * @typedef {{[K in AliasType]: SupportedTasks[TASK_ALIASES[K]]}} AliasTasks A mapping from pipeline aliases to their corresponding pipeline classes.
  * @typedef {SupportedTasks & AliasTasks} AllTasks A mapping from all pipeline names and aliases to their corresponding pipeline classes.
  */
 

src/processors.js

@@ -238,13 +238,13 @@ export class ImageFeatureExtractor extends FeatureExtractor {
      * Constructs a new ImageFeatureExtractor instance.
      *
      * @param {Object} config The configuration for the feature extractor.
-     * @param {number[]} config.image_mean The mean values for image normalization.
-     * @param {number[]} config.image_std The standard deviation values for image normalization.
-     * @param {boolean} config.do_rescale Whether to rescale the image pixel values to the [0,1] range.
-     * @param {number} config.rescale_factor The factor to use for rescaling the image pixel values.
-     * @param {boolean} config.do_normalize Whether to normalize the image pixel values.
+     * @param {number[]} [config.image_mean] The mean values for image normalization.
+     * @param {number[]} [config.image_std] The standard deviation values for image normalization.
+     * @param {boolean} [config.do_rescale] Whether to rescale the image pixel values to the [0,1] range.
+     * @param {number} [config.rescale_factor] The factor to use for rescaling the image pixel values.
+     * @param {boolean} [config.do_normalize] Whether to normalize the image pixel values.
      * @param {boolean} config.do_resize Whether to resize the image.
-     * @param {number} config.resample What method to use for resampling.
+     * @param {number} [config.resample] What method to use for resampling.
      * @param {number|Object} config.size The size to resize the image to.
      * @param {boolean} [config.do_flip_channel_order=false] Whether to flip the color channels from RGB to BGR.
      * Can be overridden by the `do_flip_channel_order` parameter in the `preprocess` method.
@@ -567,7 +567,11 @@ export class ImageFeatureExtractor extends FeatureExtractor {
      * Preprocesses the given image.
      *
      * @param {RawImage} image The image to preprocess.
-     * @param {Object} overrides The overrides for the preprocessing options.
+     * @param {Object} [overrides] The overrides for the preprocessing options.
+     * @param {boolean|null} [overrides.do_normalize] Do normalize?
+     * @param {boolean|null} [overrides.do_pad] Do pad?
+     * @param {boolean|null} [overrides.do_convert_rgb] Do convert RGB?
+     * @param {boolean|null} [overrides.do_convert_grayscale] Do convert grayscale?
      * @returns {Promise<PreprocessedImage>} The preprocessed image.
      */
     async preprocess(image, {

src/transformers.rti.js

@@ -0,0 +1,11 @@
+import { customTypes } from '@runtime-type-inspector/runtime';
+import { ONNX } from './backends/onnx.js';
+import 'display-anything/src/style.js';
+/**
+ * @param {*} value 
+ * @returns {boolean}
+ */
+customTypes.ONNXTensor = value => {
+  return value instanceof ONNX.Tensor;
+}
+export * from './transformers.js';

src/utils/core.js

@@ -11,8 +11,8 @@
 /**
  * Helper function to dispatch progress callbacks.
  *
- * @param {Function} progress_callback The progress callback function to dispatch.
- * @param {any} data The data to pass to the progress callback function.
+ * @param {Function} [progress_callback] The progress callback function to dispatch.
+ * @param {any} [data] The data to pass to the progress callback function.
  * @returns {void}
  * @private
  */

webpack.config.js

@@ -2,29 +2,24 @@ import CopyWebpackPlugin from 'copy-webpack-plugin';
 import TerserPlugin from 'terser-webpack-plugin';
 import { fileURLToPath } from 'url';
 import path from 'path';
+import { RuntimeTypeInspectorPlugin } from '@runtime-type-inspector/plugin-webpack5';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
- * @type {import('webpack').Configuration}
+ * Build a target that webpack is supposed to build.
+ *
+ * @param {'release'|'rti'} buildType - The build type.
+ * @returns {import('webpack').Configuration} One webpack target.
  */
-export default {
-    mode: 'development',
-    devtool: 'source-map',
-    entry: {
+function buildTarget(buildType) {
+    let entry = {
         // include dist in entry point so that when running dev server,
         // we can access the files with /dist/...
         'dist/transformers': './src/transformers.js',
         'dist/transformers.min': './src/transformers.js',
-    },
-    output: {
-        filename: '[name].js',
-        path: __dirname,
-        library: {
-            type: 'module',
-        },
-    },
-    plugins: [
+    };
+    let plugins = [
         // Copy .wasm files to dist folder
         new CopyWebpackPlugin({
             patterns: [
@@ -33,22 +28,49 @@ export default {
                     to: 'dist/[name][ext]'
                 },
             ],
-        }),
-    ],
-    optimization: {
-        minimize: true,
-        minimizer: [new TerserPlugin({
-            test: /\.min\.js$/,
-            extractComments: false,
-        })],
-    },
-    devServer: {
-        static: {
-            directory: __dirname
+        })
+    ];
+    let devtool = 'source-map';
+    if (buildType === 'rti') {
+        entry = {
+            'dist/transformers.rti': './src/transformers.rti.js',
+        };
+        plugins = [
+            new RuntimeTypeInspectorPlugin()
+        ];
+        devtool = false;
+    }
+    return {
+        mode: 'development',
+        devtool,
+        entry,
+        output: {
+            filename: '[name].js',
+            path: __dirname,
+            library: {
+                type: 'module',
+            },
+        },
+        plugins,
+        optimization: {
+            minimize: buildType === 'release',
+            minimizer: [new TerserPlugin({
+                test: /\.min\.js$/,
+                extractComments: false,
+            })],
+        },
+        devServer: {
+            static: {
+                directory: __dirname
+            },
+            port: 8080
+        },
+        experiments: {
+            outputModule: true,
         },
-        port: 8080
-    },
-    experiments: {
-        outputModule: true,
-    },
-};
+    };
+}
+export default [
+    buildTarget('release'),
+    buildTarget('rti'),
+];