onnxruntime/js/common
Yulong Wang 59f42cccb8
[js/common] refactor tensor type in onnxruntime-common (#15843)
### Description
<!-- Describe your changes. -->

refactor tensor type in onnxruntime-common.

### Motivation and Context
There major motivation is that I am doing a local change to address the
API part of #15312. And I am doing a refactoring of onnxruntime-common
anyway (#15772).

The `tensor.ts` and `tensor-impl.ts` are too large, so I split contents
into multiple files to make the type declarations clearer.

The original target of this change is for API only ( ie. do not refactor
any implementation.). However, there are a few type/implementation
inconsistencies so I also made minimal changes to fix them.

### Changes
- extract `TensorUtils` for non-template interfaces
- extract `TensorFactory` for all overloads of `Tensor.fromImage()`
- refactor options type that used for `Tensor.fromImage()`
- fix JSDoc comments to make option descriptions consistent with actual
type declarations
- fix an inconsistency for `options.format` and `options.bitmapFormat`;
change all `bitmapFormat` to `format`
- extract `ConversionUtils` for `tensor.toDataURL()` and
`tensor.toImageData()`
- put implementations into multiple files from `tensor-impl.ts`
- fix a bug that cause unittest fail. put comments for future fix.
2023-06-09 16:19:29 -07:00
..
lib [js/common] refactor tensor type in onnxruntime-common (#15843) 2023-06-09 16:19:29 -07:00
.gitignore [js/api] add typedoc and revise comments (#9077) 2021-09-20 17:54:46 -07:00
.npmignore [js/api] add typedoc and revise comments (#9077) 2021-09-20 17:54:46 -07:00
package-lock.json Update VERSION_NUMBER (#15773) 2023-05-03 15:07:34 -07:00
package.json Update VERSION_NUMBER (#15773) 2023-05-03 15:07:34 -07:00
README.md Replace 'master' branch ref to 'main' in the code (#12547) 2022-08-22 10:48:12 -07:00
tsconfig.json [web] utility functions for tensor<->image conversion in ORT web (#13603) 2023-01-12 09:05:18 -08:00
typedoc.json [js/api] add typedoc and revise comments (#9077) 2021-09-20 17:54:46 -07:00
webpack.config.js [js/web] optimize bundle file size (#9817) 2021-11-22 13:56:55 -08:00

ONNX Runtime JavaScript API

ONNX Runtime JavaScript API is a unified API for all JavaScript usages. It's dependency of the following NPM packages:

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

This package (onnxruntime-common) is not designed for using directly. Please consider to install one of the NPM packages above according to target platform.

License

License information can be found here.