マイクロコントローラ向け TensorFlow Lite の C++ライブラリ は TensorFlow repository の一部です。 読みやすく、修正しやすく、よくテストされており、統合しやすく、また、標準のTensorFlow Lite と互換性があるように設計されています。
以下の資料は、C++ライブラリの基本構造の概要を示しており、プロジェクト作成に関する情報を提供します。
ファイル構造
micro
のルートディレクトリは、比較的簡単な構造です。
しかし、ルートディレクトリは広大な TensorFlow レポジトリの中に配置されているので、さまざまな組込み開発環境の内に関連するソースファイルが隔離されて提供されるように、スクリプトと生成済みプロジェクトファイルを作成しました。
重要なファイル
マイクロコントローラ向け TensorFlow Lite のインタープリタを使うためにもっとも重要なファイルは、プロジェクトのルートに配置されており、テストが付属しています。
all_ops_resolver.hまたはmicro_mutable_op_resolver.hは、モデルを実行するインタープリタによって使用される演算を提供します。all_ops_resolver.hはすべての利用可能な演算を含むので、多くのメモリを使用します。製品アプリケーションにおいては、micro_mutable_op_resolver.hを使用するべきです。これはモデルが必要とする演算のみを読み込みます。micro_error_reporter.hデバッグ情報を出力します。micro_interpreter.hモデルを取り扱い、実行するコードを含みます。
典型的な使用方法は、マイクロコントローラから始める を見てみましょう。
ビルドシステムは、いくつかのファイルから成るプラットフォーム固有の実装を提供します。これらはプラットフォーム名をもつディレクトリに配置されており、たとえば
sparkfun_edge があります。
いくつかのほかのディレクトリが存在し、以下を含みます:
新規プロジェクトを始める
Hello World サンプルを新規プロジェクトのテンプレートととして使うことを推奨しています。 この節の以下の指示に従うことで、選択したプラットフォーム用の Hello, world サンプルを得られます。
Arduinoライブラリを使用する
Arduino を使用してるのならば、Hello World サンプルは、
Arduino_TensorFlowLite Arduino ライブラリに含まれており、
Arduino IDE または Arduino Create からダウンロードできます。
ライブラリが一度追加されたら、ファイル -> スケッチ例 を選択します。リストの下の方に TensorFlowLite:hello_world というサンプルをみつけられるはずです。
それを選択し、hello_world をクリックし、サンプルを読み込みます。サンプルのコピーを保存し、あなた自身のプロジェクトの基礎として使用することができます。
ほかのプラットフォーム用のプロジェクトを生成する
マイクロコントローラ向け TensorFlow Lite は、スタンドアロンなプロジェクトを生成でき、それは必要なソースファイルをすべて含み、Makefile を使用します。現在サポートされている環境は、Keil、Make、そしてMbedです。
これらのプロジェクトをMakeと一緒に生成するために、TensorFlow repository をクローンし、以下のコマンドを実行します:
make -f tensorflow/lite/micro/tools/make/Makefile generate_projects
これには数分かかります。理由は、依存関係のためにいくつかの大きなツールチェーンをダウンロードする必要があるからです。
一度それが終わると、
tensorflow/lite/micro/tools/make/gen/linux_x86_64/prj/ （正確なパスはホストのオペレーティングシステムに依存します）
のようなパスの中にいくつかのフォルダが生成されていることがわかるはずです。
これらのフォルダは、生成されたプロジェクトとソースファイルを含みます。
コマンド実行後、Hello World プロジェクトを tensorflow/lite/micro/tools/make/gen/linux_x86_64/prj/hello_world にみつけられるでしょう。
たとえば、hello_world/keil は Keil プロジェクトを含むでしょう。
テストを実行する
ライブラリをビルドし、すべての単体テストを実行するためには、以下のコマンドを使用します:
make -f tensorflow/lite/micro/tools/make/Makefile test
個々のテストを実行するには、以下のコマンドを使用します。<test_name> はテスト名に置き換えます。
make -f tensorflow/lite/micro/tools/make/Makefile test_<test_name>
プロジェクトの Makefile からテスト名をみつけられるでしょう。たとえば、examples/hello_world/Makefile.inc は Hello World サンプルのテスト名を指定しています。
バイナリをビルドする
得られたプロジェクト（サンプルアプリケーションのような）の実行可能なバイナリをビルドするために、以下のコマンドを使用します。<project_name> はビルドしたいプロジェクトに置き換えます。
make -f tensorflow/lite/micro/tools/make/Makefile <project_name>_bin
たとえば、以下のコマンドは、Hello World アプリケーションのバイナリをビルドします。
make -f tensorflow/lite/micro/tools/make/Makefile hello_world_bin
デフォルトでは、プロジェクトはホストのオペレーティングシステム用にコンパイルされるでしょう。異なるターゲットアーキテクチャを指定するには、TARGET= を使用します。
以下のサンプルは、Hello World サンプルを SparkFun Edge 向けにビルドする方法を示しています。
make -f tensorflow/lite/micro/tools/make/Makefile TARGET=sparkfun_edge hello_world_bin
ターゲットが指定されると、利用可能なターゲット固有のソースファイルが、オリジナルのコードと置き換えられて使用されるでしょう。
たとえば、サブディレクトリ examples/hello_world/sparkfun_edge は
constants.cc と output_handler.cc ファイルの SparkFun Edge 向けの実装を含んでおり、
ターゲット sparkfun_edge が指定されたときに使用されるでしょう。
プロジェクトの Makefile にプロジェクト名をみつけられるでしょう。たとえば、examples/hello_world/Makefile.inc
は、Hello World サンプルのバイナリ名を指定しています。
最適化されたカーネル
tensorflow/lite/micro/kernels のルートにあるリファレンス・カーネルは、純粋なC/C++で実装されており、プラットフォーム固有のハードウェア最適化は含みません。
最適化されたカーネルは、サブディレクトリに提供されています。
たとえば、kernels/cmsis-nn はいくつかの最適化されたカーネルを含み、Arm のCMSIS-NN ライブラリを使用します。
最適化されたカーネルを使ったプロジェクトを生成するためには、以下のコマンドを使用します。
<subdirectory_name> は最適化を含むサブディレクトリの名前に置き換えます。
make -f tensorflow/lite/micro/tools/make/Makefile TAGS=<subdirectory_name> generate_projects
新しいサブフォルダーを作成することで、あなた自身による最適化を追加することができます。我々は、最適化された新しい実装について、プルリクエストを奨励しています。
Arduino ライブラリを生成する
Arduino ライブラリのナイトリー・ビルドは、Arduino IDE のライブラリマネージャから利用できます。
ライブラリの新規ビルドを生成する必要があるなら、TensorFlow レポジトリから以下のスクリプトを実行できます:
./tensorflow/lite/micro/tools/ci_build/test_arduino.sh
結果として生成されたライブラリは以下にみつけられます。
tensorflow/lite/micro/tools/make/gen/arduino_x86_64/prj/tensorflow_lite.zip
新規デバイスに移植する
新規プラットフォームやデバイスへ マイクロコントローラ向け TensorFlow Lite を移植をするためのガイドは
micro/README.md にあります。