Added MPPTextEmbedderOptions

This commit is contained in:
Prianka Liz Kariat 2023-01-25 20:19:27 +05:30
parent db5ee6689f
commit 60e72bf165
3 changed files with 102 additions and 0 deletions

View File

@ -0,0 +1,27 @@
# Copyright 2023 The MediaPipe 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.
package(default_visibility = ["//mediapipe/tasks:internal"])
licenses(["notice"])
objc_library(
name = "MPPTextEmbedderOptions",
srcs = ["sources/MPPTextEmbedderOptions.m"],
hdrs = ["sources/MPPTextEmbedderOptions.h"],
deps = ["//mediapipe/tasks/ios/core:MPPTaskOptions"],
)
],
)

View File

@ -0,0 +1,47 @@
// Copyright 2023 The MediaPipe Authors.
//
// 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.
#import <Foundation/Foundation.h>
#import "mediapipe/tasks/ios/core/sources/MPPTaskOptions.h"
NS_ASSUME_NONNULL_BEGIN
/**
* Options for setting up a `MPPTextEmbedder`.
*/
NS_SWIFT_NAME(TextEmbedderptions)
@interface MPPTextEmbedderOptions : MPPTaskOptions <NSCopying>
/**
* @brief Sets whether L2 normalization should be performed on the returned embeddings.
* Use this option only if the model does not already contain a native L2_NORMALIZATION TF Lite Op.
* In most cases, this is already the case and L2 norm is thus achieved through TF Lite inference.
*
* NO by default.
*/
@property(nonatomic) BOOL l2Normalize;
/**
* @brief Sets whether the returned embedding should be quantized to bytes via scalar quantization.
* Embeddings are implicitly assumed to be unit-norm and therefore any dimensions is guaranteed to
* have value in [-1.0, 1.0]. Use the `l2Normalize` property if this is not the case.
*
* NO by default.
*/
@property(nonatomic) BOOL quantize;
@end
NS_ASSUME_NONNULL_END

View File

@ -0,0 +1,28 @@
// Copyright 2023 The MediaPipe Authors.
//
// 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.
#import "mediapipe/tasks/ios/text/text_embedder/sources/MPPTextEmbedderOptions.h"
@implementation MPPTextEmbedderOptions
- (id)copyWithZone:(NSZone *)zone {
MPPTextEmbedderOptions *textEmbedderOptions = [super copyWithZone:zone];
textEmbedderOptions.l2Normalize = self.l2Normalize;
textEmbedderOptions.quantize = self.quantize;
return textEmbedderOptions;
}
@end