tflite-micro/python/tflite_micro/_runtime.cc
Steven Toribio ad83c8cf8c
Implementation preserve_all_tensors and GetTensor features in TFLM interpreter (#2181)
`Implementation preserve_all_tensors and getTensor features in TFLM interpreter`


[Design Doc](https://docs.google.com/document/d/13CB93tffg_dDnZYy1QkY3u88yJev4PtZeRY0MLH6n_w/edit?resourcekey=0-htWqjXWneKLXcD6o2SVNJw#heading=h.x9snb54sjlu9)

* PreserveAllTensors is a flag / option being added to the TFLM interpreter that guarantees that post invocation all tensors will be available post invocation with there data untouched. 

* GetTensor() is an api being added to the interpreter that allows users to access any tensor in a model by providing the right index but this api is only available when the PreserveAllTensors flag is being used (all the data is guaranteed to be valid and untouched) 

*additionally this cl adds functionality for users to instantiate MicroAllocators with LinearMemoryPlanners vs the the default GreedyMemoryPlanner for MicroAllocator create methods that don't currently take a MemoryPlanner as an input
 
[google3 cl](https://critique.corp.google.com/cl/543518092)

BUG=[b/288141725](https://b.corp.google.com/288141725)
2023-08-28 17:49:16 +00:00

76 lines
3 KiB
C++

/* Copyright 2022 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.
==============================================================================*/
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include "python/tflite_micro/interpreter_wrapper.h"
#include "python/tflite_micro/pybind11_lib.h"
namespace py = pybind11;
using tflite::InterpreterWrapper;
PYBIND11_MODULE(_runtime, m) {
m.doc() = "TFLite Micro Runtime Extension";
py::enum_<tflite::InterpreterConfig>(m, "PythonInterpreterConfig")
.value("kAllocationRecording",
tflite::InterpreterConfig::kAllocationRecording)
.value("kPreserveAllTensors",
tflite::InterpreterConfig::kPreserveAllTensors);
py::class_<InterpreterWrapper>(m, "InterpreterWrapper")
.def(py::init([](const py::bytes& data,
const std::vector<std::string>& registerers_by_name,
size_t arena_size, int num_resource_variables,
tflite::InterpreterConfig config) {
return std::unique_ptr<InterpreterWrapper>(
new InterpreterWrapper(data.ptr(), registerers_by_name, arena_size,
num_resource_variables, config));
}))
.def("PrintAllocations", &InterpreterWrapper::PrintAllocations)
.def("Invoke", &InterpreterWrapper::Invoke)
.def("Reset", &InterpreterWrapper::Reset)
.def(
"SetInputTensor",
[](InterpreterWrapper& self, py::handle& x, size_t index) {
self.SetInputTensor(x.ptr(), index);
},
py::arg("x"), py::arg("index"))
.def(
"GetOutputTensor",
[](InterpreterWrapper& self, size_t index) {
return tflite::PyoOrThrow(self.GetOutputTensor(index));
},
py::arg("index"))
.def(
"GetInputTensorDetails",
[](InterpreterWrapper& self, size_t index) {
return tflite::PyoOrThrow(self.GetInputTensorDetails(index));
},
py::arg("index"))
.def(
"GetTensor",
[](InterpreterWrapper& self, size_t tensor_index,
size_t subgraph_index = 0) {
return tflite::PyoOrThrow(
self.GetTensor(tensor_index, subgraph_index));
},
py::arg("tensor_index"), py::arg("subgraph_index"))
.def(
"GetOutputTensorDetails",
[](InterpreterWrapper& self, size_t index) {
return tflite::PyoOrThrow(self.GetOutputTensorDetails(index));
},
py::arg("index"));
}