This repository was archived by the owner on Jul 24, 2022. It is now read-only.
forked from dotnet/machinelearning
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathModelLoading.cs
More file actions
365 lines (325 loc) · 14.3 KB
/
Copy pathModelLoading.cs
File metadata and controls
365 lines (325 loc) · 14.3 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
using System;
using System.IO;
using System.Reflection;
using System.Text;
using Microsoft.ML.Internal.Utilities;
using Microsoft.ML.Runtime;
namespace Microsoft.ML
{
/// <summary>
/// Signature for a repository based model loader. This is the dual of <see cref="ICanSaveModel"/>.
/// </summary>
[BestFriend]
internal delegate void SignatureLoadModel(ModelLoadContext ctx);
internal sealed partial class ModelLoadContext : IDisposable
{
public const string ModelStreamName = "Model.key";
internal const string NameBinary = "Model.bin";
/// <summary>
/// Returns the new assembly name to maintain backward compatibility.
/// </summary>
private string ForwardedLoaderAssemblyName
{
get
{
string[] nameDetails = LoaderAssemblyName.Split(',');
switch (nameDetails[0])
{
case "Microsoft.ML.HalLearners":
nameDetails[0] = "Microsoft.ML.Mkl.Components";
break;
case "Microsoft.ML.StandardLearners":
nameDetails[0] = "Microsoft.ML.StandardTrainers";
break;
default:
return LoaderAssemblyName;
}
return string.Join(",", nameDetails);
}
}
/// <summary>
/// Return whether this context contains a directory and stream for a sub-model with
/// the indicated name. This does not attempt to load the sub-model.
/// </summary>
public bool ContainsModel(string name)
{
if (!InRepository)
return false;
if (string.IsNullOrEmpty(name))
return false;
var dir = Path.Combine(Directory ?? "", name);
var ent = Repository.OpenEntryOrNull(dir, ModelStreamName);
if (ent != null)
{
ent.Dispose();
return true;
}
if ((ent = Repository.OpenEntryOrNull(dir, NameBinary)) != null)
{
ent.Dispose();
return true;
}
return false;
}
/// <summary>
/// Load an optional object from the repository directory.
/// Returns false iff no stream was found for the object, iff result is set to null.
/// Throws if loading fails for any other reason.
/// </summary>
public static bool LoadModelOrNull<TRes, TSig>(IHostEnvironment env, out TRes result, RepositoryReader rep, string dir, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
env.CheckValue(rep, nameof(rep));
var ent = rep.OpenEntryOrNull(dir, ModelStreamName);
if (ent != null)
{
using (ent)
{
// Provide the repository, entry, and directory name to the loadable class ctor.
env.Assert(ent.Stream.Position == 0);
LoadModel<TRes, TSig>(env, out result, rep, ent, dir, extra);
return true;
}
}
if ((ent = rep.OpenEntryOrNull(dir, NameBinary)) != null)
{
using (ent)
{
env.Assert(ent.Stream.Position == 0);
LoadModel<TRes, TSig>(env, out result, ent.Stream, extra);
return true;
}
}
result = null;
return false;
}
/// <summary>
/// Load an object from the repository directory.
/// </summary>
public static void LoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, RepositoryReader rep, string dir, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
env.CheckValue(rep, nameof(rep));
if (!LoadModelOrNull<TRes, TSig>(env, out result, rep, dir, extra))
throw env.ExceptDecode("Corrupt model file");
env.AssertValue(result);
}
/// <summary>
/// Load a sub model from the given sub directory if it exists. This requires InRepository to be true.
/// Returns false iff no stream was found for the object, iff result is set to null.
/// Throws if loading fails for any other reason.
/// </summary>
public bool LoadModelOrNull<TRes, TSig>(IHostEnvironment env, out TRes result, string name, params object[] extra)
where TRes : class
{
_ectx.CheckValue(env, nameof(env));
_ectx.Check(InRepository, "Can't load a sub-model when reading from a single stream");
return LoadModelOrNull<TRes, TSig>(env, out result, Repository, Path.Combine(Directory ?? "", name), extra);
}
/// <summary>
/// Load a sub model from the given sub directory. This requires InRepository to be true.
/// </summary>
public void LoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, string name, params object[] extra)
where TRes : class
{
_ectx.CheckValue(env, nameof(env));
if (!LoadModelOrNull<TRes, TSig>(env, out result, name, extra))
throw _ectx.ExceptDecode("Corrupt model file");
_ectx.AssertValue(result);
}
/// <summary>
/// Try to load from the given repository entry using the default loader(s) specified in the header.
/// Returns false iff the default loader(s) could not be bound to a compatible loadable class.
/// </summary>
private static bool TryLoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, RepositoryReader rep, Repository.Entry ent, string dir, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
env.CheckValue(rep, nameof(rep));
long fp = ent.Stream.Position;
using (var ctx = new ModelLoadContext(rep, ent, dir))
{
env.Assert(fp == ctx.FpMin);
if (ctx.TryLoadModelCore<TRes, TSig>(env, out result, extra))
return true;
}
// TryLoadModelCore should rewind on failure.
Contracts.Assert(fp == ent.Stream.Position);
return false;
}
/// <summary>
/// Load from the given repository entry using the default loader(s) specified in the header.
/// </summary>
public static void LoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, RepositoryReader rep, Repository.Entry ent, string dir, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
env.CheckValue(rep, nameof(rep));
if (!TryLoadModel<TRes, TSig>(env, out result, rep, ent, dir, extra))
throw env.ExceptDecode("Couldn't load model: '{0}'", dir);
}
/// <summary>
/// Try to load from the given stream (non-Repository).
/// Returns false iff the default loader(s) could not be bound to a compatible loadable class.
/// </summary>
public static bool TryLoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, Stream stream, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
using (var reader = new BinaryReader(stream, Encoding.UTF8, leaveOpen: true))
return TryLoadModel<TRes, TSig>(env, out result, reader, extra);
}
/// <summary>
/// Load from the given stream (non-Repository) using the default loader(s) specified in the header.
/// </summary>
public static void LoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, Stream stream, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
if (!TryLoadModel<TRes, TSig>(env, out result, stream, extra))
throw Contracts.ExceptDecode("Couldn't load model");
}
/// <summary>
/// Try to load from the given reader (non-Repository).
/// Returns false iff the default loader(s) could not be bound to a compatible loadable class.
/// </summary>
public static bool TryLoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, BinaryReader reader, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
long fp = reader.BaseStream.Position;
using (var ctx = new ModelLoadContext(reader))
{
Contracts.Assert(fp == ctx.FpMin);
return ctx.TryLoadModelCore<TRes, TSig>(env, out result, extra);
}
}
/// <summary>
/// Load from the given reader (non-Repository) using the default loader(s) specified in the header.
/// </summary>
public static void LoadModel<TRes, TSig>(IHostEnvironment env, out TRes result, BinaryReader reader, params object[] extra)
where TRes : class
{
Contracts.CheckValue(env, nameof(env));
if (!TryLoadModel<TRes, TSig>(env, out result, reader, extra))
throw Contracts.ExceptDecode("Couldn't load model");
}
/// <summary>
/// Tries to load.
/// Returns false iff the default loader(s) could not be bound to a compatible loadable class.
/// </summary>
private bool TryLoadModelCore<TRes, TSig>(IHostEnvironment env, out TRes result, params object[] extra)
where TRes : class
{
_ectx.AssertValue(env, "env");
_ectx.Assert(Reader.BaseStream.Position == FpMin + Header.FpModel);
var args = ConcatArgsRev(extra, this);
EnsureLoaderAssemblyIsRegistered(env.ComponentCatalog);
object tmp;
string sig = ModelHeader.GetLoaderSig(ref Header);
if (!string.IsNullOrWhiteSpace(sig) &&
ComponentCatalog.TryCreateInstance<object, TSig>(env, out tmp, sig, "", args))
{
result = tmp as TRes;
if (result != null)
{
Done();
return true;
}
// REVIEW: Should this fall through?
}
_ectx.Assert(Reader.BaseStream.Position == FpMin + Header.FpModel);
string sigAlt = ModelHeader.GetLoaderSigAlt(ref Header);
if (!string.IsNullOrWhiteSpace(sigAlt) &&
ComponentCatalog.TryCreateInstance<object, TSig>(env, out tmp, sigAlt, "", args))
{
result = tmp as TRes;
if (result != null)
{
Done();
return true;
}
// REVIEW: Should this fall through?
}
_ectx.Assert(Reader.BaseStream.Position == FpMin + Header.FpModel);
Reader.BaseStream.Position = FpMin;
result = null;
return false;
}
private void EnsureLoaderAssemblyIsRegistered(ComponentCatalog catalog)
{
if (!string.IsNullOrEmpty(LoaderAssemblyName))
{
var assembly = Assembly.Load(ForwardedLoaderAssemblyName);
catalog.RegisterAssembly(assembly);
}
}
private static object[] ConcatArgsRev(object[] args2, params object[] args1)
{
Contracts.AssertNonEmpty(args1);
return Utils.Concat(args1, args2);
}
/// <summary>
/// Try to load a sub model from the given sub directory. This requires InRepository to be true.
/// </summary>
public bool TryProcessSubModel(string dir, Action<ModelLoadContext> action)
{
_ectx.Check(InRepository, "Can't Load a sub-model when reading from a single stream");
_ectx.CheckNonEmpty(dir, nameof(dir));
_ectx.CheckValue(action, nameof(action));
string path = Path.Combine(Directory, dir);
var ent = Repository.OpenEntryOrNull(path, ModelStreamName);
if (ent == null)
return false;
using (ent)
{
// Provide the repository, entry, and directory name to the loadable class ctor.
_ectx.Assert(ent.Stream.Position == 0);
using (var ctx = new ModelLoadContext(Repository, ent, path))
action(ctx);
}
return true;
}
/// <summary>
/// Try to load a binary stream from the current directory. This requires InRepository to be true.
/// </summary>
public bool TryLoadBinaryStream(string name, Action<BinaryReader> action)
{
_ectx.Check(InRepository, "Can't Load a sub-model when reading from a single stream");
_ectx.CheckNonEmpty(name, nameof(name));
_ectx.CheckValue(action, nameof(action));
var ent = Repository.OpenEntryOrNull(Directory, name);
if (ent == null)
return false;
using (ent)
using (var reader = new BinaryReader(ent.Stream, Encoding.UTF8, leaveOpen: true))
{
action(reader);
}
return true;
}
/// <summary>
/// Try to load a text stream from the current directory. This requires InRepository to be true.
/// </summary>
public bool TryLoadTextStream(string name, Action<TextReader> action)
{
_ectx.Check(InRepository, "Can't Load a sub-model when reading from a single stream");
_ectx.CheckNonEmpty(name, nameof(name));
_ectx.CheckValue(action, nameof(action));
var ent = Repository.OpenEntryOrNull(Directory, name);
if (ent == null)
return false;
using (ent)
using (var reader = new StreamReader(ent.Stream))
{
action(reader);
}
return true;
}
}
}