mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-13 18:08:13 +00:00
[//]: # (## Work In Progress. Feedbacks are welcome!) ### Description This PR adds a few properties, methods and factories to Tensor type to support IO-binding feature. This will allow user to create tensor from GPU/CPU bound data without a force transferring of data between CPU and GPU. This change is a way to resolve #15312 ### Change Summary 1. Add properties to `Tensor` type: a. `location`: indicating where the data is sitting. valid values are `cpu`, `cpu-pinned`, `texture`, `gpu-buffer`. b. `texture`: sit side to `data`, a readonly property of `WebGLTexture` type. available only when `location === 'texture'` c. `gpuBuffer`: sit side to `data`, a readonly property of `GPUBuffer` type. available only when `location === 'gpu-buffer'` 2. Add methods to `Tensor` type (usually dealing with inference outputs): - async function `getData()` allows user to download data from GPU to CPU manually. - function `dispose()` allows user to release GPU resources manually. 3. Add factories for creating `Tensor` instances: a. `fromTexture()` to create a WebGL texture bound tensor data b. `fromGpuBuffer()` to create a WebGPUBuffer bound tensor data c. `fromPinnedBuffer()` to create a tensor using a CPU pinned buffer ### Examples: create tensors from texture and pass to inference session as inputs ```js // when create session, specify we prefer 'image_output:0' to be stored on GPU as texture const session = await InferenceSession.create('./my_model.onnx', { executionProviders: [ 'webgl' ], preferredOutputLocation: { 'image_output:0': 'texture' } }); ... const myImageTexture = getTexture(); // user's function to get a texture const myFeeds = { input0: Tensor.fromTexture(myImageTexture, { width: 224, height: 224 }) }; // shape [1, 224, 224, 4], RGBA format. const results = await session.run(myFeeds); const myOutputTexture = results['image_output:0'].texture; ```
94 lines
2.7 KiB
TypeScript
94 lines
2.7 KiB
TypeScript
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// Licensed under the MIT License.
|
|
|
|
import {env} from 'onnxruntime-common';
|
|
|
|
import {Backend, SessionHandler} from '../backend';
|
|
import {Logger} from '../instrument';
|
|
import {Session} from '../session';
|
|
|
|
import {WebGLSessionHandler} from './webgl/session-handler';
|
|
import {WebGLContext} from './webgl/webgl-context';
|
|
import {createWebGLContext} from './webgl/webgl-context-factory';
|
|
|
|
/**
|
|
* WebGLBackend is the entry point for all WebGL opeartions
|
|
* When it starts it created the WebGLRenderingContext
|
|
* and other main framework components such as Program and Texture Managers
|
|
*/
|
|
export class WebGLBackend implements Backend {
|
|
glContext: WebGLContext;
|
|
|
|
get contextId(): 'webgl'|'webgl2'|undefined {
|
|
return env.webgl.contextId;
|
|
}
|
|
set contextId(value: 'webgl'|'webgl2'|undefined) {
|
|
env.webgl.contextId = value;
|
|
}
|
|
|
|
get matmulMaxBatchSize(): number|undefined {
|
|
return env.webgl.matmulMaxBatchSize;
|
|
}
|
|
set matmulMaxBatchSize(value: number|undefined) {
|
|
env.webgl.matmulMaxBatchSize = value;
|
|
}
|
|
|
|
get textureCacheMode(): 'initializerOnly'|'full'|undefined {
|
|
return env.webgl.textureCacheMode;
|
|
}
|
|
set textureCacheMode(value: 'initializerOnly'|'full'|undefined) {
|
|
env.webgl.textureCacheMode = value;
|
|
}
|
|
|
|
get pack(): boolean|undefined {
|
|
return env.webgl.pack;
|
|
}
|
|
set pack(value: boolean|undefined) {
|
|
env.webgl.pack = value;
|
|
}
|
|
|
|
get async(): boolean|undefined {
|
|
return env.webgl.async;
|
|
}
|
|
set async(value: boolean|undefined) {
|
|
env.webgl.async = value;
|
|
}
|
|
|
|
initialize(): boolean {
|
|
try {
|
|
this.glContext = createWebGLContext(this.contextId);
|
|
if (typeof this.matmulMaxBatchSize !== 'number') {
|
|
this.matmulMaxBatchSize = 16;
|
|
}
|
|
if (typeof this.textureCacheMode !== 'string') {
|
|
this.textureCacheMode = 'full';
|
|
}
|
|
if (typeof this.pack !== 'boolean') {
|
|
this.pack = false;
|
|
}
|
|
if (typeof this.async !== 'boolean') {
|
|
this.async = false;
|
|
}
|
|
|
|
Logger.setWithEnv(env);
|
|
|
|
Object.defineProperty(env.webgl, 'context', {value: this.glContext.gl});
|
|
|
|
Logger.verbose(
|
|
'WebGLBackend',
|
|
`Created WebGLContext: ${typeof this.glContext} with matmulMaxBatchSize: ${
|
|
this.matmulMaxBatchSize}; textureCacheMode: ${this.textureCacheMode}; pack: ${this.pack}; async: ${
|
|
this.async}.`);
|
|
return true;
|
|
} catch (e) {
|
|
Logger.warning('WebGLBackend', `Unable to initialize WebGLBackend. ${e}`);
|
|
return false;
|
|
}
|
|
}
|
|
createSessionHandler(context: Session.Context): SessionHandler {
|
|
return new WebGLSessionHandler(this, context);
|
|
}
|
|
dispose(): void {
|
|
this.glContext.dispose();
|
|
}
|
|
}
|