Interface GpuBufferConstructorParameters<T>

represent the parameter for constructing a tensor from a WebGPU buffer

interface GpuBufferConstructorParameters<
    T extends GpuBufferDataTypes = GpuBufferDataTypes,
> {
    dims: readonly number[];
    gpuBuffer: GpuBufferTypeFallback;
    location: "gpu-buffer";
    type: T;
    dispose?(): void;
    download?(): Promise<DataTypeMap[T]>;
}

Type Parameters

T extends GpuBufferDataTypes = GpuBufferDataTypes

Hierarchy

CommonConstructorParameters<T>
GpuResourceConstructorParameters<T>
- GpuBufferConstructorParameters

Index

Properties

dims gpuBuffer location type

Methods

dispose? download?

Properties

`Readonly`dims

dims: readonly number[]

Get the dimensions of the tensor.

`Readonly`gpuBuffer

gpuBuffer: GpuBufferTypeFallback

Specify the WebGPU buffer that holds the tensor data.

`Readonly`location

location: "gpu-buffer"

Specify the location of the data to be 'gpu-buffer'.

`Readonly`type

type: T

Specify the data type of the tensor.

Methods

`Optional`dispose

dispose?(): void
an optional callback function that will be called when the tensor is disposed.

If not provided, the tensor treat the GPU data as external resource.

Returns void
Inherited from GpuResourceConstructorParameters.dispose
- Defined in tensor-factory.ts:39

`Optional`download

download?(): Promise<DataTypeMap[T]>
an optional callback function to download data from GPU to CPU.

If not provided, the tensor treat the GPU data as external resource.

Returns Promise<DataTypeMap[T]>
Inherited from GpuResourceConstructorParameters.download
- Defined in tensor-factory.ts:32