TensorFlow Lite 演算子のバージョン

このドキュメントでは、TensorFlow Lite 演算子のバージョン管理スキーマを説明します。演算子のバージョン管理を行うことによって、既存の演算子に新しい機能やパラメータを追加することができます。さらに、次の項目が保証されます。

  • 下位互換性: 新しい TensorFlow Lite 実装で以前のモデルファイルも処理します。
  • 上位互換性: 以前の TensorFlow Lite 実装で、新しい機能が使用されない限り、新しいバージョンのコンバータによって生成された新しいモデルファイルを処理できます。
  • 上位非互換性検出: 以前の TensorFlow Lite 実装がサポートされていない新しいバージョンの演算子を含む新しいモデルを読み取る場合に、エラーを報告します。

例: 深さ方向の畳み込みに膨張度を追加する

このドキュメントの残りの部分では、深さ方向の畳み込み演算に膨張パラメータを追加する方法を紹介し、TFLite における演算のバージョン管理について説明します。

このドキュメントを理解する上で、膨張に関する知識は必要ありません。次のことに注意してください。

  • dilation_width_factordilation_height_factor という、2 つの新しい整数パラメータが追加されます。
  • 膨張をサポートしない古い深さ方向の畳み込みカーネルは、膨張要因を 1 に設定するのと同等です。

FlatBuffer スキーマを変更する

演算に新しいパラメータを追加するには、lite/schema/schema.fbsのオプションテーブルを変更します。

たとえば、深さ方向の畳み込みのオプションテーブルは、次のようになります。

table DepthwiseConv2DOptions {
  padding:Padding;
  stride_w:int;
  stride_h:int;
  depth_multiplier:int;
  fused_activation_function:ActivationFunctionType;
}

新しいパラメータを追加する場合:

  • どのパラメータがどのバージョンでサポートされているかを示すコメントを追加します。
  • 新しい実装が新たに追加されたパラメータのデフォルト値を取得する場合、以前の実装とまったく同じように機能します。

新しいパラメータを追加した後のテーブルは次のようになります。

table Conv2DOptions {
  // Parameters supported by version 1:
table DepthwiseConv2DOptions {
  // Parameters for DepthwiseConv version 1 or above.
  padding:Padding;
  stride_w:int;
  stride_h:int;
  depth_multiplier:int;
  fused_activation_function:ActivationFunctionType;
  // Parameters for DepthwiseConv version 2 or above.
  dilation_w_factor:int = 1;
  dilation_h_factor:int = 1;
}

ファイルlite/schema/schema_generated.hは新しいスキーマに合わせて生成し直されます。

C 構造とカーネル実装を変更する

TensorFlow Lite では、カーネル実装は FlatBuffer 定義から分離されており、カーネルはlite/c/builtin_op_data.hで定義された C 構造からパラメータを読み取ります。

元の深さ方向の畳み込みパラメータは次のとおりです。

typedef struct {
  TfLitePadding padding;
  int stride_width;
  int stride_height;
  TfLiteFusedActivation activation;
} TfLiteConvParams;

FlatBuffer スキーマと同様に、どのパラメータがどのバージョン以降でサポートされているかを示すコメントを追加します。結果は以下のようになります。

typedef struct {
  // Parameters for DepthwiseConv version 1 or above.
  TfLitePadding padding;
  int stride_width;
  int stride_height;
  int depth_multiplier;
  TfLiteFusedActivation activation;
  // Parameters for DepthwiseConv version 2 or above.
  int dilation_width_factor;
  int dilation_height_factor;
} TfLiteDepthwiseConvParams;

新たに追加されたパラメータを C 構造から読み取るように、カーネル実装も変更してください。その詳細は、ここでは省略します。

FlatBuffer 読み取りコードを変更する

FlatBuffer を読み取って C 構造を生成するロジックは、lite/core/api/flatbuffer_conversions.ccにあります。

次のように、新しいパラメータを処理するようにファイルを更新します。

TfLiteStatus ParseDepthwiseConv2D(const Operator* op,
                                  ErrorReporter* error_reporter,
                                  BuiltinDataAllocator* allocator,
                                  void** builtin_data) {
  CheckParsePointerParams(op, error_reporter, allocator, builtin_data);

  SafeBuiltinDataAllocator safe_allocator(allocator);

  std::unique_ptr<TfLiteDepthwiseConvParams,
                  SafeBuiltinDataAllocator::BuiltinDataDeleter>
      params = safe_allocator.Allocate<TfLiteDepthwiseConvParams>();
  TF_LITE_ENSURE(error_reporter, params != nullptr);

  const DepthwiseConv2DOptions* schema_params =
      op->builtin_options_as_DepthwiseConv2DOptions();

  if (schema_params != nullptr) {
    params->padding = ConvertPadding(schema_params->padding());
    params->stride_width = schema_params->stride_w();
    params->stride_height = schema_params->stride_h();
    params->depth_multiplier = schema_params->depth_multiplier();
    params->activation =
        ConvertActivation(schema_params->fused_activation_function());

    params->dilation_width_factor = schema_params->dilation_w_factor();
    params->dilation_height_factor = schema_params->dilation_h_factor();
  }

  *builtin_data = params.release();
  return kTfLiteOk;
}

ここでは、演算バージョンを確認する必要はありません。新しい実装が膨張係数のない古いモデルファイルを読み取る場合は、デフォルト値として 1 を使用するため、新しいカーネルは古いカーネルと一貫性を維持して機能します。

カーネル登録を変更する

MutableOpResolver(lite/op_resolver.hで定義)は、演算カーネルを登録する関数をいくつか提供しています。最小バージョンと最大バージョンはデフォルトでは 1 です。

void AddBuiltin(tflite::BuiltinOperator op, TfLiteRegistration* registration,
                int min_version = 1, int max_version = 1);
void AddCustom(const char* name, TfLiteRegistration* registration,
               int min_version = 1, int max_version = 1);

組み込み演算はlite/kernels/register.ccに登録されています。この例では、Conv2D のバージョン 1 と 2 を処理できる新しい演算カーネルを実装しているため、次の行を変更する必要があります。

AddBuiltin(BuiltinOperator_DEPTHWISE_CONV_2D, Register_DEPTHWISE_CONV_2D());

上記の行を次のように変更します。

AddBuiltin(BuiltinOperator_DEPTHWISE_CONV_2D, Register_DEPTHWISE_CONV_2D(),
             /* min_version = */ 1,
             /* max_version = */ 2);

TFLite 演算子バージョンを変更する

次のステップは、TFLite に演算の実行に必要な最小バージョンを設定させます。この例では、次のことを行います。

  • 膨張係数がすべて 1 である場合は、version=1
  • そうでない場合は version=2 とする

これを行うには、最初に対応するパラメータをOpSignature構造体内のdepthwise_conv_2dに追加する必要があります。

struct {
      int32_t dilation_w_factor;
      int32_t dilation_h_factor;
    } depthwise_conv_2d;

次に、これらの新しいパラメータをlite/tools/versioning/op_version.ccGetOpSignature関数に入力します。

case BuiltinOperator_DEPTHWISE_CONV_2D: {
      auto conv_option = op->builtin_options_as_DepthwiseConv2DOptions();
      if (conv_option) {
        op_sig.options.depthwise_conv_2d.dilation_w_factor =
            conv_option->dilation_w_factor();
        op_sig.options.depthwise_conv_2d.dilation_h_factor =
            conv_option->dilation_h_factor();
      }
    } break;

新しい型のサポートを追加する場合は、上記の手順は必要ありません。入力型と出力型は、OpSignatureのすべての演算に対して定義および移入されます。

最後に、DepthwiseConv2Dの場合に新しいバージョンを追加して、lite/tools/versioning/op_version.ccの演算子のGetBuiltinOperatorVersion関数を変更します。

case BuiltinOperator_DEPTHWISE_CONV_2D:
  if (op_sig.options.depthwise_conv_2d.dilation_w_factor != 1 ||
      op_sig.options.depthwise_conv_2d.dilation_h_factor != 1) {
    return 2;
  }
  return 1;

演算子のバージョンマップを更新する

最後に、新しいバージョン情報を演算子バージョンマップに追加します。このバージョンマップに応じて、モデルで最小限必要となるランタイムバージョンを生成する必要があるため、これは必要なステップです。

これを行うには、lite/tools/versioning/runtime_version.ccに新しいマップエントリを追加する必要があります。

この例では、次のエントリをop_version_mapに追加します。

{ {BuiltinOperator_DEPTHWISE_CONV_2D, 2}, %CURRENT_RUNTIME_VERSION%}

ここで、%CURRENT_RUNTIME_VERSION%は、tensorflow/core/public/version.h で定義されている現在のランタイムバージョンに対応します。

実装をデリゲートする

TensorFlow Lite には、演算をハードウェアのバックエンドにデリゲートすることのできるデリゲート API があります。デリゲートのPrepare関数で、バージョンがデリゲーションコードのすべてのノードに対応しているかどうかを確認します。

const int kMaxVersion = 1;
TfLiteNode* node;
TfLiteRegistration* registration = nullptr;
TF_LITE_ENSURE_STATUS(context->GetNodeAndRegistration(context, node_index, &node, &registration));

if (registration->version > kMaxVersion) {
  // Reject the node if the version isn't supported.
}

これは、デリゲートがバージョン 1 の演算のみをサポートする場合でも必要な作業で、これにより、デリゲートがより高いバージョンの演算を得る場合に非互換性を検出できるようになります。