Versões do operador LiteRT

Este documento descreve o esquema de controle de versões de operações do LiteRT. Controle de versão de operações permite que os desenvolvedores adicionem novas funcionalidades e parâmetros a operações existentes. Além disso, ele garante o seguinte:

  • Compatibilidade com versões anteriores: a nova implementação LiteRT deve processar uma de modelo antigo.
  • Compatibilidade com versões futuras: a antiga implementação de LiteRT deve lidar com um novo arquivo de modelo produzido pela nova versão do conversor, desde que não haja nenhum novo são usados.
  • Detecção de incompatibilidade de encaminhamento: se uma implementação de LiteRT antiga lê um novo modelo que contém a nova versão de uma operação que não está compatível, ele informará o erro.

Exemplo: adicionar dilatação à convolução em profundidade

O restante deste documento explica o controle de versões de operações no TFLite, mostrando como para adicionar parâmetros de dilatação à operação de convolução em profundidade.

Não é necessário ter conhecimento de dilatação para entender este documento. Observações:

  • Dois novos parâmetros inteiros serão adicionados: dilation_width_factor e dilation_height_factor.
  • Os antigos kernels de convolução em profundidade que não oferecem suporte à dilatação são equivalentes para definir os fatores de dilatação como 1.

Alterar esquema do FlatBuffer

Para adicionar novos parâmetros a uma operação, altere a tabela de opções em lite/schema/schema.fbs:

Por exemplo, a tabela de opções de convolução em profundidade é semelhante a esta:

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

Ao adicionar novos parâmetros:

  • Adicione comentários indicando quais parâmetros são compatíveis com cada versão.
  • Quando a nova implementação recebe os valores padrão dos arquivos recém-adicionados ela deve funcionar exatamente da mesma forma que a implementação antiga.

A tabela ficará assim depois que os novos parâmetros forem adicionados:

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;
}

O arquivo lite/schema/schema_generated.h precisa ser gerado novamente para o novo esquema.

Alterar estruturas C e implementação de kernel

No LiteRT, a implementação do kernel é separada do FlatBuffer definição. Os kernels leem o parâmetro das estruturas C definidas em lite/c/builtin_op_data.h:

O parâmetro de convolução em profundidade original é o seguinte:

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

Assim como no esquema FlatBuffer, adicione comentários indicando quais parâmetros com suporte a partir de qual versão. Confira o resultado abaixo:

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;

Altere também a implementação do kernel para ler os novos parâmetros adicionados das estruturas C. Os detalhes são omitidos aqui.

Mudar o código de leitura do FlatBuffer

A lógica para ler o FlatBuffer e produzir a estrutura C está lite/core/api/flatbuffer_conversions.cc:

Atualize o arquivo para processar os novos parâmetros, conforme mostrado abaixo:

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;
}

Não é necessário verificar a versão das operações aqui. Quando a nova implementação ler um arquivo de modelo antigo em que os fatores de dilatação estão faltando, usará 1 como o padrão, e o novo kernel funcionará de forma consistente com o antigo.

Alterar o registro do kernel

O MutableOpResolver (definido em lite/mutable_op_resolver.h) oferece alguns para registrar kernels operacionais. As versões mínima e máxima são 1 por padrão:

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);

As operações integradas são registradas em lite/kernels/register.cc. Neste exemplo, implementamos um novo kernel de operações que pode lidar com a versão 1 do DepthwiseConv2D e 2. Portanto, precisamos alterar esta linha:

AddBuiltin(BuiltinOperator_DEPTHWISE_CONV_2D, Register_DEPTHWISE_CONV_2D());

para:

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

Mudar a versão da operação do TFLite

A próxima etapa é fazer o TFLite preencher a versão mínima necessária para executar a operação. Neste exemplo, isso significa que:

  • Preencha version=1 quando os fatores de dilatação forem todos 1.
  • Caso contrário, preencha version=2.

Modifique a função GetBuiltinOperatorVersion do operador em lite/tools/versioning/op_version.cc adicionando a nova versão ao caso de DepthwiseConv2D:

case BuiltinOperator_DEPTHWISE_CONV_2D:
  auto depthwise_conv_params =
      reinterpret_cast<TfLiteDepthwiseConvParams*>(op_sig.builtin_data);
  TFLITE_DCHECK(depthwise_conv_params != nullptr);
  if (depthwise_conv_params->dilation_width_factor != 1 ||
       depthwise_conv_params->dilation_height_factor != 1) {
    return 2;
  }
  return 1;

Atualizar o mapa da versão do operador

A última etapa é adicionar as informações da nova versão ao mapa de versões do operador. Isso é necessária porque precisamos gerar a política mínima necessária versão do ambiente de execução com base nesse mapa de versões.

Para fazer isso, você precisa adicionar uma nova entrada de mapa no lite/tools/versioning/runtime_version.cc:

Neste exemplo, você precisa adicionar a seguinte entrada em op_version_map:

{ {BuiltinOperator_DEPTHWISE_CONV_2D, 2}, %CURRENT_RUNTIME_VERSION%}

em que %CURRENT_RUNTIME_VERSION% corresponde à versão atual do ambiente de execução. definido em tensorflow/core/public/version.h.

Implementação da delegação

A LiteRT fornece uma API de delegação que permite delegar operações a back-ends de hardware. Na função Prepare do delegado, verifique se a versão é com suporte para cada nó no código de delegação.

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.
}

Isso é necessário mesmo se a delegação oferecer suporte apenas a operações da versão 1, portanto delegação pode detectar incompatibilidade ao obter uma operação de versão mais recente.