本文档介绍了如何训练模型并在微控制器上运行推理。
Hello World 示例
Hello World 示例旨在演示使用 TensorFlow Lite for Microcontrollers 的绝对基础知识。我们训练并运行一个模型来复制正弦函数,即它以单个数字作为输入,并输出该数字的 正弦 值。部署到微控制器后,其预测用于闪烁 LED 或控制动画。
端到端工作流程涉及以下步骤
获取支持的设备
我们将使用的示例应用程序已在以下设备上测试过
- Arduino Nano 33 BLE Sense(使用 Arduino IDE)
- SparkFun Edge(直接从源代码构建)
- STM32F746 Discovery 套件(使用 Mbed)
- Adafruit EdgeBadge(使用 Arduino IDE)
- Adafruit TensorFlow Lite for Microcontrollers Kit(使用 Arduino IDE)
- Adafruit Circuit Playground Bluefruit(使用 Arduino IDE)
- Espressif ESP32-DevKitC(使用 ESP IDF)
- Espressif ESP-EYE(使用 ESP IDF)
在 TensorFlow Lite for Microcontrollers 中了解有关支持平台的更多信息。
训练模型
使用 train.py 进行正弦波识别模型训练
运行:bazel build tensorflow/lite/micro/examples/hello_world:train
bazel-bin/tensorflow/lite/micro/examples/hello_world/train --save_tf_model --save_dir=/tmp/model_created/
运行推理
要在您的设备上运行模型,我们将逐步完成 README.md
中的说明
以下部分将逐步介绍示例的 evaluate_test.cc
,单元测试演示了如何使用 TensorFlow Lite for Microcontrollers 运行推理。它加载模型并运行推理数次。
1. 包含库头文件
要使用 TensorFlow Lite for Microcontrollers 库,我们必须包含以下头文件
#include "tensorflow/lite/micro/micro_mutable_op_resolver.h"
#include "tensorflow/lite/micro/micro_error_reporter.h"
#include "tensorflow/lite/micro/micro_interpreter.h"
#include "tensorflow/lite/schema/schema_generated.h"
#include "tensorflow/lite/version.h"
micro_mutable_op_resolver.h
提供了解释器用于运行模型的操作。micro_error_reporter.h
输出调试信息。micro_interpreter.h
包含加载和运行模型的代码。schema_generated.h
包含 TensorFlow LiteFlatBuffer
模型文件格式的模式。version.h
提供 TensorFlow Lite 模式的版本信息。
2. 包含模型头文件
TensorFlow Lite for Microcontrollers 解释器期望模型以 C++ 数组的形式提供。模型在 model.h
和 model.cc
文件中定义。头文件通过以下行包含:
#include "tensorflow/lite/micro/examples/hello_world/model.h"
3. 包含单元测试框架头文件
为了创建单元测试,我们通过包含以下行来包含 TensorFlow Lite for Microcontrollers 单元测试框架:
#include "tensorflow/lite/micro/testing/micro_test.h"
测试使用以下宏定义:
TF_LITE_MICRO_TESTS_BEGIN
TF_LITE_MICRO_TEST(LoadModelAndPerformInference) {
. // add code here
.
}
TF_LITE_MICRO_TESTS_END
现在我们讨论上面宏中包含的代码。
4. 设置日志记录
要设置日志记录,使用指向 tflite::MicroErrorReporter
实例的指针创建一个 tflite::ErrorReporter
指针:
tflite::MicroErrorReporter micro_error_reporter;
tflite::ErrorReporter* error_reporter = µ_error_reporter;
此变量将传递给解释器,允许它写入日志。由于微控制器通常具有各种日志记录机制,因此 tflite::MicroErrorReporter
的实现旨在针对您的特定设备进行定制。
5. 加载模型
在以下代码中,模型使用来自 char
数组 g_model
的数据实例化,该数组在 model.h
中声明。然后,我们检查模型以确保其模式版本与我们正在使用的版本兼容:
const tflite::Model* model = ::tflite::GetModel(g_model);
if (model->version() != TFLITE_SCHEMA_VERSION) {
TF_LITE_REPORT_ERROR(error_reporter,
"Model provided is schema version %d not equal "
"to supported version %d.\n",
model->version(), TFLITE_SCHEMA_VERSION);
}
6. 实例化操作解析器
声明一个 MicroMutableOpResolver
实例。这将由解释器用于注册和访问模型使用的操作:
using HelloWorldOpResolver = tflite::MicroMutableOpResolver<1>;
TfLiteStatus RegisterOps(HelloWorldOpResolver& op_resolver) {
TF_LITE_ENSURE_STATUS(op_resolver.AddFullyConnected());
return kTfLiteOk;
该 MicroMutableOpResolver
需要一个模板参数,指示将注册的操作数量。该 RegisterOps
函数将操作注册到解析器。
HelloWorldOpResolver op_resolver;
TF_LITE_ENSURE_STATUS(RegisterOps(op_resolver));
7. 分配内存
我们需要为输入、输出和中间数组预先分配一定量的内存。这以大小为 tensor_arena_size
的 uint8_t
数组的形式提供:
const int tensor_arena_size = 2 * 1024;
uint8_t tensor_arena[tensor_arena_size];
所需的大小将取决于您使用的模型,可能需要通过实验确定。
8. 实例化解释器
我们创建一个 tflite::MicroInterpreter
实例,传入之前创建的变量:
tflite::MicroInterpreter interpreter(model, resolver, tensor_arena,
tensor_arena_size, error_reporter);
9. 分配张量
我们告诉解释器从 tensor_arena
为模型的张量分配内存:
interpreter.AllocateTensors();
10. 验证输入形状
该 MicroInterpreter
实例可以通过调用 .input(0)
为我们提供指向模型输入张量的指针,其中 0
表示第一个(也是唯一的)输入张量:
// Obtain a pointer to the model's input tensor
TfLiteTensor* input = interpreter.input(0);
然后我们检查此张量以确认其形状和类型是我们期望的:
// Make sure the input has the properties we expect
TF_LITE_MICRO_EXPECT_NE(nullptr, input);
// The property "dims" tells us the tensor's shape. It has one element for
// each dimension. Our input is a 2D tensor containing 1 element, so "dims"
// should have size 2.
TF_LITE_MICRO_EXPECT_EQ(2, input->dims->size);
// The value of each element gives the length of the corresponding tensor.
// We should expect two single element tensors (one is contained within the
// other).
TF_LITE_MICRO_EXPECT_EQ(1, input->dims->data[0]);
TF_LITE_MICRO_EXPECT_EQ(1, input->dims->data[1]);
// The input is a 32 bit floating point value
TF_LITE_MICRO_EXPECT_EQ(kTfLiteFloat32, input->type);
枚举值 kTfLiteFloat32
是对 TensorFlow Lite 数据类型之一的引用,在 common.h
中定义。
11. 提供输入值
要向模型提供输入,我们设置输入张量的内容,如下所示:
input->data.f[0] = 0.;
在这种情况下,我们输入一个表示 0
的浮点值。
12. 运行模型
要运行模型,我们可以对 tflite::MicroInterpreter
实例调用 Invoke()
:
TfLiteStatus invoke_status = interpreter.Invoke();
if (invoke_status != kTfLiteOk) {
TF_LITE_REPORT_ERROR(error_reporter, "Invoke failed\n");
}
我们可以检查返回值,一个 TfLiteStatus
,以确定运行是否成功。在 common.h
中定义的 TfLiteStatus
的可能值是 kTfLiteOk
和 kTfLiteError
。
以下代码断言该值为 kTfLiteOk
,这意味着推理已成功运行。
TF_LITE_MICRO_EXPECT_EQ(kTfLiteOk, invoke_status);
13. 获取输出
可以通过在 tflite::MicroInterpreter
上调用 output(0)
来获取模型的输出张量,其中 0
表示第一个(也是唯一的)输出张量。
在示例中,模型的输出是一个包含在二维张量中的单个浮点值:
TfLiteTensor* output = interpreter.output(0);
TF_LITE_MICRO_EXPECT_EQ(2, output->dims->size);
TF_LITE_MICRO_EXPECT_EQ(1, input->dims->data[0]);
TF_LITE_MICRO_EXPECT_EQ(1, input->dims->data[1]);
TF_LITE_MICRO_EXPECT_EQ(kTfLiteFloat32, output->type);
我们可以直接从输出张量读取值,并断言它是我们期望的:
// Obtain the output value from the tensor
float value = output->data.f[0];
// Check that the output value is within 0.05 of the expected value
TF_LITE_MICRO_EXPECT_NEAR(0., value, 0.05);
14. 再次运行推理
代码的其余部分多次运行推理。在每个实例中,我们为输入张量分配一个值,调用解释器,并从输出张量读取结果:
input->data.f[0] = 1.;
interpreter.Invoke();
value = output->data.f[0];
TF_LITE_MICRO_EXPECT_NEAR(0.841, value, 0.05);
input->data.f[0] = 3.;
interpreter.Invoke();
value = output->data.f[0];
TF_LITE_MICRO_EXPECT_NEAR(0.141, value, 0.05);
input->data.f[0] = 5.;
interpreter.Invoke();
value = output->data.f[0];
TF_LITE_MICRO_EXPECT_NEAR(-0.959, value, 0.05);