mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-18 21:21:17 +00:00
6a5f469d44
### Description Following the design document: * Added CreateTrainingSessionHandler to the Backend interface * All existing Backend implementations throw an error for the new method createTrainingSessionHandler * Created TrainingSession namespace, interface, and TrainingSessionFactory interface * Created TrainingSessionImpl class implementation As methods are implemented, the TrainingSession interface will be added to or modified. ### Motivation and Context Adding the public-facing interfaces to the onnxruntime-common package is one of the first steps to support ORT training for web bindings. --------- Co-authored-by: Caroline Zhu <carolinezhu@microsoft.com>
76 lines
2.3 KiB
TypeScript
76 lines
2.3 KiB
TypeScript
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// Licensed under the MIT License.
|
|
|
|
import {InferenceSession} from './inference-session.js';
|
|
import {OnnxValue} from './onnx-value.js';
|
|
import {TrainingSession} from './training-session.js';
|
|
|
|
/**
|
|
* @ignore
|
|
*/
|
|
export declare namespace SessionHandler {
|
|
type FeedsType = {[name: string]: OnnxValue};
|
|
type FetchesType = {[name: string]: OnnxValue | null};
|
|
type ReturnType = {[name: string]: OnnxValue};
|
|
}
|
|
|
|
/**
|
|
* Represents shared SessionHandler functionality
|
|
*
|
|
* @ignore
|
|
*/
|
|
interface SessionHandler {
|
|
dispose(): Promise<void>;
|
|
|
|
readonly inputNames: readonly string[];
|
|
readonly outputNames: readonly string[];
|
|
}
|
|
|
|
/**
|
|
* Represent a handler instance of an inference session.
|
|
*
|
|
* @ignore
|
|
*/
|
|
export interface InferenceSessionHandler extends SessionHandler {
|
|
startProfiling(): void;
|
|
endProfiling(): void;
|
|
|
|
run(feeds: SessionHandler.FeedsType, fetches: SessionHandler.FetchesType,
|
|
options: InferenceSession.RunOptions): Promise<SessionHandler.ReturnType>;
|
|
}
|
|
|
|
/**
|
|
* Represent a handler instance of a training inference session.
|
|
*
|
|
* @ignore
|
|
*/
|
|
export interface TrainingSessionHandler extends SessionHandler {
|
|
runTrainStep(
|
|
feeds: SessionHandler.FeedsType, fetches: SessionHandler.FetchesType,
|
|
options: InferenceSession.RunOptions): Promise<SessionHandler.ReturnType>;
|
|
|
|
loadParametersBuffer(array: Uint8Array, trainableOnly: boolean): Promise<void>;
|
|
getContiguousParameters(trainableOnly: boolean): Promise<Uint8Array>;
|
|
}
|
|
|
|
/**
|
|
* Represent a backend that provides implementation of model inferencing.
|
|
*
|
|
* @ignore
|
|
*/
|
|
export interface Backend {
|
|
/**
|
|
* Initialize the backend asynchronously. Should throw when failed.
|
|
*/
|
|
init(): Promise<void>;
|
|
|
|
createInferenceSessionHandler(uriOrBuffer: string|Uint8Array, options?: InferenceSession.SessionOptions):
|
|
Promise<InferenceSessionHandler>;
|
|
|
|
createTrainingSessionHandler?
|
|
(checkpointStateUriOrBuffer: TrainingSession.URIorBuffer, trainModelUriOrBuffer: TrainingSession.URIorBuffer,
|
|
evalModelUriOrBuffer: TrainingSession.URIorBuffer, optimizerModelUriOrBuffer: TrainingSession.URIorBuffer,
|
|
options: InferenceSession.SessionOptions): Promise<TrainingSessionHandler>;
|
|
}
|
|
|
|
export {registerBackend} from './backend-impl.js';
|