forked from TensorStack-AI/TensorStack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathModelSession.cs
More file actions
367 lines (310 loc) · 13 KB
/
ModelSession.cs
File metadata and controls
367 lines (310 loc) · 13 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
366
367
// Copyright (c) TensorStack. All rights reserved.
// Licensed under the Apache 2.0 License.
using Microsoft.ML.OnnxRuntime;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using TensorStack.Common;
namespace TensorStack.Core.Inference
{
/// <summary>
/// ModelSession class to manage lifetime of an InferenceSession ans its SessionOptions.
/// </summary>
/// <typeparam name="T">ModelConfig implementation</typeparam>
/// <seealso cref="IDisposable" />
public class ModelSession<T> : IDisposable where T : ModelConfig
{
private readonly T _configuration;
private readonly bool _registerOrtExtensions;
private readonly Func<SessionOptions> _sessionOptionsFactory;
private ModelMetadata _metadata;
private InferenceSession _session;
private SessionOptions _sessionOptions;
private ModelOptimization _optimizations;
/// <summary>
/// Initializes a new instance of the <see cref="ModelSession{T}"/> class.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <exception cref="System.IO.FileNotFoundException">Onnx model file not found, Path: {configuration.Path}</exception>
private ModelSession(T configuration)
{
if (!File.Exists(configuration.Path))
throw new FileNotFoundException($"Onnx model file not found, Path: {configuration.Path}", configuration.Path);
_configuration = configuration;
}
/// <summary>
/// Initializes a new instance of the <see cref="ModelSession"/> class.
/// </summary>
/// <param name="configuration">The configuration.</param>
public ModelSession(T configuration, bool useOrtExtensions = false)
: this(configuration)
{
_registerOrtExtensions = useOrtExtensions;
_sessionOptionsFactory = CreateDefaultSessionOptions;
}
/// <summary>
/// Initializes a new instance of the <see cref="ModelSession"/> class.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="sessionOptionsFactory">A factory to create session options.</param>
public ModelSession(T configuration, Func<SessionOptions> sessionOptionsFactory)
: this(configuration)
{
if (configuration.Provider != Provider.Custom)
throw new ArgumentException("Provider must be set to Custom when using SessionOptionsFactory");
_sessionOptionsFactory = sessionOptionsFactory;
}
/// <summary>
/// Gets the InferenceSession.
/// </summary>
public T Configuration => _configuration;
/// <summary>
/// Gets the InferenceSession.
/// </summary>
public InferenceSession Session => _session;
/// <summary>
/// Gets the SessionOptions.
/// </summary>
public SessionOptions SessionOptions => _sessionOptions;
/// <summary>
/// Loads the model session.
/// </summary>
/// <param name="optimizations">The optimizations.</param>
/// <returns>ModelMetadata.</returns>
public virtual ModelMetadata Load(ModelOptimization optimizations = default)
{
if (_session is null)
return CreateSession(optimizations);
if (HasOptimizationsChanged(optimizations))
{
Unload();
return CreateSession(optimizations);
}
return _metadata;
}
/// <summary>
/// Loads the model session asynchronously.
/// </summary>
/// <param name="optimizations">The optimizations.</param>
/// <returns>ModelMetadata.</returns>
public virtual async Task<ModelMetadata> LoadAsync(ModelOptimization optimizations = default, CancellationToken cancellationToken = default)
{
if (_session is null)
return await CreateSessionAsync(optimizations, cancellationToken);
if (HasOptimizationsChanged(optimizations))
{
await UnloadAsync();
return await CreateSessionAsync(optimizations, cancellationToken);
}
return _metadata;
}
/// <summary>
/// Unloads the model session.
/// </summary>
/// <returns></returns>
public virtual void Unload()
{
_session?.Dispose();
_metadata = null;
_session = null;
}
/// <summary>
/// Unloads the model session asynchronously.
/// </summary>
/// <returns>Task.</returns>
public virtual Task UnloadAsync()
{
Unload();
return Task.CompletedTask;
}
/// <summary>
/// Run inference and return first result
/// </summary>
/// <param name="parameters">The parameters.</param>
/// <returns>OrtValue.</returns>
public virtual OrtValue RunInferenceFirst(InferenceParameters parameters)
{
return RunInference(parameters)[0];
}
/// <summary>
/// Run inference and return first result
/// </summary>
/// <param name="parameters">The parameters.</param>
/// <returns>A Task<OrtValue> representing the asynchronous operation.</returns>
public virtual async Task<OrtValue> RunInferenceFirstAsync(InferenceParameters parameters)
{
var results = await RunInferenceAsync(parameters);
return results.First();
}
/// <summary>
/// Runs inference on the model with the suppied parameters, use this method when you do not have a known output shape.
/// </summary>
/// <param name="parameters">The parameters.</param>
/// <returns></returns>
public virtual IDisposableReadOnlyCollection<OrtValue> RunInference(InferenceParameters parameters)
{
return _session.Run(parameters.RunOptions, parameters.InputNameValues, parameters.OutputNames);
}
/// <summary>
/// Runs inference on the model with the suppied parameters, use this method when the output shape is known
/// </summary>
/// <param name="parameters">The parameters.</param>
/// <returns></returns>
public virtual async Task<IReadOnlyCollection<OrtValue>> RunInferenceAsync(InferenceParameters parameters)
{
return await _session.RunAsync(parameters.RunOptions, parameters.InputNames, parameters.InputValues, parameters.OutputNames, parameters.OutputValues);
}
/// <summary>
/// Gets the default SessionOptions.
/// </summary>
/// <param name="useOrtExtensions">if set to <c>true</c> [use ort extensions].</param>
/// <returns>SessionOptions.</returns>
/// <exception cref="NotImplementedException"></exception>
protected virtual SessionOptions CreateDefaultSessionOptions()
{
var sessionOptions = new SessionOptions();
if (_registerOrtExtensions)
sessionOptions.RegisterOrtExtensions();
sessionOptions.GraphOptimizationLevel = GraphOptimizationLevel.ORT_DISABLE_ALL;
switch (_configuration.Provider)
{
case Provider.CPU:
sessionOptions.AppendExecutionProvider_CPU();
break;
case Provider.DirectML:
sessionOptions.AppendExecutionProvider_DML(_configuration.DeviceId);
sessionOptions.AppendExecutionProvider_CPU();
break;
case Provider.CUDA:
sessionOptions.AppendExecutionProvider_CUDA(_configuration.DeviceId);
sessionOptions.AppendExecutionProvider_CPU();
break;
case Provider.CoreML:
sessionOptions.AppendExecutionProvider_CoreML(CoreMLFlags.COREML_FLAG_ONLY_ENABLE_DEVICE_WITH_ANE);
sessionOptions.AppendExecutionProvider_CPU();
break;
default:
throw new NotImplementedException();
}
return sessionOptions;
}
/// <summary>
/// Creates the InferenceSession.
/// </summary>
/// <param name="optimizations">The optimizations.</param>
/// <returns>The Sessions ModelMetadata.</returns>
protected virtual ModelMetadata CreateSession(ModelOptimization optimizations)
{
_sessionOptions?.Dispose();
_sessionOptions = _sessionOptionsFactory();
return CreateSession(new InferenceSession(_configuration.Path, _sessionOptions), optimizations);
}
/// <summary>
/// Creates the InferenceSession asynchronouly.
/// </summary>
/// <param name="optimizations">The optimizations.</param>
/// <returns>The Sessions ModelMetadata.</returns>
protected virtual async Task<ModelMetadata> CreateSessionAsync(ModelOptimization optimizations, CancellationToken cancellationToken = default)
{
_sessionOptions?.Dispose();
_sessionOptions = _sessionOptionsFactory();
var session = await Task.Run(() => new InferenceSession(_configuration.Path, _sessionOptions), cancellationToken);
return CreateSession(session, optimizations);
}
/// <summary>
/// Creates the InferenceSession.
/// </summary>
/// <param name="optimizations">The optimizations.</param>
/// <returns>The Sessions ModelMetadata.</returns>
protected virtual ModelMetadata CreateSession(InferenceSession newSession, ModelOptimization optimizations)
{
if (_configuration.IsOptimizationSupported)
ApplyOptimizations(optimizations);
_session?.Dispose();
_session = newSession;
_metadata = new ModelMetadata(_session);
return _metadata;
}
/// <summary>
/// Applies the optimizations.
/// </summary>
/// <param name="optimizations">The optimizations.</param>
protected virtual void ApplyOptimizations(ModelOptimization optimizations)
{
_optimizations = optimizations;
if (_optimizations != null)
{
_sessionOptions.GraphOptimizationLevel = optimizations.OptimizationLevel.ToGraphOptimizationLevel();
foreach (var freeDimensionOverride in _optimizations.DimensionOverrides)
{
_sessionOptions.AddFreeDimensionOverrideByName(freeDimensionOverride.Key, freeDimensionOverride.Value);
}
}
}
/// <summary>
/// Determines whether optimizations have changed
/// </summary>
/// <param name="optimizations">The optimizations.</param>
/// <returns><c>true</c> if changed; otherwise, <c>false</c>.</returns>
protected virtual bool HasOptimizationsChanged(ModelOptimization optimizations)
{
if (_optimizations == null && optimizations == null)
return false; // No Optimizations set
if (_optimizations == optimizations)
return false; // Optimizations have not changed
return true;
}
#region IDisposable
private bool disposed = false;
/// <summary>
/// Disposes the managed and unmanaged resources.
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// Disposes the managed and unmanaged resources.
/// </summary>
/// <param name="disposing">if set to <c>true</c> if disposing</param>
protected virtual void Dispose(bool disposing)
{
if (disposed)
return;
if (disposing)
{
_sessionOptions?.Dispose();
_session?.Dispose();
_session = null;
}
disposed = true;
}
/// <summary>
/// Finalizes an instance of the <see cref="ModelSession"/> class.
/// </summary>
~ModelSession()
{
Dispose(false);
}
#endregion
}
/// <summary>
/// Default ModelSession.
/// Implements the <see cref="IDisposable" />
/// </summary>
/// <seealso cref="IDisposable" />
public class ModelSession : ModelSession<ModelConfig>
{
/// <summary>
/// Initializes a new instance of the <see cref="ModelSession"/> class.
/// </summary>
/// <param name="configuration">The configuration.</param>
/// <param name="useOrtExtensions">if set to <c>true</c> [use ort extensions].</param>
public ModelSession(ModelConfig configuration, bool useOrtExtensions = false)
: base(configuration, useOrtExtensions) { }
}
}