[refactor] Standardize model configuration property names to snake_case across the codebase

- Renamed `modelPath` to `model_path` and `dType` to `dtype` in multiple files for consistency.
- Updated related schemas, model samples, and tests to reflect the new naming convention.
- Introduced a new `pooling` property in relevant schemas to specify the pooling strategy for models.
- Ensured all references to model configuration are aligned with the updated naming for improved clarity and maintainability.

Author: sroussey

docs/developers/01_getting_started.md

@@ -154,7 +154,8 @@ await modelRepo.addModel({
   provider: HF_TRANSFORMERS_ONNX,
   provider_config: {
     pipeline: "text2text-generation",
-    modelPath: "Xenova/LaMini-Flan-T5-783M"
+    pooling: "mean",
+    model_path: "Xenova/LaMini-Flan-T5-783M"
 });
 
 // Job queue for the provider

packages/ai-provider/src/hf-transformers/common/HFT_JobRunFns.ts

@@ -90,12 +90,12 @@ export function clearPipelineCache(): void {
 
 /**
  * Generate a cache key for a pipeline that includes all configuration options
- * that affect pipeline creation (modelPath, pipeline, dType, device)
+ * that affect pipeline creation (model_path, pipeline, dtype, device)
  */
 function getPipelineCacheKey(model: HfTransformersOnnxModelConfig): string {
-  const dType = model.provider_config.dType || "q8";
+  const dtype = model.provider_config.dtype || "q8";
   const device = model.provider_config.device || "";
-  return `${model.provider_config.modelPath}:${model.provider_config.pipeline}:${dType}:${device}`;
+  return `${model.provider_config.model_path}:${model.provider_config.pipeline}:${dtype}:${device}`;
 }
 
 /**
@@ -379,9 +379,9 @@ const getPipeline = async (
   };
 
   const pipelineOptions: PretrainedModelOptions = {
-    dtype: model.provider_config.dType || "q8",
-    ...(model.provider_config.useExternalDataFormat
-      ? { use_external_data_format: model.provider_config.useExternalDataFormat }
+    dtype: model.provider_config.dtype || "q8",
+    ...(model.provider_config.use_external_data_format
+      ? { useExternalDataFormat: model.provider_config.use_external_data_format }
       : {}),
     ...(model.provider_config.device ? { device: model.provider_config.device as any } : {}),
     ...options,
@@ -412,7 +412,7 @@ const getPipeline = async (
   });
 
   // Race between pipeline creation and abort
-  const pipelinePromise = pipeline(pipelineType, model.provider_config.modelPath, pipelineOptions);
+  const pipelinePromise = pipeline(pipelineType, model.provider_config.model_path, pipelineOptions);
 
   try {
     const result = await (abortSignal
@@ -471,8 +471,8 @@ export const HFT_Unload: AiProviderRunFn<
   }
 
   // Delete model cache entries
-  const modelPath = model!.provider_config.modelPath;
-  await deleteModelCache(modelPath);
+  const model_path = model!.provider_config.model_path;
+  await deleteModelCache(model_path);
   onProgress(100, "Model cache deleted");
 
   return {
@@ -482,12 +482,12 @@ export const HFT_Unload: AiProviderRunFn<
 
 /**
  * Deletes all cache entries for a given model path
- * @param modelPath - The model path to delete from cache
+ * @param model_path - The model path to delete from cache
  */
-const deleteModelCache = async (modelPath: string): Promise<void> => {
+const deleteModelCache = async (model_path: string): Promise<void> => {
   const cache = await caches.open(HTF_CACHE_NAME);
   const keys = await cache.keys();
-  const prefix = `/${modelPath}/`;
+  const prefix = `/${model_path}/`;
 
   // Collect all matching requests first
   const requestsToDelete: Request[] = [];
@@ -534,20 +534,20 @@ export const HFT_TextEmbedding: AiProviderRunFn<
 
   // Generate the embedding
   const hfVector = await generateEmbedding(input.text, {
-    pooling: "mean",
+    pooling: model?.provider_config.pooling || "mean",
     normalize: model?.provider_config.normalize,
     ...(signal ? { abort_signal: signal } : {}),
   });
 
   // Validate the embedding dimensions
-  if (hfVector.size !== model?.provider_config.nativeDimensions) {
+  if (hfVector.size !== model?.provider_config.native_dimensions) {
     console.warn(
-      `HuggingFace Embedding vector length does not match model dimensions v${hfVector.size} != m${model?.provider_config.nativeDimensions}`,
+      `HuggingFace Embedding vector length does not match model dimensions v${hfVector.size} != m${model?.provider_config.native_dimensions}`,
       input,
       hfVector
     );
     throw new Error(
-      `HuggingFace Embedding vector length does not match model dimensions v${hfVector.size} != m${model?.provider_config.nativeDimensions}`
+      `HuggingFace Embedding vector length does not match model dimensions v${hfVector.size} != m${model?.provider_config.native_dimensions}`
     );
   }
 

packages/ai-provider/src/hf-transformers/common/HFT_ModelSchema.ts

@@ -25,11 +25,11 @@ export const HfTransformersOnnxModelSchema = {
           description: "Pipeline type for the ONNX model.",
           default: "text-generation",
         },
-        modelPath: {
+        model_path: {
           type: "string",
           description: "Filesystem path or URI for the ONNX model.",
         },
-        dType: {
+        dtype: {
           type: "string",
           enum: Object.values(QuantizationDataType),
           description: "Data type for the ONNX model.",
@@ -41,42 +41,50 @@ export const HfTransformersOnnxModelSchema = {
           description: "High-level device selection.",
           default: "webgpu",
         },
-        executionProviders: {
+        execution_providers: {
           type: "array",
           items: { type: "string" },
           description: "Raw ONNX Runtime execution provider identifiers.",
           "x-ui-hidden": true,
         },
-        intraOpNumThreads: {
+        intra_op_num_threads: {
           type: "integer",
           minimum: 1,
         },
-        interOpNumThreads: {
+        inter_op_num_threads: {
           type: "integer",
           minimum: 1,
         },
-        useExternalDataFormat: {
+        use_external_data_format: {
           type: "boolean",
           description: "Whether the model uses external data format.",
         },
-        nativeDimensions: {
+        native_dimensions: {
           type: "integer",
           description: "The native dimensions of the model.",
         },
+        pooling: {
+          type: "string",
+          enum: ["mean", "last_token", "cls"],
+          description: "The pooling strategy to use for the model.",
+          default: "mean",
+        },
         normalize: {
           type: "boolean",
           description: "Whether the model uses normalization.",
+          default: true,
         },
-        languageStyle: {
+        language_style: {
           type: "string",
           description: "The language style of the model.",
         },
         mrl: {
           type: "boolean",
           description: "Whether the model uses matryoshka.",
+          default: false,
         },
       },
-      required: ["modelPath", "pipeline"],
+      required: ["model_path", "pipeline"],
       additionalProperties: false,
       if: {
         properties: {
@@ -86,7 +94,7 @@ export const HfTransformersOnnxModelSchema = {
         },
       },
       then: {
-        required: ["nativeDimensions"],
+        required: ["native_dimensions"],
       },
     },
   },

packages/ai-provider/src/tf-mediapipe/common/TFMP_JobRunFns.ts

@@ -86,10 +86,10 @@ const getWasmTask = async (
   onProgress: (progress: number, message?: string, details?: any) => void,
   signal: AbortSignal
 ): Promise<TFMPWasmFileset> => {
-  const taskEngine = model.provider_config.taskEngine;
+  const task_engine = model.provider_config.task_engine;
 
-  if (wasm_tasks.has(taskEngine)) {
-    return wasm_tasks.get(taskEngine)!;
+  if (wasm_tasks.has(task_engine)) {
+    return wasm_tasks.get(task_engine)!;
   }
 
   if (signal.aborted) {
@@ -100,7 +100,7 @@ const getWasmTask = async (
 
   let wasmFileset: TFMPWasmFileset;
 
-  switch (taskEngine) {
+  switch (task_engine) {
     case "text":
       wasmFileset = await FilesetResolver.forTextTasks(
         "https://cdn.jsdelivr.net/npm/@mediapipe/tasks-text@latest/wasm"
@@ -125,7 +125,7 @@ const getWasmTask = async (
       throw new PermanentJobError("Invalid task engine");
   }
 
-  wasm_tasks.set(taskEngine, wasmFileset);
+  wasm_tasks.set(task_engine, wasmFileset);
   return wasmFileset;
 };
 
@@ -160,7 +160,7 @@ type TaskInstance =
 interface CachedModelTask {
   readonly task: TaskInstance;
   readonly options: Record<string, unknown>;
-  readonly taskEngine: string;
+  readonly task_engine: string;
 }
 
 const modelTaskCache = new Map<string, CachedModelTask[]>();
@@ -219,11 +219,11 @@ const getModelTask = async <T extends TaskType>(
   signal: AbortSignal,
   TaskType: T
 ): Promise<InferTaskInstance<T>> => {
-  const modelPath = model.provider_config.modelPath;
-  const taskEngine = model.provider_config.taskEngine;
+  const model_path = model.provider_config.model_path;
+  const task_engine = model.provider_config.task_engine;
 
   // Check if we have a cached instance with matching options
-  const cachedTasks = modelTaskCache.get(modelPath);
+  const cachedTasks = modelTaskCache.get(model_path);
   if (cachedTasks) {
     const matchedTask = cachedTasks.find((cached) => optionsMatch(cached.options, options));
     if (matchedTask) {
@@ -239,20 +239,20 @@ const getModelTask = async <T extends TaskType>(
   // Create new model instance
   const task = await TaskType.createFromOptions(wasmFileset, {
     baseOptions: {
-      modelAssetPath: modelPath,
+      modelAssetPath: model_path,
     },
     ...options,
   });
 
   // Cache the task with its options and task engine
-  const cachedTask: CachedModelTask = { task, options, taskEngine };
-  if (!modelTaskCache.has(modelPath)) {
-    modelTaskCache.set(modelPath, []);
+  const cachedTask: CachedModelTask = { task, options, task_engine };
+  if (!modelTaskCache.has(model_path)) {
+    modelTaskCache.set(model_path, []);
   }
-  modelTaskCache.get(modelPath)!.push(cachedTask);
+  modelTaskCache.get(model_path)!.push(cachedTask);
 
   // Increment WASM reference count for this cached task
-  wasm_reference_counts.set(taskEngine, (wasm_reference_counts.get(taskEngine) || 0) + 1);
+  wasm_reference_counts.set(task_engine, (wasm_reference_counts.get(task_engine) || 0) + 1);
 
   return task as any;
 };
@@ -314,8 +314,8 @@ export const TFMP_Download: AiProviderRunFn<
   onProgress(0.9, "Pipeline loaded");
   task.close(); // Close the task to release the resources, but it is still in the browser cache
   // Decrease reference count for WASM fileset for this cached task since this is a fake model cache entry
-  const taskEngine = model?.provider_config.taskEngine;
-  wasm_reference_counts.set(taskEngine, wasm_reference_counts.get(taskEngine)! - 1);
+  const task_engine = model?.provider_config.task_engine;
+  wasm_reference_counts.set(task_engine, wasm_reference_counts.get(task_engine)! - 1);
 
   return {
     model: input.model,
@@ -435,31 +435,31 @@ export const TFMP_Unload: AiProviderRunFn<
   UnloadModelTaskExecuteOutput,
   TFMPModelConfig
 > = async (input, model, onProgress, signal) => {
-  const modelPath = model!.provider_config.modelPath;
+  const model_path = model!.provider_config.model_path;
   onProgress(10, "Unloading model");
   // Dispose of all cached model tasks if they exist
-  if (modelTaskCache.has(modelPath)) {
-    const cachedTasks = modelTaskCache.get(modelPath)!;
+  if (modelTaskCache.has(model_path)) {
+    const cachedTasks = modelTaskCache.get(model_path)!;
 
     for (const cachedTask of cachedTasks) {
       const task = cachedTask.task;
       if ("close" in task && typeof task.close === "function") task.close();
 
       // Decrease reference count for WASM fileset for this cached task
-      const taskEngine = cachedTask.taskEngine;
-      const currentCount = wasm_reference_counts.get(taskEngine) || 0;
+      const task_engine = cachedTask.task_engine;
+      const currentCount = wasm_reference_counts.get(task_engine) || 0;
       const newCount = currentCount - 1;
 
       if (newCount <= 0) {
         // No more models using this WASM fileset, unload it
-        wasm_tasks.delete(taskEngine);
-        wasm_reference_counts.delete(taskEngine);
+        wasm_tasks.delete(task_engine);
+        wasm_reference_counts.delete(task_engine);
       } else {
-        wasm_reference_counts.set(taskEngine, newCount);
+        wasm_reference_counts.set(task_engine, newCount);
       }
     }
 
-    modelTaskCache.delete(modelPath);
+    modelTaskCache.delete(model_path);
   }
 
   return {

packages/ai-provider/src/tf-mediapipe/common/TFMP_ModelSchema.ts

@@ -19,11 +19,11 @@ export const TFMPModelSchema = {
       type: "object",
       description: "TensorFlow MediaPipe-specific options.",
       properties: {
-        modelPath: {
+        model_path: {
           type: "string",
           description: "Filesystem path or URI for the ONNX model.",
         },
-        taskEngine: {
+        task_engine: {
           type: "string",
           enum: ["text", "audio", "vision", "genai"],
           description: "Task engine for the MediaPipe model.",
@@ -34,7 +34,7 @@ export const TFMPModelSchema = {
           description: "Pipeline task type for the MediaPipe model.",
         },
       },
-      required: ["modelPath", "taskEngine", "pipeline"],
+      required: ["model_path", "task_engine", "pipeline"],
       additionalProperties: false,
     },
   },

packages/ai/README.md

@@ -52,7 +52,7 @@ await modelRepo.addModel({
   provider: HF_TRANSFORMERS_ONNX,
   provider_config: {
     pipeline: "text2text-generation",
-    modelPath: "Xenova/LaMini-Flan-T5-783M"
+    model_path: "Xenova/LaMini-Flan-T5-783M"
 });
 
 // 3. Register provider functions (inline, same thread)

packages/tasks/package.json

@@ -5,21 +5,27 @@
   "description": "Pre-built task implementations for Workglow, including common AI operations and utility functions.",
   "scripts": {
     "watch": "concurrently -c 'auto' 'bun:watch-*'",
-    "watch-code": "bun build --watch --no-clear-screen --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/index.ts",
+    "watch-browser": "bun build --watch --no-clear-screen --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/browser.ts",
+    "watch-node": "bun build --watch --no-clear-screen --target=node --sourcemap=external --packages=external --outdir ./dist ./src/node.ts",
+    "watch-bun": "bun build --watch --no-clear-screen --target=bun --sourcemap=external --packages=external --outdir ./dist ./src/bun.ts",
     "watch-types": "tsc --watch --preserveWatchOutput",
-    "build-package": "bun run build-clean && concurrently -c 'auto' -n 'code,types' 'bun run build-code' 'bun run build-types'",
+    "build-package": "bun run build-clean && concurrently -c 'auto' -n 'browser,node,bun,types' 'bun run build-browser' 'bun run build-node' 'bun run build-bun' 'bun run build-types'",
     "build-clean": "rm -fr dist/*",
-    "build-code": "bun build --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/index.ts",
+    "build-browser": "bun build --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/browser.ts",
+    "build-node": "bun build --target=node --sourcemap=external --packages=external --outdir ./dist ./src/node.ts",
+    "build-bun": "bun build --target=bun --sourcemap=external --packages=external --outdir ./dist ./src/bun.ts",
     "build-types": "rm -f tsconfig.tsbuildinfo && tsc",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "test": "bun test",
-    "prepare": "node -e \"const pkg=require('./package.json');pkg.exports['.'].bun='./dist/index.js';pkg.exports['.'].types='./dist/types.d.ts';require('fs').writeFileSync('package.json',JSON.stringify(pkg,null,2))\""
+    "prepare": "node -e \"const pkg=require('./package.json');pkg.exports['.'].bun='./dist/bun.js';pkg.exports['.'].types='./dist/types.d.ts';require('fs').writeFileSync('package.json',JSON.stringify(pkg,null,2))\""
   },
   "exports": {
     ".": {
-      "bun": "./dist/index.js",
+      "react-native": "./dist/browser.js",
+      "browser": "./dist/browser.js",
+      "bun": "./dist/bun.js",
       "types": "./dist/types.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/node.js"
     }
   },
   "files": [

packages/tasks/src/browser.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from "./common";
+export * from "./task/FileLoaderTask";

packages/tasks/src/bun.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from "./common";
+export * from "./task/FileLoaderTask.server";