chromium/third_party/tflite_support/src/tensorflow_lite_support/cc/task/vision/proto/image_classifier_options.proto

/* Copyright 2020 The TensorFlow Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/

syntax = "proto2";

package tflite.task.vision;

import "tensorflow/lite/acceleration/configuration/configuration.proto";
import "tensorflow_lite_support/cc/task/core/proto/base_options.proto";
import "tensorflow_lite_support/cc/task/core/proto/external_file.proto";

// Options for setting up an ImageClassifier.
// Next Id: 15
message ImageClassifierOptions {
  // Base options for configuring MediaPipe Tasks, such as specifying the TfLite
  // model file with metadata, accelerator options, etc.
  optional tflite.task.core.BaseOptions base_options = 14;

  // Legacy method for specifying the TFLite model file. If it is packed with
  // TFLite Model Metadata [1], those are used to populate e.g. the label map,
  // score calibration and recommended score thresholds. Models without any such
  // metadata or partial metadata are supported, but may result in the image
  // classifier providing degraded functionality; typically, a model that
  // doesn't contain any label map won't be able to return any class or display
  // names but will be limited to returning class indices.
  //
  // [1]: https://www.tensorflow.org/lite/convert/metadata
  //
  // Deprecated: prefer using `base_options.model_file`, which is mutually
  // exclusive with this field.
  optional core.ExternalFile model_file_with_metadata = 10;

  // The locale to use for display names specified through the TFLite Model
  // Metadata, if any. Defaults to English.
  optional string display_names_locale = 11 [default = "en"];

  // The maximum number of top-scored classification results to return. If < 0,
  // all available results will be returned. If 0, an invalid argument error is
  // returned.
  optional int32 max_results = 2 [default = -1];

  // Score threshold, overrides the ones provided in the model metadata
  // (if any). Results below this value are rejected.
  optional float score_threshold = 3;

  // Optional whitelist of class names. If non-empty, classifications whose
  // class name is not in this set will be filtered out. Duplicate or unknown
  // class names are ignored. Mutually exclusive with class_name_blacklist.
  repeated string class_name_whitelist = 4;

  // Optional blacklist of class names. If non-empty, classifications whose
  // class name is in this set will be filtered out. Duplicate or unknown
  // class names are ignored. Mutually exclusive with class_name_whitelist.
  repeated string class_name_blacklist = 5;

  // Legacy method for specifying the number of threads to be used for TFLite
  // ops that support multi-threading when running inference with CPU.
  // num_threads should be greater than 0 or equal to -1. Setting num_threads to
  // -1 has the effect to let TFLite runtime set the value.
  //
  // Deprecated: only works with `model_file_with_metadata`. Prefer using
  // `base_options` to specifying the TFLite model and using
  // `base_options.compute_settings.tflite_settings.cpu_settings.num_threads`,
  // to configure the number of threads.
  optional int32 num_threads = 13 [default = -1];

  // Legacy method for specifying how to accelerate the model
  // inference using dedicated delegates. Supported delegate type includes:
  // NONE, NNAPI, GPU, HEXAGON, XNNPACK, EDGETPU (Google internal),
  // and EDGETPU_CORAL.
  //
  // IMPORTANT: in order to use a delegate, the appropriate delegate plugin
  // needs to be linked at build time. See comment above the "image_classifier"
  // target at:
  // https://github.com/tensorflow/tflite-support/blob/master/tensorflow_lite_support/cc/task/vision/BUILD
  //
  // See settings definition at:
  // https://github.com/tensorflow/tensorflow/blob/master/tensorflow/lite/acceleration/configuration/configuration.proto
  //
  // Deprecated: only works with `model_file_with_metadata`. Prefer using
  // `base_options` to specifying the TFLite model and using
  // `base_options.compute_settings` to configure acceleration options.
  optional tflite.proto.ComputeSettings compute_settings = 9;

  // Reserved tags.
  reserved 1, 6, 7, 8, 12;
}