2020-05-05 18:45:12 +00:00
|
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
|
|
|
// Licensed under the MIT License.
|
|
|
|
|
|
2021-09-21 00:54:46 +00:00
|
|
|
/**
|
|
|
|
|
* # ONNX Runtime JavaScript API
|
|
|
|
|
*
|
|
|
|
|
* ONNX Runtime JavaScript API is a unified API for all JavaScript usages, including the following NPM packages:
|
|
|
|
|
*
|
|
|
|
|
* - [onnxruntime-node](https://www.npmjs.com/package/onnxruntime-node)
|
|
|
|
|
* - [onnxruntime-web](https://www.npmjs.com/package/onnxruntime-web)
|
|
|
|
|
* - [onnxruntime-react-native](https://www.npmjs.com/package/onnxruntime-react-native)
|
|
|
|
|
*
|
|
|
|
|
* See also:
|
2024-03-16 02:00:30 +00:00
|
|
|
* - [Get Started](https://onnxruntime.ai/docs/get-started/with-javascript/)
|
2021-09-21 00:54:46 +00:00
|
|
|
* - [Inference examples](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js)
|
|
|
|
|
*
|
|
|
|
|
* @packageDocumentation
|
|
|
|
|
*/
|
|
|
|
|
|
2023-06-12 19:05:11 +00:00
|
|
|
export * from './backend.js';
|
|
|
|
|
export * from './env.js';
|
|
|
|
|
export * from './inference-session.js';
|
|
|
|
|
export * from './tensor.js';
|
[js/common] fix typedoc warnings (#19933)
### Description
Fix a few warnings in typedoc (for generating JS API):
```
[warning] The signature TrainingSession.loadParametersBuffer has an @param with name "buffer", which was not used.
[warning] NonTensorType, defined in ./lib/onnx-value.ts, is referenced by OnnxValue but not included in the documentation.
[warning] TensorFactory, defined in ./lib/tensor-factory.ts, is referenced by Tensor but not included in the documentation.
[warning] ExternalDataFileType, defined in ./lib/onnx-model.ts, is referenced by InferenceSession.SessionOptions.externalData but not included in the documentation.
[warning] TensorToDataUrlOptions, defined in ./lib/tensor-conversion.ts, is referenced by Tensor.toDataURL.toDataURL.options but not included in the documentation.
[warning] TensorToImageDataOptions, defined in ./lib/tensor-conversion.ts, is referenced by Tensor.toImageData.toImageData.options but not included in the documentation.
[warning] Failed to resolve link to "GpuBufferType" in comment for Env.WebGpuFlags.adapter.
[warning] Failed to resolve link to "GpuBufferType" in comment for Env.WebGpuFlags.device.
```
Changes highlighted:
- Merge `CoreMlExecutionProviderOption` and
`CoreMLExecutionProviderOption`. They expose 2 set of different options
for React-native and ORT nodejs binding. This should be fixed in future.
- Fix a few inconsistency of names between JSDoc and parameters
- Fix broken type links
- Exclude trace functions
2024-03-16 02:01:50 +00:00
|
|
|
export * from './tensor-conversion.js';
|
|
|
|
|
export * from './tensor-factory.js';
|
2024-01-03 18:13:17 +00:00
|
|
|
export * from './trace.js';
|
[js/common] fix typedoc warnings (#19933)
### Description
Fix a few warnings in typedoc (for generating JS API):
```
[warning] The signature TrainingSession.loadParametersBuffer has an @param with name "buffer", which was not used.
[warning] NonTensorType, defined in ./lib/onnx-value.ts, is referenced by OnnxValue but not included in the documentation.
[warning] TensorFactory, defined in ./lib/tensor-factory.ts, is referenced by Tensor but not included in the documentation.
[warning] ExternalDataFileType, defined in ./lib/onnx-model.ts, is referenced by InferenceSession.SessionOptions.externalData but not included in the documentation.
[warning] TensorToDataUrlOptions, defined in ./lib/tensor-conversion.ts, is referenced by Tensor.toDataURL.toDataURL.options but not included in the documentation.
[warning] TensorToImageDataOptions, defined in ./lib/tensor-conversion.ts, is referenced by Tensor.toImageData.toImageData.options but not included in the documentation.
[warning] Failed to resolve link to "GpuBufferType" in comment for Env.WebGpuFlags.adapter.
[warning] Failed to resolve link to "GpuBufferType" in comment for Env.WebGpuFlags.device.
```
Changes highlighted:
- Merge `CoreMlExecutionProviderOption` and
`CoreMLExecutionProviderOption`. They expose 2 set of different options
for React-native and ORT nodejs binding. This should be fixed in future.
- Fix a few inconsistency of names between JSDoc and parameters
- Fix broken type links
- Exclude trace functions
2024-03-16 02:01:50 +00:00
|
|
|
export * from './onnx-model.js';
|
2023-06-12 19:05:11 +00:00
|
|
|
export * from './onnx-value.js';
|
2023-09-30 02:05:10 +00:00
|
|
|
export * from './training-session.js';
|