Versões do operador LiteRT

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

• Compatibilidade com versões anteriores: a nova implementação do LiteRT precisa processar um arquivo de modelo antigo.
• Compatibilidade futura: a implementação antiga do LiteRT precisa processar um novo arquivo de modelo produzido pela nova versão do conversor, desde que nenhum novo recurso seja usado.
• Detecção de compatibilidade para frente: se uma implementação antiga do LiteRT ler um novo modelo que contém uma nova versão de uma operação que não tem suporte, ela vai precisar informar o erro.

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

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

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

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

Mudar o esquema do FlatBuffer

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

Por exemplo, a tabela de opções de convolução de profundidade tem esta aparência:

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 aceitos por cada versão.
• Quando a nova implementação recebe os valores padrão dos parâmetros recém-adicionados, ela funciona exatamente como a antiga.

A tabela vai 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.

Mudar estruturas C e implementação do kernel

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

O parâmetro original de convolução em profundidade é 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 são compatíveis 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;

Mude também a implementação do kernel para ler os parâmetros recém-adicionados das estruturas C. Os detalhes não são mostrados aqui.

Mudar o código de leitura do FlatBuffer

A lógica para ler o FlatBuffer e produzir a estrutura C está em 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 do operador aqui. Quando a nova implementação ler um arquivo de modelo antigo em que os fatores de dilatação estão ausentes, ela usará 1 como o valor padrão, e o novo kernel vai funcionar de forma consistente com o antigo.

Mudar o registro do kernel

O MutableOpResolver (definido em lite/mutable_op_resolver.h) fornece algumas funções para registrar kernels de operação. A versão mínima e máxima é 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ção que pode processar a DepthwiseConv2D versão 1 e 2. Portanto, precisamos mudar 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 com que o TFLite preencha a versão mínima necessária para executar a operação. Neste exemplo, isso significa:

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

Modifique a função GetBuiltinOperatorVersion para o 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 de versões do operador

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

Para fazer isso, adicione uma nova entrada de mapa em lite/tools/versioning/runtime_version.cc.

Neste exemplo, você precisa adicionar a seguinte entrada a 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 definida em release_version.h.

Implementação da delegação

O 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 tem suporte para todos os nós 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 que a delegação só ofereça suporte a operações da versão 1. Assim, a delegação pode detectar incompatibilidade ao receber uma operação de versão mais recente.