mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-16 21:00:14 +00:00
b29849a287
### 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
29 lines
1 KiB
TypeScript
29 lines
1 KiB
TypeScript
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// Licensed under the MIT License.
|
|
|
|
/**
|
|
* # 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:
|
|
* - [Get Started](https://onnxruntime.ai/docs/get-started/with-javascript/)
|
|
* - [Inference examples](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js)
|
|
*
|
|
* @packageDocumentation
|
|
*/
|
|
|
|
export * from './backend.js';
|
|
export * from './env.js';
|
|
export * from './inference-session.js';
|
|
export * from './tensor.js';
|
|
export * from './tensor-conversion.js';
|
|
export * from './tensor-factory.js';
|
|
export * from './trace.js';
|
|
export * from './onnx-model.js';
|
|
export * from './onnx-value.js';
|
|
export * from './training-session.js';
|