onnxruntime/js/web/lib/wasm/proxy-messages.ts
Yulong Wang abdc31de40
[js] change default formatter for JavaScript/TypeScript from clang-format to Prettier (#21728)
### Description

See
454996d496
for manual changes (excluded auto-generated formatting changes)

### Why

Because the toolsets for old clang-format is out-of-date. This reduces
the development efficiency.

- The NPM package `clang-format` is already in maintenance mode. not
updated since 2 years ago.
- The VSCode extension for clang-format is not maintained for a while,
and a recent Node.js security update made it not working at all in
Windows.

No one in community seems interested in fixing those.

Choose Prettier as it is the most popular TS/JS formatter.

### How to merge

It's easy to break the build:
- Be careful of any new commits on main not included in this PR.
- Be careful that after this PR is merged, other PRs that already passed
CI can merge.

So, make sure there is no new commits before merging this one, and
invalidate js PRs that already passed CI, force them to merge to latest.
2024-08-14 16:51:22 -07:00

104 lines
2.8 KiB
TypeScript

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import type { Env, InferenceSession, Tensor } from 'onnxruntime-common';
/**
* Among all the tensor locations, only 'cpu' is serializable.
*/
export type SerializableTensorMetadata = [
dataType: Tensor.Type,
dims: readonly number[],
data: Tensor.DataType,
location: 'cpu',
];
export type GpuBufferMetadata = {
gpuBuffer: Tensor.GpuBufferType;
download?: () => Promise<Tensor.DataTypeMap[Tensor.GpuBufferDataTypes]>;
dispose?: () => void;
};
/**
* Tensors on location 'cpu-pinned' and 'gpu-buffer' are not serializable.
*/
export type UnserializableTensorMetadata =
| [dataType: Tensor.Type, dims: readonly number[], data: GpuBufferMetadata, location: 'gpu-buffer']
| [dataType: Tensor.Type, dims: readonly number[], data: Tensor.DataType, location: 'cpu-pinned'];
/**
* Tensor metadata is a tuple of [dataType, dims, data, location], where
* - dataType: tensor data type
* - dims: tensor dimensions
* - data: tensor data, which can be one of the following depending on the location:
* - cpu: Uint8Array
* - cpu-pinned: Uint8Array
* - gpu-buffer: GpuBufferMetadata
* - location: tensor data location
*/
export type TensorMetadata = SerializableTensorMetadata | UnserializableTensorMetadata;
export type SerializableSessionMetadata = [sessionHandle: number, inputNames: string[], outputNames: string[]];
export type SerializableInternalBuffer = [bufferOffset: number, bufferLength: number];
interface MessageError {
err?: string;
}
interface MessageInitWasm extends MessageError {
type: 'init-wasm';
in?: Env;
out?: never;
}
interface MessageInitEp extends MessageError {
type: 'init-ep';
in?: { env: Env; epName: string };
out?: never;
}
interface MessageCopyFromExternalBuffer extends MessageError {
type: 'copy-from';
in?: { buffer: Uint8Array };
out?: SerializableInternalBuffer;
}
interface MessageCreateSession extends MessageError {
type: 'create';
in?: { model: SerializableInternalBuffer | Uint8Array; options?: InferenceSession.SessionOptions };
out?: SerializableSessionMetadata;
}
interface MessageReleaseSession extends MessageError {
type: 'release';
in?: number;
out?: never;
}
interface MessageRun extends MessageError {
type: 'run';
in?: {
sessionId: number;
inputIndices: number[];
inputs: SerializableTensorMetadata[];
outputIndices: number[];
options: InferenceSession.RunOptions;
};
out?: SerializableTensorMetadata[];
}
interface MesssageEndProfiling extends MessageError {
type: 'end-profiling';
in?: number;
out?: never;
}
export type OrtWasmMessage =
| MessageInitWasm
| MessageInitEp
| MessageCopyFromExternalBuffer
| MessageCreateSession
| MessageReleaseSession
| MessageRun
| MesssageEndProfiling;