-
Notifications
You must be signed in to change notification settings - Fork 74k
/
interpreter.py
994 lines (831 loc) · 37.9 KB
/
interpreter.py
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
# Copyright 2018 The TensorFlow Authors. 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.
# ==============================================================================
"""Python TF-Lite interpreter."""
import ctypes
import enum
import os
import platform
import sys
import numpy as np
# pylint: disable=g-import-not-at-top
if not os.path.splitext(__file__)[0].endswith(
os.path.join('tflite_runtime', 'interpreter')):
# This file is part of tensorflow package.
from tensorflow.lite.python.interpreter_wrapper import _pywrap_tensorflow_interpreter_wrapper as _interpreter_wrapper
from tensorflow.lite.python.metrics import metrics
from tensorflow.python.util.tf_export import tf_export as _tf_export
else:
# This file is part of tflite_runtime package.
from tflite_runtime import _pywrap_tensorflow_interpreter_wrapper as _interpreter_wrapper
from tflite_runtime import metrics_portable as metrics
def _tf_export(*x, **kwargs):
del x, kwargs
return lambda x: x
# pylint: enable=g-import-not-at-top
class Delegate:
"""Python wrapper class to manage TfLiteDelegate objects.
The shared library is expected to have two functions,
tflite_plugin_create_delegate and tflite_plugin_destroy_delegate,
which should implement the API specified in
tensorflow/lite/delegates/external/external_delegate_interface.h.
"""
def __init__(self, library, options=None):
"""Loads delegate from the shared library.
Args:
library: Shared library name.
options: Dictionary of options that are required to load the delegate. All
keys and values in the dictionary should be serializable. Consult the
documentation of the specific delegate for required and legal options.
(default None)
Raises:
RuntimeError: This is raised if the Python implementation is not CPython.
"""
# TODO(b/136468453): Remove need for __del__ ordering needs of CPython
# by using explicit closes(). See implementation of Interpreter __del__.
if platform.python_implementation() != 'CPython':
raise RuntimeError('Delegates are currently only supported into CPython'
'due to missing immediate reference counting.')
self._library = ctypes.pydll.LoadLibrary(library)
self._library.tflite_plugin_create_delegate.argtypes = [
ctypes.POINTER(ctypes.c_char_p),
ctypes.POINTER(ctypes.c_char_p), ctypes.c_int,
ctypes.CFUNCTYPE(None, ctypes.c_char_p)
]
# The return type is really 'TfLiteDelegate*', but 'void*' is close enough.
self._library.tflite_plugin_create_delegate.restype = ctypes.c_void_p
# Convert the options from a dictionary to lists of char pointers.
options = options or {}
options_keys = (ctypes.c_char_p * len(options))()
options_values = (ctypes.c_char_p * len(options))()
for idx, (key, value) in enumerate(options.items()):
options_keys[idx] = str(key).encode('utf-8')
options_values[idx] = str(value).encode('utf-8')
class ErrorMessageCapture:
def __init__(self):
self.message = ''
def report(self, x):
self.message += x if isinstance(x, str) else x.decode('utf-8')
capture = ErrorMessageCapture()
error_capturer_cb = ctypes.CFUNCTYPE(None, ctypes.c_char_p)(capture.report)
# Do not make a copy of _delegate_ptr. It is freed by Delegate's finalizer.
self._delegate_ptr = self._library.tflite_plugin_create_delegate(
options_keys, options_values, len(options), error_capturer_cb)
if self._delegate_ptr is None:
raise ValueError(capture.message)
def __del__(self):
# __del__ can not be called multiple times, so if the delegate is destroyed.
# don't try to destroy it twice.
if self._library is not None:
self._library.tflite_plugin_destroy_delegate.argtypes = [ctypes.c_void_p]
self._library.tflite_plugin_destroy_delegate(self._delegate_ptr)
self._library = None
def _get_native_delegate_pointer(self):
"""Returns the native TfLiteDelegate pointer.
It is not safe to copy this pointer because it needs to be freed.
Returns:
TfLiteDelegate *
"""
return self._delegate_ptr
@_tf_export('lite.experimental.load_delegate')
def load_delegate(library, options=None):
"""Returns loaded Delegate object.
Example usage:
```
import tensorflow as tf
try:
delegate = tf.lite.experimental.load_delegate('delegate.so')
except ValueError:
// Fallback to CPU
if delegate:
interpreter = tf.lite.Interpreter(
model_path='model.tflite',
experimental_delegates=[delegate])
else:
interpreter = tf.lite.Interpreter(model_path='model.tflite')
```
This is typically used to leverage EdgeTPU for running TensorFlow Lite models.
For more information see: https://coral.ai/docs/edgetpu/tflite-python/
Args:
library: Name of shared library containing the
[TfLiteDelegate](https://www.tensorflow.org/lite/performance/delegates).
options: Dictionary of options that are required to load the delegate. All
keys and values in the dictionary should be convertible to str. Consult
the documentation of the specific delegate for required and legal options.
(default None)
Returns:
Delegate object.
Raises:
ValueError: Delegate failed to load.
RuntimeError: If delegate loading is used on unsupported platform.
"""
try:
delegate = Delegate(library, options)
except ValueError as e:
raise ValueError('Failed to load delegate from {}\n{}'.format(
library, str(e)))
return delegate
class SignatureRunner:
"""SignatureRunner class for running TFLite models using SignatureDef.
This class should be instantiated through TFLite Interpreter only using
get_signature_runner method on Interpreter.
Example,
signature = interpreter.get_signature_runner("my_signature")
result = signature(input_1=my_input_1, input_2=my_input_2)
print(result["my_output"])
print(result["my_second_output"])
All names used are this specific SignatureDef names.
Notes:
No other function on this object or on the interpreter provided should be
called while this object call has not finished.
"""
def __init__(self, interpreter=None, signature_key=None):
"""Constructor.
Args:
interpreter: Interpreter object that is already initialized with the
requested model.
signature_key: SignatureDef key to be used.
"""
if not interpreter:
raise ValueError('None interpreter provided.')
if not signature_key:
raise ValueError('None signature_key provided.')
self._interpreter = interpreter
self._interpreter_wrapper = interpreter._interpreter
self._signature_key = signature_key
signature_defs = interpreter._get_full_signature_list()
if signature_key not in signature_defs:
raise ValueError('Invalid signature_key provided.')
self._signature_def = signature_defs[signature_key]
self._outputs = self._signature_def['outputs'].items()
self._inputs = self._signature_def['inputs']
self._subgraph_index = (
self._interpreter_wrapper.GetSubgraphIndexFromSignature(
self._signature_key))
def __call__(self, **kwargs):
"""Runs the SignatureDef given the provided inputs in arguments.
Args:
**kwargs: key,value for inputs to the model. Key is the SignatureDef input
name. Value is numpy array with the value.
Returns:
dictionary of the results from the model invoke.
Key in the dictionary is SignatureDef output name.
Value is the result Tensor.
"""
if len(kwargs) != len(self._inputs):
raise ValueError(
'Invalid number of inputs provided for running a SignatureDef, '
'expected %s vs provided %s' % (len(self._inputs), len(kwargs)))
# Resize input tensors
for input_name, value in kwargs.items():
if input_name not in self._inputs:
raise ValueError('Invalid Input name (%s) for SignatureDef' %
input_name)
self._interpreter_wrapper.ResizeInputTensor(
self._inputs[input_name], np.array(value.shape, dtype=np.int32),
False, self._subgraph_index)
# Allocate tensors.
self._interpreter_wrapper.AllocateTensors(self._subgraph_index)
# Set the input values.
for input_name, value in kwargs.items():
self._interpreter_wrapper.SetTensor(self._inputs[input_name], value,
self._subgraph_index)
self._interpreter_wrapper.Invoke(self._subgraph_index)
result = {}
for output_name, output_index in self._outputs:
result[output_name] = self._interpreter_wrapper.GetTensor(
output_index, self._subgraph_index)
return result
def get_input_details(self):
"""Gets input tensor details.
Returns:
A dictionary from input name to tensor details where each item is a
dictionary with details about an input tensor. Each dictionary contains
the following fields that describe the tensor:
+ `name`: The tensor name.
+ `index`: The tensor index in the interpreter.
+ `shape`: The shape of the tensor.
+ `shape_signature`: Same as `shape` for models with known/fixed shapes.
If any dimension sizes are unknown, they are indicated with `-1`.
+ `dtype`: The numpy data type (such as `np.int32` or `np.uint8`).
+ `quantization`: Deprecated, use `quantization_parameters`. This field
only works for per-tensor quantization, whereas
`quantization_parameters` works in all cases.
+ `quantization_parameters`: A dictionary of parameters used to quantize
the tensor:
~ `scales`: List of scales (one if per-tensor quantization).
~ `zero_points`: List of zero_points (one if per-tensor quantization).
~ `quantized_dimension`: Specifies the dimension of per-axis
quantization, in the case of multiple scales/zero_points.
+ `sparsity_parameters`: A dictionary of parameters used to encode a
sparse tensor. This is empty if the tensor is dense.
"""
result = {}
for input_name, tensor_index in self._inputs.items():
result[input_name] = self._interpreter._get_tensor_details( # pylint: disable=protected-access
tensor_index, self._subgraph_index)
return result
def get_output_details(self):
"""Gets output tensor details.
Returns:
A dictionary from input name to tensor details where each item is a
dictionary with details about an output tensor. The dictionary contains
the same fields as described for `get_input_details()`.
"""
result = {}
for output_name, tensor_index in self._outputs:
result[output_name] = self._interpreter._get_tensor_details( # pylint: disable=protected-access
tensor_index, self._subgraph_index)
return result
@_tf_export('lite.experimental.OpResolverType')
@enum.unique
class OpResolverType(enum.Enum):
"""Different types of op resolvers for Tensorflow Lite.
* `AUTO`: Indicates the op resolver that is chosen by default in TfLite
Python, which is the "BUILTIN" as described below.
* `BUILTIN`: Indicates the op resolver for built-in ops with optimized kernel
implementation.
* `BUILTIN_REF`: Indicates the op resolver for built-in ops with reference
kernel implementation. It's generally used for testing and debugging.
* `BUILTIN_WITHOUT_DEFAULT_DELEGATES`: Indicates the op resolver for
built-in ops with optimized kernel implementation, but it will disable
the application of default TfLite delegates (like the XNNPACK delegate) to
the model graph. Generally this should not be used unless there are issues
with the default configuration.
"""
# Corresponds to an op resolver chosen by default in TfLite Python.
AUTO = 0
# Corresponds to tflite::ops::builtin::BuiltinOpResolver in C++.
BUILTIN = 1
# Corresponds to tflite::ops::builtin::BuiltinRefOpResolver in C++.
BUILTIN_REF = 2
# Corresponds to
# tflite::ops::builtin::BuiltinOpResolverWithoutDefaultDelegates in C++.
BUILTIN_WITHOUT_DEFAULT_DELEGATES = 3
def _get_op_resolver_id(op_resolver_type=OpResolverType.AUTO):
"""Get a integer identifier for the op resolver."""
# Note: the integer identifier value needs to be same w/ op resolver ids
# defined in interpreter_wrapper/interpreter_wrapper.cc.
return {
# Note AUTO and BUILTIN currently share the same identifier.
OpResolverType.AUTO: 1,
OpResolverType.BUILTIN: 1,
OpResolverType.BUILTIN_REF: 2,
OpResolverType.BUILTIN_WITHOUT_DEFAULT_DELEGATES: 3
}.get(op_resolver_type, None)
@_tf_export('lite.Interpreter')
class Interpreter:
"""Interpreter interface for running TensorFlow Lite models.
Models obtained from `TfLiteConverter` can be run in Python with
`Interpreter`.
As an example, lets generate a simple Keras model and convert it to TFLite
(`TfLiteConverter` also supports other input formats with `from_saved_model`
and `from_concrete_function`)
>>> x = np.array([[1.], [2.]])
>>> y = np.array([[2.], [4.]])
>>> model = tf.keras.models.Sequential([
... tf.keras.layers.Dropout(0.2),
... tf.keras.layers.Dense(units=1, input_shape=[1])
... ])
>>> model.compile(optimizer='sgd', loss='mean_squared_error')
>>> model.fit(x, y, epochs=1)
>>> converter = tf.lite.TFLiteConverter.from_keras_model(model)
>>> tflite_model = converter.convert()
`tflite_model` can be saved to a file and loaded later, or directly into the
`Interpreter`. Since TensorFlow Lite pre-plans tensor allocations to optimize
inference, the user needs to call `allocate_tensors()` before any inference.
>>> interpreter = tf.lite.Interpreter(model_content=tflite_model)
>>> interpreter.allocate_tensors() # Needed before execution!
Sample execution:
>>> output = interpreter.get_output_details()[0] # Model has single output.
>>> input = interpreter.get_input_details()[0] # Model has single input.
>>> input_data = tf.constant(1., shape=[1, 1])
>>> interpreter.set_tensor(input['index'], input_data)
>>> interpreter.invoke()
>>> interpreter.get_tensor(output['index']).shape
(1, 1)
Use `get_signature_runner()` for a more user-friendly inference API.
"""
def __init__(
self,
model_path=None,
model_content=None,
experimental_delegates=None,
num_threads=None,
experimental_op_resolver_type=OpResolverType.AUTO,
experimental_preserve_all_tensors=False,
experimental_disable_delegate_clustering=False,
):
"""Constructor.
Args:
model_path: Path to TF-Lite Flatbuffer file.
model_content: Content of model.
experimental_delegates: Experimental. Subject to change. List of
[TfLiteDelegate](https://www.tensorflow.org/lite/performance/delegates)
objects returned by lite.load_delegate().
num_threads: Sets the number of threads used by the interpreter and
available to CPU kernels. If not set, the interpreter will use an
implementation-dependent default number of threads. Currently, only a
subset of kernels, such as conv, support multi-threading. num_threads
should be >= -1. Setting num_threads to 0 has the effect to disable
multithreading, which is equivalent to setting num_threads to 1. If set
to the value -1, the number of threads used will be
implementation-defined and platform-dependent.
experimental_op_resolver_type: The op resolver used by the interpreter. It
must be an instance of OpResolverType. By default, we use the built-in
op resolver which corresponds to tflite::ops::builtin::BuiltinOpResolver
in C++.
experimental_preserve_all_tensors: If true, then intermediate tensors used
during computation are preserved for inspection, and if the passed op
resolver type is AUTO or BUILTIN, the type will be changed to
BUILTIN_WITHOUT_DEFAULT_DELEGATES so that no Tensorflow Lite default
delegates are applied. If false, getting intermediate tensors could
result in undefined values or None, especially when the graph is
successfully modified by the Tensorflow Lite default delegate.
experimental_disable_delegate_clustering: If true, don't perform delegate
clustering during delegate graph partitioning phase. Disabling delegate
clustering will make the execution order of ops respect the
explicitly-inserted control dependencies in the graph (inserted via
`with tf.control_dependencies()`) since the TF Lite converter will drop
control dependencies by default. Most users shouldn't turn this flag to
True if they don't insert explicit control dependencies or the graph
execution order is expected. For automatically inserted control
dependencies (with `tf.Variable`, `tf.Print` etc), the user doesn't need
to turn this flag to True since they are respected by default. Note that
this flag is currently experimental, and it might be removed/updated if
the TF Lite converter doesn't drop such control dependencies in the
model. Default is False.
Raises:
ValueError: If the interpreter was unable to create.
"""
if not hasattr(self, '_custom_op_registerers'):
self._custom_op_registerers = []
actual_resolver_type = experimental_op_resolver_type
if experimental_preserve_all_tensors and (
experimental_op_resolver_type == OpResolverType.AUTO or
experimental_op_resolver_type == OpResolverType.BUILTIN):
actual_resolver_type = OpResolverType.BUILTIN_WITHOUT_DEFAULT_DELEGATES
op_resolver_id = _get_op_resolver_id(actual_resolver_type)
if op_resolver_id is None:
raise ValueError('Unrecognized passed in op resolver type: {}'.format(
experimental_op_resolver_type))
if model_path and not model_content:
custom_op_registerers_by_name = [
x for x in self._custom_op_registerers if isinstance(x, str)
]
custom_op_registerers_by_func = [
x for x in self._custom_op_registerers if not isinstance(x, str)
]
self._interpreter = _interpreter_wrapper.CreateWrapperFromFile(
model_path,
op_resolver_id,
custom_op_registerers_by_name,
custom_op_registerers_by_func,
experimental_preserve_all_tensors,
experimental_disable_delegate_clustering,
)
if not self._interpreter:
raise ValueError('Failed to open {}'.format(model_path))
elif model_content and not model_path:
custom_op_registerers_by_name = [
x for x in self._custom_op_registerers if isinstance(x, str)
]
custom_op_registerers_by_func = [
x for x in self._custom_op_registerers if not isinstance(x, str)
]
# Take a reference, so the pointer remains valid.
# Since python strings are immutable then PyString_XX functions
# will always return the same pointer.
self._model_content = model_content
self._interpreter = _interpreter_wrapper.CreateWrapperFromBuffer(
model_content,
op_resolver_id,
custom_op_registerers_by_name,
custom_op_registerers_by_func,
experimental_preserve_all_tensors,
experimental_disable_delegate_clustering,
)
elif not model_content and not model_path:
raise ValueError('`model_path` or `model_content` must be specified.')
else:
raise ValueError('Can\'t both provide `model_path` and `model_content`')
if num_threads is not None:
if not isinstance(num_threads, int):
raise ValueError('type of num_threads should be int')
if num_threads < 1:
raise ValueError('num_threads should >= 1')
self._interpreter.SetNumThreads(num_threads)
# Each delegate is a wrapper that owns the delegates that have been loaded
# as plugins. The interpreter wrapper will be using them, but we need to
# hold them in a list so that the lifetime is preserved at least as long as
# the interpreter wrapper.
self._delegates = []
if experimental_delegates:
self._delegates = experimental_delegates
for delegate in self._delegates:
self._interpreter.ModifyGraphWithDelegate(
delegate._get_native_delegate_pointer()) # pylint: disable=protected-access
self._signature_defs = self.get_signature_list()
self._metrics = metrics.TFLiteMetrics()
self._metrics.increase_counter_interpreter_creation()
def __del__(self):
# Must make sure the interpreter is destroyed before things that
# are used by it like the delegates. NOTE this only works on CPython
# probably.
# TODO(b/136468453): Remove need for __del__ ordering needs of CPython
# by using explicit closes(). See implementation of Interpreter __del__.
self._interpreter = None
self._delegates = None
def allocate_tensors(self):
self._ensure_safe()
return self._interpreter.AllocateTensors()
def _safe_to_run(self):
"""Returns true if there exist no numpy array buffers.
This means it is safe to run tflite calls that may destroy internally
allocated memory. This works, because in the wrapper.cc we have made
the numpy base be the self._interpreter.
"""
# NOTE, our tensor() call in cpp will use _interpreter as a base pointer.
# If this environment is the only _interpreter, then the ref count should be
# 2 (1 in self and 1 in temporary of sys.getrefcount).
return sys.getrefcount(self._interpreter) == 2
def _ensure_safe(self):
"""Makes sure no numpy arrays pointing to internal buffers are active.
This should be called from any function that will call a function on
_interpreter that may reallocate memory e.g. invoke(), ...
Raises:
RuntimeError: If there exist numpy objects pointing to internal memory
then we throw.
"""
if not self._safe_to_run():
raise RuntimeError("""There is at least 1 reference to internal data
in the interpreter in the form of a numpy array or slice. Be sure to
only hold the function returned from tensor() if you are using raw
data access.""")
# Experimental and subject to change
def _get_op_details(self, op_index):
"""Gets a dictionary with arrays of ids for tensors involved with an op.
Args:
op_index: Operation/node index of node to query.
Returns:
a dictionary containing the index, op name, and arrays with lists of the
indices for the inputs and outputs of the op/node.
"""
op_index = int(op_index)
op_name = self._interpreter.NodeName(op_index)
op_inputs = self._interpreter.NodeInputs(op_index)
op_outputs = self._interpreter.NodeOutputs(op_index)
details = {
'index': op_index,
'op_name': op_name,
'inputs': op_inputs,
'outputs': op_outputs,
}
return details
def _get_tensor_details(self, tensor_index, subgraph_index):
"""Gets tensor details.
Args:
tensor_index: Tensor index of tensor to query.
subgraph_index: Index of the subgraph.
Returns:
A dictionary containing the following fields of the tensor:
'name': The tensor name.
'index': The tensor index in the interpreter.
'shape': The shape of the tensor.
'quantization': Deprecated, use 'quantization_parameters'. This field
only works for per-tensor quantization, whereas
'quantization_parameters' works in all cases.
'quantization_parameters': The parameters used to quantize the tensor:
'scales': List of scales (one if per-tensor quantization)
'zero_points': List of zero_points (one if per-tensor quantization)
'quantized_dimension': Specifies the dimension of per-axis
quantization, in the case of multiple scales/zero_points.
Raises:
ValueError: If tensor_index is invalid.
"""
tensor_index = int(tensor_index)
subgraph_index = int(subgraph_index)
tensor_name = self._interpreter.TensorName(tensor_index, subgraph_index)
tensor_size = self._interpreter.TensorSize(tensor_index, subgraph_index)
tensor_size_signature = self._interpreter.TensorSizeSignature(
tensor_index, subgraph_index)
tensor_type = self._interpreter.TensorType(tensor_index, subgraph_index)
tensor_quantization = self._interpreter.TensorQuantization(
tensor_index, subgraph_index)
tensor_quantization_params = self._interpreter.TensorQuantizationParameters(
tensor_index, subgraph_index)
tensor_sparsity_params = self._interpreter.TensorSparsityParameters(
tensor_index, subgraph_index)
if not tensor_type:
raise ValueError('Could not get tensor details')
details = {
'name': tensor_name,
'index': tensor_index,
'shape': tensor_size,
'shape_signature': tensor_size_signature,
'dtype': tensor_type,
'quantization': tensor_quantization,
'quantization_parameters': {
'scales': tensor_quantization_params[0],
'zero_points': tensor_quantization_params[1],
'quantized_dimension': tensor_quantization_params[2],
},
'sparsity_parameters': tensor_sparsity_params
}
return details
# Experimental and subject to change
def _get_ops_details(self):
"""Gets op details for every node.
Returns:
A list of dictionaries containing arrays with lists of tensor ids for
tensors involved in the op.
"""
return [
self._get_op_details(idx) for idx in range(self._interpreter.NumNodes())
]
def get_tensor_details(self):
"""Gets tensor details for every tensor with valid tensor details.
Tensors where required information about the tensor is not found are not
added to the list. This includes temporary tensors without a name.
Returns:
A list of dictionaries containing tensor information.
"""
tensor_details = []
for idx in range(self._interpreter.NumTensors(0)):
try:
tensor_details.append(self._get_tensor_details(idx, subgraph_index=0))
except ValueError:
pass
return tensor_details
def get_input_details(self):
"""Gets model input tensor details.
Returns:
A list in which each item is a dictionary with details about
an input tensor. Each dictionary contains the following fields
that describe the tensor:
+ `name`: The tensor name.
+ `index`: The tensor index in the interpreter.
+ `shape`: The shape of the tensor.
+ `shape_signature`: Same as `shape` for models with known/fixed shapes.
If any dimension sizes are unknown, they are indicated with `-1`.
+ `dtype`: The numpy data type (such as `np.int32` or `np.uint8`).
+ `quantization`: Deprecated, use `quantization_parameters`. This field
only works for per-tensor quantization, whereas
`quantization_parameters` works in all cases.
+ `quantization_parameters`: A dictionary of parameters used to quantize
the tensor:
~ `scales`: List of scales (one if per-tensor quantization).
~ `zero_points`: List of zero_points (one if per-tensor quantization).
~ `quantized_dimension`: Specifies the dimension of per-axis
quantization, in the case of multiple scales/zero_points.
+ `sparsity_parameters`: A dictionary of parameters used to encode a
sparse tensor. This is empty if the tensor is dense.
"""
return [
self._get_tensor_details(i, subgraph_index=0)
for i in self._interpreter.InputIndices()
]
def set_tensor(self, tensor_index, value):
"""Sets the value of the input tensor.
Note this copies data in `value`.
If you want to avoid copying, you can use the `tensor()` function to get a
numpy buffer pointing to the input buffer in the tflite interpreter.
Args:
tensor_index: Tensor index of tensor to set. This value can be gotten from
the 'index' field in get_input_details.
value: Value of tensor to set.
Raises:
ValueError: If the interpreter could not set the tensor.
"""
self._interpreter.SetTensor(tensor_index, value)
def resize_tensor_input(self, input_index, tensor_size, strict=False):
"""Resizes an input tensor.
Args:
input_index: Tensor index of input to set. This value can be gotten from
the 'index' field in get_input_details.
tensor_size: The tensor_shape to resize the input to.
strict: Only unknown dimensions can be resized when `strict` is True.
Unknown dimensions are indicated as `-1` in the `shape_signature`
attribute of a given tensor. (default False)
Raises:
ValueError: If the interpreter could not resize the input tensor.
Usage:
```
interpreter = Interpreter(model_content=tflite_model)
interpreter.resize_tensor_input(0, [num_test_images, 224, 224, 3])
interpreter.allocate_tensors()
interpreter.set_tensor(0, test_images)
interpreter.invoke()
```
"""
self._ensure_safe()
# `ResizeInputTensor` now only accepts int32 numpy array as `tensor_size
# parameter.
tensor_size = np.array(tensor_size, dtype=np.int32)
self._interpreter.ResizeInputTensor(input_index, tensor_size, strict)
def get_output_details(self):
"""Gets model output tensor details.
Returns:
A list in which each item is a dictionary with details about
an output tensor. The dictionary contains the same fields as
described for `get_input_details()`.
"""
return [
self._get_tensor_details(i, subgraph_index=0)
for i in self._interpreter.OutputIndices()
]
def get_signature_list(self):
"""Gets list of SignatureDefs in the model.
Example,
```
signatures = interpreter.get_signature_list()
print(signatures)
# {
# 'add': {'inputs': ['x', 'y'], 'outputs': ['output_0']}
# }
Then using the names in the signature list you can get a callable from
get_signature_runner().
```
Returns:
A list of SignatureDef details in a dictionary structure.
It is keyed on the SignatureDef method name, and the value holds
dictionary of inputs and outputs.
"""
full_signature_defs = self._interpreter.GetSignatureDefs()
for _, signature_def in full_signature_defs.items():
signature_def['inputs'] = list(signature_def['inputs'].keys())
signature_def['outputs'] = list(signature_def['outputs'].keys())
return full_signature_defs
def _get_full_signature_list(self):
"""Gets list of SignatureDefs in the model.
Example,
```
signatures = interpreter._get_full_signature_list()
print(signatures)
# {
# 'add': {'inputs': {'x': 1, 'y': 0}, 'outputs': {'output_0': 4}}
# }
Then using the names in the signature list you can get a callable from
get_signature_runner().
```
Returns:
A list of SignatureDef details in a dictionary structure.
It is keyed on the SignatureDef method name, and the value holds
dictionary of inputs and outputs.
"""
return self._interpreter.GetSignatureDefs()
def get_signature_runner(self, signature_key=None):
"""Gets callable for inference of specific SignatureDef.
Example usage,
```
interpreter = tf.lite.Interpreter(model_content=tflite_model)
interpreter.allocate_tensors()
fn = interpreter.get_signature_runner('div_with_remainder')
output = fn(x=np.array([3]), y=np.array([2]))
print(output)
# {
# 'quotient': array([1.], dtype=float32)
# 'remainder': array([1.], dtype=float32)
# }
```
None can be passed for signature_key if the model has a single Signature
only.
All names used are this specific SignatureDef names.
Args:
signature_key: Signature key for the SignatureDef, it can be None if and
only if the model has a single SignatureDef. Default value is None.
Returns:
This returns a callable that can run inference for SignatureDef defined
by argument 'signature_key'.
The callable will take key arguments corresponding to the arguments of the
SignatureDef, that should have numpy values.
The callable will returns dictionary that maps from output names to numpy
values of the computed results.
Raises:
ValueError: If passed signature_key is invalid.
"""
if signature_key is None:
if len(self._signature_defs) != 1:
raise ValueError(
'SignatureDef signature_key is None and model has {0} Signatures. '
'None is only allowed when the model has 1 SignatureDef'.format(
len(self._signature_defs)))
else:
signature_key = next(iter(self._signature_defs))
return SignatureRunner(interpreter=self, signature_key=signature_key)
def get_tensor(self, tensor_index, subgraph_index=0):
"""Gets the value of the output tensor (get a copy).
If you wish to avoid the copy, use `tensor()`. This function cannot be used
to read intermediate results.
Args:
tensor_index: Tensor index of tensor to get. This value can be gotten from
the 'index' field in get_output_details.
subgraph_index: Index of the subgraph to fetch the tensor. Default value
is 0, which means to fetch from the primary subgraph.
Returns:
a numpy array.
"""
return self._interpreter.GetTensor(tensor_index, subgraph_index)
def tensor(self, tensor_index):
"""Returns function that gives a numpy view of the current tensor buffer.
This allows reading and writing to this tensors w/o copies. This more
closely mirrors the C++ Interpreter class interface's tensor() member, hence
the name. Be careful to not hold these output references through calls
to `allocate_tensors()` and `invoke()`. This function cannot be used to read
intermediate results.
Usage:
```
interpreter.allocate_tensors()
input = interpreter.tensor(interpreter.get_input_details()[0]["index"])
output = interpreter.tensor(interpreter.get_output_details()[0]["index"])
for i in range(10):
input().fill(3.)
interpreter.invoke()
print("inference %s" % output())
```
Notice how this function avoids making a numpy array directly. This is
because it is important to not hold actual numpy views to the data longer
than necessary. If you do, then the interpreter can no longer be invoked,
because it is possible the interpreter would resize and invalidate the
referenced tensors. The NumPy API doesn't allow any mutability of the
the underlying buffers.
WRONG:
```
input = interpreter.tensor(interpreter.get_input_details()[0]["index"])()
output = interpreter.tensor(interpreter.get_output_details()[0]["index"])()
interpreter.allocate_tensors() # This will throw RuntimeError
for i in range(10):
input.fill(3.)
interpreter.invoke() # this will throw RuntimeError since input,output
```
Args:
tensor_index: Tensor index of tensor to get. This value can be gotten from
the 'index' field in get_output_details.
Returns:
A function that can return a new numpy array pointing to the internal
TFLite tensor state at any point. It is safe to hold the function forever,
but it is not safe to hold the numpy array forever.
"""
return lambda: self._interpreter.tensor(self._interpreter, tensor_index)
def invoke(self):
"""Invoke the interpreter.
Be sure to set the input sizes, allocate tensors and fill values before
calling this. Also, note that this function releases the GIL so heavy
computation can be done in the background while the Python interpreter
continues. No other function on this object should be called while the
invoke() call has not finished.
Raises:
ValueError: When the underlying interpreter fails raise ValueError.
"""
self._ensure_safe()
self._interpreter.Invoke()
def reset_all_variables(self):
return self._interpreter.ResetVariableTensors()
# Experimental and subject to change.
def _native_handle(self):
"""Returns a pointer to the underlying tflite::Interpreter instance.
This allows extending tflite.Interpreter's functionality in a custom C++
function. Consider how that may work in a custom pybind wrapper:
m.def("SomeNewFeature", ([](py::object handle) {
auto* interpreter =
reinterpret_cast<tflite::Interpreter*>(handle.cast<intptr_t>());
...
}))
and corresponding Python call:
SomeNewFeature(interpreter.native_handle())
Note: This approach is fragile. Users must guarantee the C++ extension build
is consistent with the tflite.Interpreter's underlying C++ build.
"""
return self._interpreter.interpreter()
class InterpreterWithCustomOps(Interpreter):
"""Interpreter interface for TensorFlow Lite Models that accepts custom ops.
The interface provided by this class is experimental and therefore not exposed
as part of the public API.
Wraps the tf.lite.Interpreter class and adds the ability to load custom ops
by providing the names of functions that take a pointer to a BuiltinOpResolver
and add a custom op.
"""
def __init__(self, custom_op_registerers=None, **kwargs):
"""Constructor.
Args:
custom_op_registerers: List of str (symbol names) or functions that take a
pointer to a MutableOpResolver and register a custom op. When passing
functions, use a pybind function that takes a uintptr_t that can be
recast as a pointer to a MutableOpResolver.
**kwargs: Additional arguments passed to Interpreter.
Raises:
ValueError: If the interpreter was unable to create.
"""
self._custom_op_registerers = custom_op_registerers or []
super(InterpreterWithCustomOps, self).__init__(**kwargs)