358 lines
12 KiB
TypeScript
358 lines
12 KiB
TypeScript
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// Licensed under the MIT License.
|
|
|
|
import {Tensor as TensorImpl} from './tensor-impl';
|
|
import {TypedTensorUtils} from './tensor-utils';
|
|
|
|
/* eslint-disable @typescript-eslint/no-redeclare */
|
|
|
|
/**
|
|
* represent a basic tensor with specified dimensions and data type.
|
|
*/
|
|
interface TypedTensorBase<T extends Tensor.Type> {
|
|
/**
|
|
* Get the dimensions of the tensor.
|
|
*/
|
|
readonly dims: readonly number[];
|
|
/**
|
|
* Get the data type of the tensor.
|
|
*/
|
|
readonly type: T;
|
|
/**
|
|
* Get the buffer data of the tensor.
|
|
*/
|
|
readonly data: Tensor.DataTypeMap[T];
|
|
}
|
|
|
|
export declare namespace Tensor {
|
|
interface DataTypeMap {
|
|
float32: Float32Array;
|
|
uint8: Uint8Array;
|
|
int8: Int8Array;
|
|
uint16: Uint16Array;
|
|
int16: Int16Array;
|
|
int32: Int32Array;
|
|
int64: BigInt64Array;
|
|
string: string[];
|
|
bool: Uint8Array;
|
|
float16: never; // hold on using Uint16Array before we have a concrete solution for float 16
|
|
float64: Float64Array;
|
|
uint32: Uint32Array;
|
|
uint64: BigUint64Array;
|
|
// complex64: never;
|
|
// complex128: never;
|
|
// bfloat16: never;
|
|
}
|
|
|
|
interface ElementTypeMap {
|
|
float32: number;
|
|
uint8: number;
|
|
int8: number;
|
|
uint16: number;
|
|
int16: number;
|
|
int32: number;
|
|
int64: bigint;
|
|
string: string;
|
|
bool: boolean;
|
|
float16: never; // hold on before we have a concret solution for float 16
|
|
float64: number;
|
|
uint32: number;
|
|
uint64: bigint;
|
|
// complex64: never;
|
|
// complex128: never;
|
|
// bfloat16: never;
|
|
}
|
|
|
|
type DataType = DataTypeMap[Type];
|
|
type ElementType = ElementTypeMap[Type];
|
|
|
|
/**
|
|
* represent the data type of a tensor
|
|
*/
|
|
export type Type = keyof DataTypeMap;
|
|
}
|
|
|
|
/**
|
|
* Represent multi-dimensional arrays to feed to or fetch from model inferencing.
|
|
*/
|
|
export interface TypedTensor<T extends Tensor.Type> extends TypedTensorBase<T>, TypedTensorUtils<T> {}
|
|
/**
|
|
* Represent multi-dimensional arrays to feed to or fetch from model inferencing.
|
|
*/
|
|
export interface Tensor extends TypedTensorBase<Tensor.Type>, TypedTensorUtils<Tensor.Type> {}
|
|
|
|
export interface TensorConstructor {
|
|
// #region specify element type
|
|
/**
|
|
* Construct a new string tensor object from the given type, data and dims.
|
|
*
|
|
* @param type - Specify the element type.
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(type: 'string', data: Tensor.DataTypeMap['string']|readonly string[],
|
|
dims?: readonly number[]): TypedTensor<'string'>;
|
|
|
|
/**
|
|
* Construct a new bool tensor object from the given type, data and dims.
|
|
*
|
|
* @param type - Specify the element type.
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(type: 'bool', data: Tensor.DataTypeMap['bool']|readonly boolean[], dims?: readonly number[]): TypedTensor<'bool'>;
|
|
|
|
/**
|
|
* Construct a new numeric tensor object from the given type, data and dims.
|
|
*
|
|
* @param type - Specify the element type.
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new<T extends Exclude<Tensor.Type, 'string'|'bool'>>(
|
|
type: T, data: Tensor.DataTypeMap[T]|readonly number[], dims?: readonly number[]): TypedTensor<T>;
|
|
// #endregion
|
|
|
|
// #region infer element types
|
|
|
|
/**
|
|
* Construct a new float32 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Float32Array, dims?: readonly number[]): TypedTensor<'float32'>;
|
|
|
|
/**
|
|
* Construct a new int8 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Int8Array, dims?: readonly number[]): TypedTensor<'int8'>;
|
|
|
|
/**
|
|
* Construct a new uint8 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Uint8Array, dims?: readonly number[]): TypedTensor<'uint8'>;
|
|
|
|
/**
|
|
* Construct a new uint16 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Uint16Array, dims?: readonly number[]): TypedTensor<'uint16'>;
|
|
|
|
/**
|
|
* Construct a new int16 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Int16Array, dims?: readonly number[]): TypedTensor<'int16'>;
|
|
|
|
/**
|
|
* Construct a new int32 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Int32Array, dims?: readonly number[]): TypedTensor<'int32'>;
|
|
|
|
/**
|
|
* Construct a new int64 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: BigInt64Array, dims?: readonly number[]): TypedTensor<'int64'>;
|
|
|
|
/**
|
|
* Construct a new string tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: readonly string[], dims?: readonly number[]): TypedTensor<'string'>;
|
|
|
|
/**
|
|
* Construct a new bool tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: readonly boolean[], dims?: readonly number[]): TypedTensor<'bool'>;
|
|
|
|
/**
|
|
* Construct a new float64 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Float64Array, dims?: readonly number[]): TypedTensor<'float64'>;
|
|
|
|
/**
|
|
* Construct a new uint32 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Uint32Array, dims?: readonly number[]): TypedTensor<'uint32'>;
|
|
|
|
/**
|
|
* Construct a new uint64 tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: BigUint64Array, dims?: readonly number[]): TypedTensor<'uint64'>;
|
|
|
|
// #endregion
|
|
|
|
// #region fall back to non-generic tensor type declaration
|
|
|
|
/**
|
|
* Construct a new tensor object from the given type, data and dims.
|
|
*
|
|
* @param type - Specify the element type.
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(type: Tensor.Type, data: Tensor.DataType|readonly number[]|readonly boolean[], dims?: readonly number[]): Tensor;
|
|
|
|
/**
|
|
* Construct a new tensor object from the given data and dims.
|
|
*
|
|
* @param data - Specify the tensor data
|
|
* @param dims - Specify the dimension of the tensor. If omitted, a 1-D tensor is assumed.
|
|
*/
|
|
new(data: Tensor.DataType, dims?: readonly number[]): Tensor;
|
|
// #endregion
|
|
}
|
|
|
|
/**
|
|
* Specify the image format. Assume 'RGBA' if omitted.
|
|
*/
|
|
export type ImageFormat = 'RGB'|'RGBA'|'BGR'|'RBG';
|
|
|
|
/**
|
|
* Describes Tensor configuration to an image data.
|
|
*/
|
|
export interface TensorToImageDataOptions {
|
|
/**
|
|
* Describes Tensor channels order.
|
|
*/
|
|
format?: ImageFormat;
|
|
/**
|
|
* Tensor channel layout - default is 'NHWC'
|
|
*/
|
|
tensorLayout?: 'NHWC'|'NCHW';
|
|
/**
|
|
* Describes Tensor Height - can be accessed via tensor dimensions as well
|
|
*/
|
|
height?: number;
|
|
/**
|
|
* Describes Tensor Width - can be accessed via tensor dimensions as well
|
|
*/
|
|
width?: number;
|
|
/**
|
|
* Describes normalization parameters to ImageData conversion from tensor - default values - Bias: 0, Mean: 255
|
|
*/
|
|
norm?: {
|
|
bias?: number; // Todo add support - |[number,number,number]|[number,number,number,number];
|
|
mean?: number; // Todo add support - |[number,number,number]|[number,number,number,number];
|
|
};
|
|
}
|
|
/**
|
|
* Describes Tensor and Image configuration to an image data.
|
|
*/
|
|
export interface TensorFromImageOptions {
|
|
/**
|
|
* Describes image data format - will be used only in the case of ImageBitMap
|
|
*/
|
|
bitmapFormat?: ImageFormat;
|
|
/**
|
|
* Describes Tensor channels order - can differ from original image
|
|
*/
|
|
tensorFormat?: ImageFormat;
|
|
/**
|
|
* Tensor data type - default is 'float32'
|
|
*/
|
|
dataType?: 'float32'|'uint8';
|
|
/**
|
|
* Tensor channel layout - default is 'NHWC'
|
|
*/
|
|
tensorLayout?: 'NHWC'|'NCHW';
|
|
/**
|
|
* Describes Image Height - Required only in the case of ImageBitMap
|
|
*/
|
|
height?: number;
|
|
/**
|
|
* Describes Image Width - Required only in the case of ImageBitMap
|
|
*/
|
|
width?: number;
|
|
/**
|
|
* Describes resized height - can be accessed via tensor dimensions as well
|
|
*/
|
|
resizedHeight?: number;
|
|
/**
|
|
* Describes resized width - can be accessed via tensor dimensions as well
|
|
*/
|
|
resizedWidth?: number;
|
|
/**
|
|
* Describes normalization parameters to tensor conversion from image data - default values - Bias: 0, Mean: 255
|
|
*/
|
|
norm?: {
|
|
bias?: number; // Todo add support - |[number,number,number]|[number,number,number,number];
|
|
mean?: number; // Todo add support - |[number,number,number]|[number,number,number,number];
|
|
};
|
|
}
|
|
export interface TensorFactory {
|
|
/**
|
|
* create a tensor from image object - HTMLImageElement, ImageData, ImageBitmap, URL
|
|
*
|
|
* @param imageData - {ImageData} - composed of: Uint8ClampedArray, width. height - uses known pixel format RGBA
|
|
* @param options - Optional - Interface describing input image & output tensor -
|
|
* Input Defaults: RGBA, 3 channels, 0-255, NHWC - Output Defaults: same as input parameters
|
|
* @returns A promise that resolves to a tensor object
|
|
*/
|
|
fromImage(imageData: ImageData, options?: TensorFromImageOptions): Promise<Tensor>;
|
|
|
|
/**
|
|
* create a tensor from image object - HTMLImageElement, ImageData, ImageBitmap, URL
|
|
*
|
|
* @param imageElement - {HTMLImageElement} - since the data is stored as ImageData no need for format parameter
|
|
* @param options - Optional - Interface describing input image & output tensor -
|
|
* Input Defaults: RGBA, 3 channels, 0-255, NHWC - Output Defaults: same as input parameters
|
|
* @returns A promise that resolves to a tensor object
|
|
*/
|
|
fromImage(imageElement: HTMLImageElement, options?: TensorFromImageOptions): Promise<Tensor>;
|
|
|
|
/**
|
|
* create a tensor from image object - HTMLImageElement, ImageData, ImageBitmap, URL
|
|
*
|
|
* @param url - {string} - Assuming the string is a URL to an image
|
|
* @param options - Optional - Interface describing input image & output tensor -
|
|
* Input Defaults: RGBA, 3 channels, 0-255, NHWC - Output Defaults: same as input parameters
|
|
* @returns A promise that resolves to a tensor object
|
|
*/
|
|
fromImage(url: string, options?: TensorFromImageOptions): Promise<Tensor>;
|
|
|
|
/**
|
|
* create a tensor from image object - HTMLImageElement, ImageData, ImageBitmap, URL
|
|
*
|
|
* @param bitMap - {ImageBitmap} - since the data is stored as ImageData no need for format parameter
|
|
* @param options - NOT Optional - Interface describing input image & output tensor -
|
|
* Output Defaults: same as input parameters
|
|
* @returns A promise that resolves to a tensor object
|
|
*/
|
|
fromImage(bitmap: ImageBitmap, options: TensorFromImageOptions): Promise<Tensor>;
|
|
}
|
|
|
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
export const Tensor = TensorImpl as TensorConstructor;
|