forked from tensorflow/tfjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodel_types.ts
More file actions
149 lines (136 loc) · 4.57 KB
/
model_types.ts
File metadata and controls
149 lines (136 loc) · 4.57 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/**
* @license
* Copyright 2018 Google LLC. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =============================================================================
*/
import {Tensor} from './tensor';
import {NamedTensorMap} from './tensor_types';
import {DataType} from './types';
export interface ModelPredictConfig {
/**
* Optional. Batch size (Integer). If unspecified, it will default to 32.
*/
batchSize?: number;
/**
* Optional. Verbosity mode. Defaults to false.
*/
verbose?: boolean;
}
/**
* Interface for model input/output tensor info.
*/
export interface ModelTensorInfo {
// Name of the tensor.
name: string;
// Tensor shape information, Optional.
shape?: number[];
// Data type of the tensor.
dtype: DataType;
}
/**
* Common interface for a machine learning model that can do inference.
*/
export interface InferenceModel {
/**
* Return the array of input tensor info.
*/
readonly inputs: ModelTensorInfo[];
/**
* Return the array of output tensor info.
*/
readonly outputs: ModelTensorInfo[];
/**
* Execute the inference for the input tensors.
*
* @param input The input tensors, when there is single input for the model,
* inputs param should be a Tensor. For models with multiple inputs, inputs
* params should be in either Tensor[] if the input order is fixed, or
* otherwise NamedTensorMap format.
* For batch inference execution, the tensors for each input need to be
* concatenated together. For example with mobilenet, the required input shape
* is [1, 244, 244, 3], which represents the [batch, height, width, channel].
* If we are provide a batched data of 100 images, the input tensor should be
* in the shape of [100, 244, 244, 3].
*
* @param config Prediction configuration for specifying the batch size.
*
* @returns Inference result tensors. The output would be single Tensor if
* model has single output node, otherwise Tensor[] or NamedTensorMap[] will
* be returned for model with multiple outputs.
*/
predict(inputs: Tensor|Tensor[]|NamedTensorMap, config: ModelPredictConfig):
Tensor|Tensor[]|NamedTensorMap;
/**
* Single Execute the inference for the input tensors and return activation
* values for specified output node names without batching.
*
* @param input The input tensors, when there is single input for the model,
* inputs param should be a Tensor. For models with multiple inputs, inputs
* params should be in either Tensor[] if the input order is fixed, or
* otherwise NamedTensorMap format.
*
* @param outputs string|string[]. List of output node names to retrieve
* activation from.
*
* @returns Activation values for the output nodes result tensors. The return
* type matches specified parameter outputs type. The output would be single
* Tensor if single output is specified, otherwise Tensor[] for multiple
* outputs.
*/
execute(inputs: Tensor|Tensor[]|NamedTensorMap, outputs: string|string[]):
Tensor|Tensor[];
}
/**
* @deprecated Deprecated interface for SavedModel/GraphModel MetaGraph info.
* User MetaGraph instead.
*/
export interface MetaGraphInfo {
tags: string[];
signatureDefs: SignatureDefInfo;
}
/**
* @deprecated Deprecated interface for SavedModel/GraphModel SignatureDef info.
* User SignatureDef instead.
*/
export interface SignatureDefInfo {
[key: string]: {
inputs: {[key: string]: SavedModelTensorInfo};
outputs: {[key: string]: SavedModelTensorInfo};
};
}
/**
* @deprecated Deprecated interface for SavedModel/GraphModel signature
* input/output Tensor info. User ModelTensorInfo instead.
*/
export interface SavedModelTensorInfo {
dtype: string;
shape: number[];
name: string;
}
/**
* Interface for SavedModel/GraphModel MetaGraph info.
*/
export interface MetaGraph {
tags: string[];
signatureDefs: SignatureDef;
}
/**
* Interface for SavedModel/GraphModel SignatureDef info.
*/
export interface SignatureDef {
[key: string]: {
inputs: {[key: string]: ModelTensorInfo};
outputs: {[key: string]: ModelTensorInfo};
};
}