onnxruntime/js/web/lib/onnxjs/util.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

1406 lines
45 KiB
TypeScript

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import { flatbuffers } from 'flatbuffers';
import Long from 'long';
import { Graph } from './graph';
import { onnxruntime } from './ort-schema/flatbuffers/ort-generated';
import { onnx } from './ort-schema/protobuf/onnx';
import { Tensor } from './tensor';
// check the inputs shape before running an OP.
// return true when the inputs pass the check
// return false when the inputs do not fit the requirement
// throw exception when fatal error or not implemented
export function checkInputsShape(inputs: Tensor[], ...expectedDimensions: number[]): boolean {
if (!inputs || inputs.length !== expectedDimensions.length) {
return false;
}
for (let i = 0; i < inputs.length; i++) {
if (!inputs[i].dims || inputs[i].dims.length !== expectedDimensions[i]) {
return false;
}
}
return true;
}
// Evaluates the given expression and asserts error message if condition is unmet.
export function assert(expr: boolean, msg: () => string) {
if (!expr) {
throw new Error(typeof msg === 'string' ? msg : msg());
}
}
export class ArrayUtil {
/**
* Verifies if 2 input arrays contain the same elements.
* @param n1 Array 1
* @param n2 Array 2
* @returns Whether these 2 are equal
*/
static arraysEqual(
n1:
| readonly number[]
| Int8Array
| Uint8Array
| Int16Array
| Uint16Array
| Int32Array
| Uint32Array
| Uint8ClampedArray
| Float32Array
| Float64Array,
n2:
| readonly number[]
| Int8Array
| Uint8Array
| Int16Array
| Uint16Array
| Int32Array
| Uint32Array
| Uint8ClampedArray
| Float32Array
| Float64Array,
) {
if (n1.length !== n2.length) {
return false;
}
for (let i = 0; i < n1.length; i++) {
if (n1[i] !== n2[i]) {
return false;
}
}
return true;
}
}
export class MatMulUtil {
/**
* Fix the input shapes for MatMul operation if they need fixing
* @param dimsA The shape of tensor A. Should be an array of positive integers
* @param dimsB The shape of tensor B. Should be an array of positive integers
* @returns A tuple containing the preprocessed input shapes as required by ONNX specifications
*/
static preprocessInputShapes(
dimsA: readonly number[],
dimsB: readonly number[],
): [readonly number[], readonly number[]] {
// If the first argument is 1-D, it is promoted to a matrix by prepending
// a 1 to its dimensions. After matrix multiplication the prepended 1 is
// removed.
const a = dimsA.length === 1 ? [1, dimsA[0]] : dimsA;
// If the second argument is 1-D, it is promoted to a matrix by appending
// a 1 to its dimensions. After matrix multiplication the appended 1 is
// removed.
const b = dimsB.length === 1 ? [dimsB[0], 1] : dimsB;
return [a, b];
}
/**
* Fix the output shape computed for MatMul operation if it needs fixing
* @param outputShape The computed outputShape. Should be an array (atleast of length 2) of positive integers.
* This will be mutated.
* @param aRank The rank of tensor A.
* @param bRank The rank of tensor B.
*/
static postprocessOutputShape(outputShape: number[], aRank: number, bRank: number) {
// Remove prepended dimension if first input is 1d
if (aRank === 1) {
// outputShape = outputShape.slice(0, outputShape.length - 2).concat(outputShape.slice(outputShape.length - 1));
outputShape.splice(outputShape.length - 2, 1);
}
// Remove appended dimension if second input is 1d
if (bRank === 1) {
outputShape.pop();
}
}
/**
* Calculate the expected shape when matrix multiplication
* @param a The shape of tensor A. Should be a tuple of 2 positive integers
* @param b The shape of tensor B. Should be a tuple of 2 positive integers
* @returns The expected shape of the result, or undefined if N/A
*/
static calcMatMulShape(a: [number, number], b: [number, number]): [number, number] | undefined {
return a[1] !== b[0] ? undefined : [a[0], b[1]];
}
}
export class BroadcastUtil {
/**
* Calculate the expected shape when broadcasting 2 tensors
* @param a The shape of tensor A. Should be an array of positive integers
* @param b The shape of tensor B. Should be an array of positive integers
* @param isMatMul Whether the operation is MatMul
* @returns The expected shape of the result, or undefined if N/A
*/
static calcShape(
adims: readonly number[],
bdims: readonly number[],
isMatMul = false,
): readonly number[] | undefined {
const arank = adims.length;
const brank = bdims.length;
if (arank === 0) {
return bdims;
}
if (brank === 0) {
return adims;
}
const crank = Math.max(adims.length, bdims.length);
const cdims = new Array<number>(crank);
// calculate the last 2 dimension if it is MatMul
if (isMatMul) {
if (arank < 2 || brank < 2) {
return undefined;
}
const cShapeMatMul = MatMulUtil.calcMatMulShape(
[adims[arank - 2], adims[arank - 1]],
[bdims[brank - 2], bdims[brank - 1]],
);
if (cShapeMatMul === undefined) {
return undefined;
}
[cdims[crank - 2], cdims[crank - 1]] = cShapeMatMul;
}
for (let i = isMatMul ? 3 : 1; i <= crank; i++) {
const aLen = arank - i < 0 ? 1 : adims[arank - i];
const bLen = brank - i < 0 ? 1 : bdims[brank - i];
if (aLen !== bLen && aLen > 1 && bLen > 1) {
return undefined;
}
cdims[crank - i] = Math.max(aLen, bLen);
}
return cdims;
}
/**
* Given the indices of a broadcasted tensor, calculate the original indices
* @param broadcastedIndices The given indices of the broadcasted tensor.
* @param originalShape The original shape of the tensor before broadcas
* @returns The calculated indices that maps to the original tensor.
*/
static index(broadcastedIndices: readonly number[], originalShape: readonly number[]): number[] {
// NOTE 1: we assume the parameter broadcastedIndices is valid. ie. it should have the same
// length as the broadcasted shape, and for each dimension the index should
// not be out of range.
const originalIndices = new Array(originalShape.length);
BroadcastUtil.fillIndex(broadcastedIndices, originalShape, originalIndices);
return originalIndices;
}
/**
* Given the indices of a broadcasted tensor, calculate the original indices
* @param broadcastedIndices The given indices of the broadcasted tensor.
* @param originalShape The original shape of the tensor before broadcast
* @param originalIndices The mapping of broadcastedIndices to the originalIndices (output parameter - will be
* mutated).
*/
static fillIndex(broadcastedIndices: readonly number[], originalShape: readonly number[], originalIndices: number[]) {
// NOTE 1: we assume the parameter broadcastedIndices is valid. ie. it should have the same length as the
// broadcasted shape, and for each dimension the index should not be out of range.
// NOTE 2: we assume the parameter originalIndices has the same length as the originalShape
const dimOffset = broadcastedIndices.length - originalShape.length;
for (let i = 0; i < originalShape.length; i++) {
originalIndices[i] = broadcastedIndices[dimOffset + i] % originalShape[i];
}
}
/**
* Perform the broadcasting operation on the specific operator
* @param a The input tensor A
* @param b The input tensor B
* @param op The operator lambda function
* @param inplace Whether to write the result back to A.
* @returns The result tensor, or undefined if input not broadcastable.
*/
static calc(
a: Tensor,
b: Tensor,
op: (a: string | number, b: string | number) => string | number,
inplace: boolean,
resultType?: Tensor.DataType,
): Tensor | undefined {
const outputShape = BroadcastUtil.calcShape(a.dims, b.dims);
if (outputShape) {
if (inplace && !ShapeUtil.areEqual(outputShape, a.dims)) {
// B is not broadcastable to A, failed to calculate inplace.
return undefined;
}
const size = ShapeUtil.size(outputShape);
const c = inplace ? a : new Tensor(outputShape, resultType || a.type);
// both inputs are scalars
if (outputShape.length === 0) {
c.set([], op(a.get([]) as number, b.get([]) as number));
}
// atleast one input is a non-scalar
else {
const outputIndices = new Array<number>(outputShape.length);
const originalIndicesA = new Array(a.dims.length);
const originalIndicesB = new Array(b.dims.length);
let valA: string | number = 0;
let valB: string | number = 0;
let isAScalar = false;
let isBScalar = false;
if (a.dims.length === 0) {
valA = a.get([]) as number;
isAScalar = true;
}
if (b.dims.length === 0) {
valB = b.get([]) as number;
isBScalar = true;
}
let rest: number;
for (let i = 0; i < size; i++) {
// traversal indices
rest = i;
for (let j = outputShape.length - 1; j >= 0; j--) {
outputIndices[j] = rest % outputShape[j];
rest = Math.floor(rest / outputShape[j]);
}
if (!isAScalar) {
// map outputIndices (which is actually broadcasted) to the originalIndices
BroadcastUtil.fillIndex(outputIndices, a.dims, originalIndicesA);
valA = a.get(originalIndicesA) as number;
}
if (!isBScalar) {
BroadcastUtil.fillIndex(outputIndices, b.dims, originalIndicesB);
valB = b.get(originalIndicesB) as number;
}
c.set(outputIndices, op(valA, valB));
}
}
return c;
}
return undefined;
}
/**
* Determine if a shape is unidirectional broadcastable to another shape
* @param shape The input shape
* @param finalShape The desired shape after broadcasting
*/
static isValidBroadcast(shape: readonly number[], finalShape: readonly number[]): boolean {
// align shape to the right
const inputRank = shape.length;
const finalRank = finalShape.length;
if (inputRank > finalRank) {
return false;
}
for (let i = 1; i <= inputRank; i++) {
if (shape[inputRank - i] !== 1 && shape[inputRank - i] !== finalShape[finalRank - i]) {
return false;
}
}
return true;
}
/**
* Determine the broadcasted dims in input shape based on the given output shape.
* Note that this function only returns the broadcasted dims.
* @param inputShape The input shape
* @param outputShape The output shape
* @returns The broadcasted dims in input shape.
*/
static getBroadcastDims(inputShape: readonly number[], outputShape: readonly number[]): number[] {
const inRank = inputShape.length;
const dims: number[] = [];
for (let i = 0; i < inRank; i++) {
const dim = inRank - 1 - i;
const a = inputShape[dim] || 1;
const b = outputShape[outputShape.length - 1 - i] || 1;
if (b > 1 && a === 1) {
dims.unshift(dim);
}
}
return dims;
}
}
// copy array helper
// mimics memcpy as much as possible
export function arrayCopyHelper(
target: number[] | Tensor.NumberType,
source: number[] | Tensor.NumberType,
targetIndex: number,
sourceIndex: number,
blockSize: number,
) {
if (sourceIndex < 0 || sourceIndex >= source.length) {
throw new Error('sourceIndex out of bounds');
}
if (targetIndex < 0 || targetIndex >= target.length) {
throw new Error('targetIndex out of bounds');
}
if (sourceIndex + blockSize > source.length) {
throw new Error('source indices to be copied are outside bounds');
}
if (targetIndex + blockSize > target.length) {
throw new Error('target array is too small to hold result');
}
for (let offset = 0; offset < blockSize; offset++) {
target[targetIndex + offset] = source[sourceIndex + offset];
}
}
export class GemmUtil {
// will make sure input shapes are compatible for this op
// and return back the shape of the output in the form of a tuple
// will throw exception if the input shapes are not compatible
static getShapeOfGemmResult(
leftShape: readonly number[],
transLeft: boolean,
rightShape: readonly number[],
transRight: boolean,
biasShape?: readonly number[],
): readonly number[] {
if (leftShape.length !== 2 || rightShape.length !== 2) {
throw new Error('shape need to be of size 2');
}
let M: number;
let K: number;
let N: number;
if (transLeft) {
M = leftShape[1];
K = leftShape[0];
} else {
M = leftShape[0];
K = leftShape[1];
}
let kDim = -1;
if (transRight) {
N = rightShape[0];
kDim = 1;
} else {
N = rightShape[1];
kDim = 0;
}
if (rightShape[kDim] !== K) {
throw new Error('dimension mismatch');
}
if (M <= 0 || N <= 0 || K <= 0) {
throw new Error('invalid shape specified');
}
if (biasShape && !BroadcastUtil.isValidBroadcast(biasShape, [M, N])) {
throw new Error('gemm: invalid bias shape for broadcast');
}
return [M, N, K];
}
}
export class ProtoUtil {
static tensorDataTypeFromProto(
typeProto: onnx.TensorProto.DataType | onnxruntime.experimental.fbs.TensorDataType,
): Tensor.DataType {
switch (typeProto) {
case onnx.TensorProto.DataType.INT8:
return 'int8';
case onnx.TensorProto.DataType.UINT8:
return 'uint8';
case onnx.TensorProto.DataType.BOOL:
return 'bool';
case onnx.TensorProto.DataType.INT16:
return 'int16';
case onnx.TensorProto.DataType.UINT16:
return 'uint16';
case onnx.TensorProto.DataType.INT32:
return 'int32';
case onnx.TensorProto.DataType.UINT32:
return 'uint32';
case onnx.TensorProto.DataType.FLOAT:
return 'float32';
case onnx.TensorProto.DataType.DOUBLE:
return 'float64';
case onnx.TensorProto.DataType.STRING:
return 'string';
// For INT64/UINT64, reduce their value to 32-bits.
// Should throw exception when overflow
case onnx.TensorProto.DataType.INT64:
return 'int32';
case onnx.TensorProto.DataType.UINT64:
return 'uint32';
default:
throw new Error(`unsupported data type: ${onnx.TensorProto.DataType[typeProto]}`);
}
}
static tensorDataTypeStringToEnum(type: string): onnx.TensorProto.DataType {
switch (type) {
case 'int8':
return onnx.TensorProto.DataType.INT8;
case 'uint8':
return onnx.TensorProto.DataType.UINT8;
case 'bool':
return onnx.TensorProto.DataType.BOOL;
case 'int16':
return onnx.TensorProto.DataType.INT16;
case 'uint16':
return onnx.TensorProto.DataType.UINT16;
case 'int32':
return onnx.TensorProto.DataType.INT32;
case 'uint32':
return onnx.TensorProto.DataType.UINT32;
case 'float32':
return onnx.TensorProto.DataType.FLOAT;
case 'float64':
return onnx.TensorProto.DataType.DOUBLE;
case 'string':
return onnx.TensorProto.DataType.STRING;
case 'int64':
return onnx.TensorProto.DataType.INT64;
case 'uint64':
return onnx.TensorProto.DataType.UINT64;
default:
throw new Error(`unsupported data type: ${type}`);
}
}
static tensorDimsFromProto(dims: Array<number | Long>): number[] {
// get rid of Long type for dims
return dims.map((d) => (Long.isLong(d) ? d.toNumber() : d));
}
static tensorValueTypeFromProto(valueType: onnx.TypeProto.ITensor): Graph.ValueType {
return {
tensorType: ProtoUtil.tensorDataTypeFromProto(valueType.elemType!),
shape: { dims: ProtoUtil.tensorDimsFromProto(valueType.shape!.dim!.map((d) => d.dimValue!)) },
};
}
static tensorDimsFromORTFormat(tensor: onnxruntime.experimental.fbs.Tensor) {
const dims = [];
for (let i = 0; i < tensor.dimsLength(); i++) {
dims.push(LongUtil.longToNumber(tensor.dims(i)!));
}
return dims;
}
static tensorAttributesFromORTFormat(node: onnxruntime.experimental.fbs.Node) {
const attributes = [];
for (let i = 0; i < node.attributesLength(); i++) {
attributes.push(node.attributes(i)!);
}
return attributes;
}
}
export class LongUtil {
// This function is called to get a number from long type of data for attribute, dim, and ir version,
// which values are signed integers.
// To make it more generic, add an optional parameter to convert to a unsigned number.
static longToNumber(n: Long | flatbuffers.Long | number, unsigned?: boolean) {
if (Long.isLong(n)) {
return n.toNumber();
} else if (n instanceof flatbuffers.Long) {
return Long.fromValue({ low: n.low, high: n.high, unsigned: unsigned ?? false }).toNumber();
}
return n;
}
static isLong(n: unknown) {
return Long.isLong(n) || n instanceof flatbuffers.Long;
}
}
export class ShapeUtil {
static size(dims: readonly number[]): number {
return ShapeUtil.getSizeFromDimensionRange(dims, 0, dims.length);
}
// `axis` inclusive
static sizeFromDimension(dims: readonly number[], axis: number): number {
if (axis < 0 || axis > dims.length) {
throw new Error(`invalid dimension of ${axis} for sizeFromDimension as Tensor has ${dims.length} dimensions.`);
}
return ShapeUtil.getSizeFromDimensionRange(dims, axis, dims.length);
}
// `axis` exclusive
static sizeToDimension(dims: readonly number[], axis: number): number {
if (axis < 0 || axis > dims.length) {
throw new Error(`invalid dimension of ${axis} for sizeToDimension as Tensor has ${dims.length} dimensions.`);
}
return ShapeUtil.getSizeFromDimensionRange(dims, 0, axis);
}
static getSizeFromDimensionRange(dims: readonly number[], start: number, end: number): number {
let size = 1;
for (let i = start; i < end; i++) {
// safety check as this method is called by multiple other methods requiring size.
// size cannot be 0 or negative.
if (dims[i] <= 0) {
throw new Error(
// eslint-disable-next-line max-len
'cannot get valid size from specified dimension range. Most likely the range contains 0 or negative values in them.',
);
}
size *= dims[i];
}
return size;
}
static computeStrides(dims: readonly number[]): readonly number[] {
const rank = dims.length;
if (rank === 0) {
return [];
} else if (rank === 1) {
return [1];
}
const strides = new Array(rank);
strides[rank - 1] = 1;
strides[rank - 2] = dims[rank - 1];
for (let i = rank - 3; i >= 0; --i) {
strides[i] = strides[i + 1] * dims[i + 1];
}
return strides;
}
static transpose(dims: readonly number[]): readonly number[] {
const copy = dims.slice();
return copy.reverse();
}
static indicesToOffset(indices: readonly number[], strides: readonly number[], axis?: number): number {
if (axis === undefined) {
axis = indices.length;
}
let offset = 0;
for (let i = 0; i < axis; ++i) {
offset += strides[i] * indices[i];
}
return offset;
}
static offsetToIndices(offset: number, strides: readonly number[]): readonly number[] {
const rank = strides.length;
if (rank === 0) {
return [];
} else if (rank === 1) {
return [offset * strides[0]];
}
const indices: number[] = new Array(strides.length);
for (let i = 0; i < indices.length - 1; ++i) {
indices[i] = Math.floor(offset / strides[i]);
offset -= indices[i] * strides[i];
}
indices[indices.length - 1] = offset;
return indices;
}
/**
* normailze axis of range [-r, r) into [0, r).
*/
static normalizeAxis(axis: number, tensorRank: number): number {
if (axis < -tensorRank && axis >= tensorRank) {
throw new Error('unsupported axis for this operation.');
}
return axis < 0 ? axis + tensorRank : axis;
}
static normalizeAxes(axes: readonly number[], tensorRank: number): number[] {
return axes.map((x) => this.normalizeAxis(x, tensorRank));
}
// Increment an index into a tensor (in lexicographic
// ordering), wrapping around the specified upper_bound.
/**
* Increment an index into a tensor (in lexicographic ordering), wrapping around the specified upper_bound.
* @param index Given index to increment (Will be mutated)
* @param dims The dimensions of the tensor for which the given index corresponds to
* @param axisToIncrementOn The 1-indexed axis to increment on. If undefined, axisToIncrementOn == rank
*/
static incrementIndex(index: number[], dims: readonly number[], axisToIncrementOn?: number) {
if (dims.length === 0 || index.length === 0) {
throw new Error('Index incrementing unsupported for scalar Tensor');
}
if (axisToIncrementOn === undefined) {
axisToIncrementOn = dims.length;
} else {
if (axisToIncrementOn <= 0 || axisToIncrementOn > dims.length) {
throw new Error('Incorrect axis to increment on');
}
}
for (let k = axisToIncrementOn - 1; k >= 0; --k) {
index[k]++;
if (index[k] < dims[k]) {
break;
}
index[k] = 0;
}
}
/**
* Produces a new dimensions array based on the values in the 'originalDimensions' and 'shape' array
* Used in Reshape
* @param originalDims Original Shape array
* @param shapeHints array containing values to compute the new dimensions
* For example:
* originalDims = [2,2] and shapeHints = [0,-1] will return [2,2]
* originalDims = [2,2] and shapeHints = [4] will return [4]
* originalDims = [2,2] and shapeHints = [5] will throw an exception
* https://github.com/onnx/onnx/blob/main/docs/Operators.md#Reshape
*/
static calculateReshapedDims(originalDims: readonly number[], shapeHints: ArrayLike<number>): number[] {
// reshape to a Scalar Tensor
if (shapeHints.length === 0) {
if (originalDims.length === 0 || ShapeUtil.size(originalDims) === 1) {
return [];
} else {
throw new Error('cannot reshape to a scalar Tensor');
}
}
const nDims = shapeHints.length;
const reshapedDims = new Array<number>(nDims);
let unknownDimension = -1;
let newTensorSize = 1;
for (let i = 0; i < nDims; i++) {
if (shapeHints[i] < -1) {
throw new Error('a dimension in shape hints cannot be less than -1');
}
if (shapeHints[i] === -1) {
if (unknownDimension !== -1) {
throw new Error('at most one dimension in shape hints can be -1');
}
unknownDimension = i;
} else {
if (shapeHints[i] === 0) {
if (i >= originalDims.length) {
throw new Error('the dimension with value zero exceeds the dimension size of the input tensor');
}
reshapedDims[i] = originalDims[i];
} else {
reshapedDims[i] = shapeHints[i];
}
newTensorSize *= reshapedDims[i];
}
}
const oldTensorSize = ShapeUtil.size(originalDims);
if (unknownDimension !== -1) {
if (oldTensorSize % newTensorSize !== 0) {
throw new Error(
`the input tensor cannot be reshaped to the requested shape. Input shape: [${
originalDims
}] Output shape: [${shapeHints}]`,
);
}
reshapedDims[unknownDimension] = oldTensorSize / newTensorSize;
}
// validate sizes from originalDims and reshapedDims match
else {
if (newTensorSize !== oldTensorSize) {
throw new Error("reshapedDims and originalDims don't have matching sizes");
}
}
return reshapedDims;
}
/**
* Sorts a given array based on the indices in the Perm array
* Used in Transpose
* @param a Array to be sorted such as dims or strides
* @param perm Perm given; if null a will be reversed
*/
static sortBasedOnPerm(a: readonly number[], perm?: readonly number[]): readonly number[] {
if (perm) {
return perm.map((v) => a[v]);
} else {
return a.slice().reverse();
}
}
/**
* Pads a given shape according to the padding values
* @param dims shape of the Tensor to be padded
* @param pad pad values
*/
static padShape(dims: readonly number[], pad: readonly number[]): readonly number[] {
const rank = dims.length;
return dims.map((v, i) => v + pad[i] + pad[i + rank]);
}
/**
* Determines if the two shapes are identical
* @param shape1
* @param shape2
*/
static areEqual(shape1: readonly number[], shape2: readonly number[]): boolean {
if (shape1.length !== shape2.length) {
return false;
}
return shape1.every((v, i) => v === shape2[i]);
}
/**
* Validates if the given `dims` or `shape` is valid in ONNX.js context and returns data size
* @param dims - input `dims` that needs to be checked
*/
static validateDimsAndCalcSize(dims: readonly number[]): number {
if (dims.length > 6) {
throw new TypeError('Only rank 0 to 6 is supported for tensor shape.');
}
let size = 1;
for (const n of dims) {
if (!Number.isInteger(n)) {
throw new TypeError(`Invalid shape: ${n} is not an integer`);
}
if (n < 0 || n > 2147483647) {
throw new TypeError(`Invalid shape: length ${n} is not allowed`);
}
size *= n;
}
return size;
}
/**
* Determines the shape of output tensor y = flatten(x, axis)
* @param dims - shape of input tensor
* @param axis - flatten axis, in the range [-r, r]
*/
static flattenShape(dims: readonly number[], axis: number): readonly number[] {
if (axis < 0) {
axis += dims.length;
}
const total = dims.reduce((x, y) => x * y, 1);
const right = dims.slice(axis).reduce((x, y) => x * y, 1);
const outputDims = [total / right, right];
return outputDims;
}
/**
* Determines the shape of output tensor y = squeeze(x, axes)
* @param dims - shape of input tensor
* @param axes - squeeze axes
*/
static squeezeShape(dims: readonly number[], axes: readonly number[]): readonly number[] {
const outputDims = new Array<number>();
// sanity check
axes = ShapeUtil.normalizeAxes(axes, dims.length);
for (let i = 0; i < dims.length; i++) {
const inSqueezeList = axes.indexOf(i) >= 0;
if (inSqueezeList && dims[i] !== 1) {
throw new Error('squeeze an axis of size different than 1');
}
if ((axes.length === 0 && dims[i] > 1) || (axes.length > 0 && !inSqueezeList)) {
outputDims.push(dims[i]);
}
}
return outputDims;
}
/**
* Determines the shape of output tensor y = unsqueeze(x, axes)
* @param dims - shape of input tensor
* @param axes - unsqueeze axes
*/
static unsqueezeShape(dims: readonly number[], axes: readonly number[]): readonly number[] {
const outputDims = new Array<number>(dims.length + axes.length);
// initialize the array elements to 0
outputDims.fill(0);
// set all axes indices to 1 in outputDims and check for duplicates
for (let i = 0; i < axes.length; i++) {
const axis = ShapeUtil.normalizeAxis(axes[i], outputDims.length);
if (axis >= outputDims.length) {
throw new Error("'axes' has an out of range axis");
}
if (outputDims[axis] !== 0) {
throw new Error("'axes' has a duplicate axis");
}
outputDims[axis] = 1;
}
// fill in the zero entries of outputDims with the input tensor's shape
let inputDimsIterator = 0;
for (let i = 0; i < outputDims.length; i++) {
if (outputDims[i] === 0) {
outputDims[i] = dims[inputDimsIterator++];
}
}
// sanity check assertion. 'inputDimsIterator'
// should be equal to the length of 'dims'
if (inputDimsIterator !== dims.length) {
throw new Error('the unsqueezed dimension could not be established');
}
return outputDims;
}
}
// bunch of helper methods that do a variety of math operations
export class MathUtil {
// y = (x*x) + y
static sqr(
target: number[] | Tensor.NumberType,
source: number[] | Tensor.NumberType,
targetIndex: number,
sourceIndex: number,
blockSize: number,
) {
if (sourceIndex < 0 || sourceIndex >= source.length) {
throw new Error('sourceIndex out of bounds');
}
if (targetIndex < 0 || targetIndex >= target.length) {
throw new Error('targetIndex out of bounds');
}
if (sourceIndex + blockSize > source.length) {
throw new Error('source indices to be copied are outside bounds');
}
if (targetIndex + blockSize > target.length) {
throw new Error('target array is too small to hold result');
}
for (let offset = 0; offset < blockSize; offset++) {
target[targetIndex + offset] += Math.pow(source[sourceIndex + offset], 2);
}
}
// y = ax + y
static axpy(
target: number[] | Tensor.NumberType,
source: number[] | Tensor.NumberType,
targetIndex: number,
sourceIndex: number,
blockSize: number,
alpha: number,
) {
if (sourceIndex < 0 || sourceIndex >= source.length) {
throw new Error('sourceIndex out of bounds');
}
if (targetIndex < 0 || targetIndex >= target.length) {
throw new Error('targetIndex out of bounds');
}
if (sourceIndex + blockSize > source.length) {
throw new Error('source indices to be copied are outside bounds');
}
if (targetIndex + blockSize > target.length) {
throw new Error('target array is too small to hold result');
}
for (let offset = 0; offset < blockSize; offset++) {
target[targetIndex + offset] += alpha * source[sourceIndex + offset];
}
}
// y = pow(x, b)
static powx(
target: number[] | Tensor.NumberType,
source: number[] | Tensor.NumberType,
targetIndex: number,
sourceIndex: number,
blockSize: number,
b: number,
) {
if (sourceIndex < 0 || sourceIndex >= source.length) {
throw new Error('sourceIndex out of bounds');
}
if (targetIndex < 0 || targetIndex >= target.length) {
throw new Error('targetIndex out of bounds');
}
if (sourceIndex + blockSize > source.length) {
throw new Error('source indices to be copied are outside bounds');
}
if (targetIndex + blockSize > target.length) {
throw new Error('target array is too small to hold result');
}
for (let offset = 0; offset < blockSize; offset++) {
target[targetIndex + offset] = Math.pow(source[sourceIndex + offset], b);
}
}
// y = x * y
static mul(
target: number[] | Tensor.NumberType,
source: number[] | Tensor.NumberType,
targetIndex: number,
sourceIndex: number,
blockSize: number,
) {
if (sourceIndex < 0 || sourceIndex >= source.length) {
throw new Error('sourceIndex out of bounds');
}
if (targetIndex < 0 || targetIndex >= target.length) {
throw new Error('targetIndex out of bounds');
}
if (sourceIndex + blockSize > source.length) {
throw new Error('source indices to be copied are outside bounds');
}
if (targetIndex + blockSize > target.length) {
throw new Error('target array is too small to hold result');
}
for (let offset = 0; offset < blockSize; offset++) {
target[targetIndex + offset] = source[sourceIndex + offset] * target[targetIndex + offset];
}
}
}
export class SplitUtil {
/**
* Calculates new Shapes from existing one and the splits given along the axis provides
* @param dims Shape of the Tensor to be splitted into two or more Shapes
* @param axis The dimension along which the Tensor will be split
* @param splits Offsets for the start of each split
*/
static splitShape(
dims: readonly number[],
axis: number,
split: number[],
numOutputs?: number,
): [number[][], number[]] {
if (split.length === 0) {
if (!numOutputs) {
throw new Error("need to know number of outputs when the 'split' attribute is not specified");
}
SplitUtil.determineSplit(dims[axis], numOutputs, split);
}
const shapes: number[][] = [];
const offsets = [0];
for (let i = 0; i < split.length; ++i) {
if (i !== 0) {
offsets.push(offsets[i - 1] + split[i - 1]);
}
const shape = dims.slice();
shape[axis] = split[i];
shapes.push(shape);
}
return [shapes, offsets];
}
static determineSplit(numElementsAlongAxis: number, numOutputs: number, split: number[]) {
// If 'split' is not specified by the user, we need to partition the number of elements equally among the outputs
if (numElementsAlongAxis % numOutputs !== 0) {
throw new Error('cannot split tensor to equal sized parts');
}
for (let i = 0; i < numOutputs; ++i) {
split.push(numElementsAlongAxis / numOutputs);
}
}
}
export class ReduceUtil {
/**
* Perform reduce operations on the specific operator
* @param a Input tensor data
* @param axes The dimensions along which the Tensor will be reduced
* @param keepdims If set to true, the axes which are reduced are left in the
* result as dimensions with size one.
* @param op1 The operation to be performed on each element in the tensor
* @param op2 The operation to be performed between elements in the tensor
*/
static calcReduce(
a: Tensor,
axes: number[],
keepdims: boolean,
op1: (b: number) => number,
op2: (a: number, b: number) => number,
): Tensor {
const dims = a.dims.slice(0);
// if axes is not set, perform reduce on all axes
if (axes.length === 0) {
dims.forEach((_d, ind) => axes.push(ind));
}
// get a temporary broadcastable output shape
const outputDims = ReduceUtil.calcReduceShape(dims, axes, true);
// loop through the output and calculate result one by one
const size = ShapeUtil.size(outputDims);
const y = new Tensor(outputDims, a.type);
const strides = ShapeUtil.computeStrides(outputDims);
const inputStrides = ShapeUtil.computeStrides(dims);
const indicesY = new Array(dims.length);
for (let i = 0; i < size; i++) {
const indices = ShapeUtil.offsetToIndices(i, strides);
// map index
BroadcastUtil.fillIndex(indices, dims, indicesY);
y.set(
indices,
ReduceUtil.calcReduceByAxis(
a.numberData,
axes,
dims,
0,
ShapeUtil.indicesToOffset(indicesY, inputStrides),
op1,
op2,
),
);
}
if (keepdims) {
return y;
} else {
// keepdims == 0, calculate the expected shape
return new Tensor(
ReduceUtil.calcReduceShape(dims, axes, keepdims),
y.type,
undefined,
undefined,
y.data,
y.dataId,
);
}
}
/**
* Perform reduce operations on the specific operator on specific axes
* @param a Input tensor data
* @param axes The dimensions along which the Tensor will be reduced
* @param dims The input dimension.
* @param curAxisInd Index in axes specifying the current dimension along
* which the tensor will be reduced
* @param pos The current index of element to perform operation
* @param op1 The operation to be performed on each element in the tensor
* @param op2 The operation to be performed between elements in the tensor
*/
static calcReduceByAxis(
input: Tensor.NumberType,
axes: number[],
dims: number[],
curAxisInd: number,
pos: number,
op1: (b: number) => number,
op2: (a: number, b: number) => number,
): number {
let res = 0;
if (curAxisInd >= axes.length) {
return op1(input[pos]);
}
const axis = axes[curAxisInd];
const step = axis >= dims.length ? 1 : ShapeUtil.size(dims.slice(axis + 1));
for (let i = 0; i < dims[axis]; i++) {
res =
i === 0
? ReduceUtil.calcReduceByAxis(input, axes, dims, curAxisInd + 1, pos, op1, op2)
: op2(res, ReduceUtil.calcReduceByAxis(input, axes, dims, curAxisInd + 1, pos, op1, op2));
pos += step;
}
return res;
}
/**
* Calculate the expected shape of a reduce operation
* @param dims The input tensor dimension
* @param axes The dimensions along which the Tensor will be reduced
* @param keepdims If set to true, the axes which are reduced are left in the
* result as dimensions with size one.
*/
static calcReduceShape(dims: readonly number[], axes: readonly number[], keepDims: boolean): number[] {
const outputDims = dims.slice();
for (let i = 0; i < axes.length; i++) {
if (keepDims) {
outputDims[axes[i]] = 1;
} else {
outputDims[axes[i]] = 0;
}
}
return outputDims.filter((dim) => dim !== 0);
}
}
export class PoolConvUtil {
/**
* Adjust the kernel, strides, pads to correct rank. Set to default value if not present
* @param isGlobalOperator If true, perform global pooling.
* @param inputDims The input tensor dimension.
* @param kernelShape The size of the kernel along each axis.
* @param strides Stride along each axis.
* @param dilations Dilation along each axis.
* @param pads Padding for the beginning and ending along each axis.
*/
static adjustPoolAttributes(
isGlobalOperator: boolean,
inputDims: readonly number[],
kernelShape: number[],
strides: number[],
dilations: number[],
pads: number[],
) {
if (!isGlobalOperator && kernelShape.length !== inputDims.length - 2) {
throw new Error('length of specified kernel shapes should be 2 less than length of input dimensions');
}
if (isGlobalOperator) {
// adjust kernel shape to cover the input dims
for (let dim = 0; dim < inputDims.length - 2; dim++) {
if (dim >= kernelShape.length) {
kernelShape.push(inputDims[dim + 2]);
} else {
kernelShape[dim] = inputDims[dim + 2];
}
}
}
// adjust strides length to match kernel shape length
for (let dim = 0; dim < kernelShape.length; dim++) {
if (dim < strides.length) {
if (strides[dim] < 0) {
throw new Error('strides should be greater than or equal to 1');
}
} else {
strides.push(1);
}
}
// adjust dilation value
for (let dim = 0; dim < kernelShape.length; dim++) {
if (dim < dilations.length) {
if (dilations[dim] < 0) {
throw new Error('dilations should be greater than or equal to 1');
}
} else {
dilations.push(1);
}
}
// adjust pads length to match 2 * kernel shape length
for (let dim = 0; dim < kernelShape.length * 2; dim++) {
if (dim < pads.length) {
if (pads[dim] < 0) {
throw new Error('pad should be greater than or equal to 1');
}
} else {
pads.push(0);
}
}
// sanity checks for values in kernel shapes and pads
for (let dim = 0; dim < kernelShape.length; dim++) {
if (kernelShape[dim] <= 0) {
throw new Error('kernel shapes need to be greater than 0');
}
if (pads[dim] >= kernelShape[dim] || pads[dim + kernelShape.length] >= kernelShape[dim]) {
throw new Error('pads should be smaller than kernel');
}
}
}
// adjust pad values based on 'autoPad' attribute
static adjustPadsBasedOnAutoPad(
inputDims: readonly number[],
strides: readonly number[],
dilations: readonly number[],
kernelShape: readonly number[],
pads: number[],
autoPad?: string,
) {
if (!autoPad) {
return;
}
if (pads.length !== 2 * (inputDims.length - 2)) {
throw new Error('length of pads should be twice the length of data dimensions');
}
if (strides.length !== inputDims.length - 2) {
throw new Error('length of strides should be the length of data dimensions');
}
if (kernelShape.length !== inputDims.length - 2) {
throw new Error('length of kernel shapes should be the length of data dimensions');
}
for (let dim = 0; dim < inputDims.length - 2; dim++) {
PoolConvUtil.adjustPadAndReturnShape(
inputDims[dim + 2],
strides[dim],
dilations[dim],
kernelShape[dim],
pads,
dim,
dim + inputDims.length - 2,
autoPad,
);
}
}
/**
* Calculate the output shape for Pool ops based on input attributes. (Should be used only for Pool ops)
* @param isGlobalOperator If true, perform global pooling.
* @param inputDims The input tensor dimension. (inputs[0].dims)
* @param strides Stride along each axis.
* @param dilations Dilation along each axis.
* @param kernelShape The size of the kernel along each axis.
* @param pads Padding for the beginning and ending along each axis.
* @param autoPad DEPRECATED attribute supported for legacy models. Specifies how to implicitly calculate pads in each
* dimension. Can take values NOTSET, SAME_UPPER, SAME_LOWER, or VALID.
*/
static computePoolOutputShape(
isGlobalOperator: boolean,
inputDims: readonly number[],
strides: number[],
dilations: number[],
kernelShape: number[],
pads: number[],
autoPad?: string,
): number[] {
if (inputDims.length <= 0) {
throw new Error('input shape must be of size greater than 0');
}
// Add batch size and number of channels of output
const outputDims = [inputDims[0], inputDims[1]];
PoolConvUtil.computeShapeHelper(
isGlobalOperator,
inputDims,
outputDims,
strides,
dilations,
kernelShape,
pads,
autoPad,
);
return outputDims;
}
/**
* Calculate the output shape for Conv op based on input attributes. (Should be used only for Conv op)
* @param inputDims The input tensor dimension. (inputs[0].dims)
* @param filterDims The filter tensor dimension. (inputs[1].dims)
* @param strides Stride along each axis.
* @param kernelShape The size of the kernel along each axis.
* @param pads Padding for the beginning and ending along each axis.
* @param autoPad DEPRECATED attribute supported for legacy models. Specifies how to implicitly calculate pads in each
* dimension. Can take values NOTSET, SAME_UPPER, SAME_LOWER, or VALID.
*/
static computeConvOutputShape(
inputDims: readonly number[],
filterDims: readonly number[],
strides: number[],
dilations: number[],
kernelShape: number[],
pads: number[],
autoPad?: string,
): number[] {
if (inputDims.length <= 0 || filterDims.length <= 0) {
throw new Error('invalid input tensor dims or invalid filter tensor dims');
}
// Add batch size and number of channels of output
const outputDims = [inputDims[0], filterDims[0]];
PoolConvUtil.computeShapeHelper(false, inputDims, outputDims, strides, dilations, kernelShape, pads, autoPad);
return outputDims;
}
// will compute output shapes for data dimensions ONLY (i.e.) no batch size and channels
// called by computePoolOutputShape() and computeConvOutputShape()
// adjust pads based on 'autoPad' attribute prior to shape computation
private static computeShapeHelper(
isGlobalOperator: boolean,
inputDims: readonly number[],
outputDims: number[],
strides: readonly number[],
dilations: readonly number[],
kernelShape: readonly number[],
pads: number[],
autoPad?: string,
) {
if (isGlobalOperator) {
for (let dim = 0; dim < inputDims.length - 2; dim++) {
outputDims.push(1);
}
} else {
for (let dim = 0; dim < inputDims.length - 2; dim++) {
outputDims.push(
PoolConvUtil.adjustPadAndReturnShape(
inputDims[dim + 2],
strides[dim],
dilations[dim],
kernelShape[dim],
pads,
dim,
dim + inputDims.length - 2,
autoPad,
),
);
}
}
}
// helper for computeShapeHelper() and adjustPadsBasedOnAutoPad()
// adjusts pad value for given 'autoPad' string and computes output shape along a particular dimension
private static adjustPadAndReturnShape(
inSize: number,
stride: number,
dilation: number,
kernel: number,
pads: number[],
padHeadIndex: number,
padTailIndex: number,
autoPad?: string,
): number {
const dkernel = dilation * (kernel - 1) + 1;
if (autoPad && autoPad !== 'NOTSET') {
switch (autoPad) {
case 'VALID':
pads[padHeadIndex] = 0;
pads[padTailIndex] = 0;
return Math.floor((inSize - dkernel) / stride + 1);
case 'SAME_LOWER':
case 'SAME_UPPER':
if (dilation !== 1) {
throw new Error('Dilation not supported for SAME_UPPER or SAME_LOWER');
} else {
const legacyTargetSize = (inSize + stride - 1) / stride;
const padNeeded = (legacyTargetSize - 1) * stride + kernel - inSize;
pads[padHeadIndex] = autoPad === 'SAME_LOWER' ? Math.floor((padNeeded + 1) / 2) : Math.floor(padNeeded / 2);
pads[padTailIndex] = padNeeded - pads[padHeadIndex];
return Math.floor((inSize + padNeeded - kernel) / stride + 1);
}
default:
throw new Error('Unsupported AutoPad type');
}
} else {
return Math.floor((inSize + pads[padHeadIndex] + pads[padTailIndex] - dkernel) / stride + 1);
}
}
}
export const MIN_CLIP = -3.4028234663852886e38;
export const MAX_CLIP = 3.4028234663852886e38;
export function decodeUtf8String(buffer: Uint8Array): string {
return new TextDecoder().decode(buffer);
}