forked from tensorflow/tfjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpassthrough.ts
More file actions
118 lines (110 loc) · 4.17 KB
/
passthrough.ts
File metadata and controls
118 lines (110 loc) · 4.17 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
/**
* @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.
* =============================================================================
*/
/**
* IOHandlers that pass through the in-memory ModelArtifacts format.
*/
import {IOHandler, ModelArtifacts, SaveResult, TrainingConfig, WeightsManifestEntry} from './types';
class PassthroughLoader implements IOHandler {
constructor(private readonly modelArtifacts?: ModelArtifacts) {}
async load(): Promise<ModelArtifacts> {
return this.modelArtifacts;
}
}
class PassthroughSaver implements IOHandler {
constructor(
private readonly saveHandler:
(artifacts: ModelArtifacts) => Promise<SaveResult>) {}
async save(modelArtifacts: ModelArtifacts) {
return this.saveHandler(modelArtifacts);
}
}
/**
* Creates an IOHandler that loads model artifacts from memory.
*
* When used in conjunction with `tf.loadLayersModel`, an instance of
* `tf.LayersModel` (Keras-style) can be constructed from the loaded artifacts.
*
* ```js
* const model = await tf.loadLayersModel(tf.io.fromMemory(
* modelTopology, weightSpecs, weightData));
* ```
*
* @param modelArtifacts a object containing model topology (i.e., parsed from
* the JSON format).
* @param weightSpecs An array of `WeightsManifestEntry` objects describing the
* names, shapes, types, and quantization of the weight data.
* @param weightData A single `ArrayBuffer` containing the weight data,
* concatenated in the order described by the weightSpecs.
* @param trainingConfig Model training configuration. Optional.
*
* @returns A passthrough `IOHandler` that simply loads the provided data.
*/
export function fromMemory(
modelArtifacts: {}|ModelArtifacts, weightSpecs?: WeightsManifestEntry[],
weightData?: ArrayBuffer, trainingConfig?: TrainingConfig): IOHandler {
if (arguments.length === 1) {
const isModelArtifacts =
(modelArtifacts as ModelArtifacts).modelTopology != null ||
(modelArtifacts as ModelArtifacts).weightSpecs != null;
if (isModelArtifacts) {
return new PassthroughLoader(modelArtifacts as ModelArtifacts);
} else {
// Legacy support: with only modelTopology.
// TODO(cais): Remove this deprecated API.
console.warn(
'Please call tf.io.fromMemory() with only one argument. ' +
'The argument should be of type ModelArtifacts. ' +
'The multi-argument signature of tf.io.fromMemory() has been ' +
'deprecated and will be removed in a future release.');
return new PassthroughLoader({modelTopology: modelArtifacts as {}});
}
} else {
// Legacy support.
// TODO(cais): Remove this deprecated API.
console.warn(
'Please call tf.io.fromMemory() with only one argument. ' +
'The argument should be of type ModelArtifacts. ' +
'The multi-argument signature of tf.io.fromMemory() has been ' +
'deprecated and will be removed in a future release.');
return new PassthroughLoader({
modelTopology: modelArtifacts as {},
weightSpecs,
weightData,
trainingConfig
});
}
}
/**
* Creates an IOHandler that passes saved model artifacts to a callback.
*
* ```js
* function handleSave(artifacts) {
* // ... do something with the artifacts ...
* return {modelArtifactsInfo: {...}, ...};
* }
*
* const saveResult = model.save(tf.io.withSaveHandler(handleSave));
* ```
*
* @param saveHandler A function that accepts a `ModelArtifacts` and returns a
* `SaveResult`.
*/
export function withSaveHandler(
saveHandler: (artifacts: ModelArtifacts) =>
Promise<SaveResult>): IOHandler {
return new PassthroughSaver(saveHandler);
}