Skip to content

[js][feature tracking] JavaScript library consume #14529

@fs-eire

Description

@fs-eire

This issue is for tracking tasks and separated issues that related to JavaScript library consumption. This includes TODO items, known issues and feature works that affect any forms of consuming ONNX Runtime JavaScript API via the following library:

  • onnxruntime-web
  • onnxruntime-node
  • onnxruntime-react-native

Work items tracking table

Works to be done for ORT-Web:

  1. support ES6 export. [web] ES6 modules #10913
    • currently the "module" field is not working in js/web/package.json. Need to:
      a. switch to ES module for webassembly
      b. use standard module export
      c. make webpack behavior correct
  2. support loading from worker/audio worklet. Initializing inference session on worker thread for web applications using onnxruntime-web #12589 [Web] Running onnxruntime in an audio worklet #13072
  3. support service worker. [Web] chrome V3 extension TypeError: URL.createObjectURL is not a function #14445
  4. support electron [Web] ort-wasm-simd.wasm can't be loaded in Electron renderer (using webpack) #13933
  5. support export for Node.js
  6. update package.json (exports field) so that different projects can consume onnxruntime-web with minimal modification to its webpack configuration. [Web] NPM package include ts files in the output #13736

Works to be done for ORT-Node:

  1. support GPU EP (Cuda/DML/...) Running onnxruntime with a gpu in nodejs? #14127
  2. electron compatibility onnxruntime-node crash the electron app[Web]  #13086

Example tracking table

The following table is used to track tasks for updating examples to consume ONNX Runtime JavaScript API

Category Status Description PR/Issue # Comments
onnxruntime-node Need update version JavaScript / CommonJS / No_Bundler link
onnxruntime-node Not started JavaScript / ESModule / No_Bundler
onnxruntime-node Not started JavaScript / CommonJS / Webpack Webpack does not deal with node native modules correctly #14505
onnxruntime-node Not started JavaScript / ESModule / Webpack
onnxruntime-web Need update version JavaScript / Web / scriptTag link
onnxruntime-web Need update version JavaScript / Web / CommonJS / Webpack link
onnxruntime-web Not started JavaScript / Web / ESModule / Webpack not working #14504
onnxruntime-web Not started JavaScript / Node / CommonJS / No_Bundler multi-thread CPU EP not available for onnxruntime-web in Node.js binding
onnxruntime-web Not started JavaScript / Node / ESModule / No_Bundler ESModule not available for onnxruntime-web in Node.js binding
onnxruntime-web Not started JavaScript / Node / CommonJS / Webpack

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationimprovements or additions to documentation; typically submitted using templatefeature requestrequest for unsupported feature or enhancementplatform:webissues related to ONNX Runtime web; typically submitted using template

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions