From ad7fd76fb14f5c1a11f6c3d080225a1348f41b77 Mon Sep 17 00:00:00 2001 From: Prianka Liz Kariat Date: Fri, 6 Jan 2023 15:11:34 +0530 Subject: [PATCH] Updated MPPTextClassifier header formatting --- .../sources/MPPTextClassifier.h | 58 ++++++++++--------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/mediapipe/tasks/ios/text/text_classifier/sources/MPPTextClassifier.h b/mediapipe/tasks/ios/text/text_classifier/sources/MPPTextClassifier.h index 813311fc2..fe1264655 100644 --- a/mediapipe/tasks/ios/text/text_classifier/sources/MPPTextClassifier.h +++ b/mediapipe/tasks/ios/text/text_classifier/sources/MPPTextClassifier.h @@ -21,49 +21,52 @@ NS_ASSUME_NONNULL_BEGIN /** + * @brief Performs classification on text. + * * This API expects a TFLite model with (optional) [TFLite Model * Metadata](https://www.tensorflow.org/lite/convert/metadata")that contains the mandatory - * (described below) input tensors, output tensor, and the optional (but recommended) label items as - * AssociatedFiles with type TENSOR_AXIS_LABELS per output classification tensor. + * (described below) input tensors, output tensor, and the optional (but recommended) label + * items as AssociatedFiles with type TENSOR_AXIS_LABELS per output classification tensor. * - * Metadata is required for models with int32 input tensors because it contains the input process - * unit for the model's Tokenizer. No metadata is required for models with string input tensors. + * Metadata is required for models with int32 input tensors because it contains the input + * process unit for the model's Tokenizer. No metadata is required for models with string + * input tensors. * * Input tensors * - Three input tensors `kTfLiteInt32` of shape `[batch_size xbert_max_seq_len]` - * representing the input ids, mask ids, and segment ids. This input signature requires a - * Bert Tokenizer process unit in the model metadata. + * representing the input ids, mask ids, and segment ids. This input signature requires + * a Bert Tokenizer process unit in the model metadata. * - Or one input tensor `kTfLiteInt32` of shape `[batch_size xmax_seq_len]` representing * the input ids. This input signature requires a Regex Tokenizer process unit in the * model metadata. - * - Or one input tensor ({@code kTfLiteString}) that is shapeless or has shape `[1]` containing - * the input string. + * - Or one input tensor (`kTfLiteString`) that is shapeless or has shape `[1]` containing + * the input string. * - * At least one output tensor `(kTfLiteFloat32}/kBool)` with: + * At least one output tensor (`kTfLiteFloat32/kBool`) with: * - `N` classes and shape `[1 x N]` - * - optional (but recommended) label map(s) as AssociatedFile-s with type TENSOR_AXIS_LABELS, - * containing one label per line. The first such AssociatedFile (if any) is used to fill the - * `class_name` field of the results. The `display_name` field is filled from the AssociatedFile - * (if any) whose locale matches the `display_names_locale` field of the - * `MPPTextClassifierOptions` used at creation time ("en" by default, i.e. English). If none of - * these are available, only the `index` field of the results will be filled. - * - * @brief Performs classification on text. - */ + * - optional (but recommended) label map(s) as AssociatedFiles with type + * TENSOR_AXIS_LABELS, + * containing one label per line. The first such AssociatedFile (if any) is used to fill + * the `categoryName` field of the results. The `displayName` field is filled from the + * AssociatedFile (if any) whose locale matches the `displayNamesLocale` field of the + * `MPPTextClassifierOptions` used at creation time ("en" by default, i.e. English). If + * none of these are available, only the `index` field of the results will be filled. + **/ NS_SWIFT_NAME(TextClassifier) @interface MPPTextClassifier : NSObject /** - * Creates a new instance of `MPPTextClassifier` from an absolute path to a TensorFlow Lite model - * file stored locally on the device and the default `MPPTextClassifierOptions`. + * Creates a new instance of `MPPTextClassifier` from an absolute path to a TensorFlow Lite + * model file stored locally on the device and the default `MPPTextClassifierOptions`. * - * @param modelPath An absolute path to a TensorFlow Lite model file stored locally on the device. + * @param modelPath An absolute path to a TensorFlow Lite model file stored locally on the + * device. * @param error An optional error parameter populated when there is an error in initializing * the text classifier. * * @return A new instance of `MPPTextClassifier` with the given model path. `nil` if there is an * error in initializing the text classifier. - */ + **/ - (instancetype)initWithModelPath:(NSString *)modelPath error:(NSError **)error; /** @@ -74,10 +77,11 @@ NS_SWIFT_NAME(TextClassifier) * @param error An optional error parameter populated when there is an error in initializing * the text classifier. * - * @return A new instance of `MPPTextClassifier` with the given options. `nil` if there is an error - * in initializing the text classifier. - */ -- (instancetype)initWithOptions:(MPPTextClassifierOptions *)options error:(NSError **)error; + * @return A new instance of `MPPTextClassifier` with the given options. `nil` if there is an + * error in initializing the text classifier. + **/ +- (instancetype)initWithOptions:(MPPTextClassifierOptions *)options + error:(NSError **)error NS_DESIGNATED_INITIALIZER; /** * Performs classification on the input text. @@ -87,7 +91,7 @@ NS_SWIFT_NAME(TextClassifier) * classification on the input text. * * @return A `MPPTextClassifierResult` object that contains a list of text classifications. - */ + **/ - (nullable MPPTextClassifierResult *)classifyWithText:(NSString *)text error:(NSError **)error; - (instancetype)init NS_UNAVAILABLE;