cassdlcm/mediapipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated documentation of embedding containers

Browse Source
This commit is contained in:
Prianka Liz Kariat 2023-01-27 11:08:39 +05:30
parent 61f7739ff6
commit 8531803462
4 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
mediapipe/tasks/ios/components/containers/sources/MPPEmbedding.h
View File

@ -54,7 +54,6 @@ NS_SWIFT_NAME(Embedding)
* *
* @return An instance of `MPPEmbedding` initialized with the given float embedding, quantized * @return An instance of `MPPEmbedding` initialized with the given float embedding, quantized
* embedding, head index and head name. * embedding, head index and head name.
*
*/ */
- (instancetype)initWithFloatEmbedding:(nullable float *)floatEmbedding - (instancetype)initWithFloatEmbedding:(nullable float *)floatEmbedding
quantizedEmbedding:(nullable char *)quantizedEmbedding quantizedEmbedding:(nullable char *)quantizedEmbedding

1
mediapipe/tasks/ios/components/containers/sources/MPPEmbedding.m
View File

@ -20,7 +20,6 @@
quantizedEmbedding:(nullable char *)quantizedEmbedding quantizedEmbedding:(nullable char *)quantizedEmbedding
headIndex:(NSInteger)headIndex headIndex:(NSInteger)headIndex
headName:(nullable NSString *)headName { headName:(nullable NSString *)headName {
// TODO: Should null check for embeddings be done here ?
self = [super init]; self = [super init];
if (self) { if (self) {
_headIndex = headIndex; _headIndex = headIndex;

2
mediapipe/tasks/ios/components/containers/sources/MPPEmbeddingResult.h
View File

@ -30,7 +30,7 @@ NS_SWIFT_NAME(EmbeddingResult)
* @brief The optional timestamp (in milliseconds) of the start of the chunk of data corresponding * @brief The optional timestamp (in milliseconds) of the start of the chunk of data corresponding
* to these results. * to these results.
* This is only used for embedding extraction on time series (e.g. audio embedder). In these use * This is only used for embedding extraction on time series (e.g. audio embedder). In these use
* cases, the amount of data to process might exceed the maximum size that the model can process: to * cases, the amount of data to process might exceed the maximum size that the model can process. To
* solve this, the input data is split into multiple chunks starting at different timestamps. * solve this, the input data is split into multiple chunks starting at different timestamps.
*/ */
@property(nonatomic, readonly) NSInteger timestampMs; @property(nonatomic, readonly) NSInteger timestampMs;

4
mediapipe/tasks/ios/text/text_embedder/sources/MPPTextEmbedderOptions.h
View File

@ -29,7 +29,7 @@ NS_SWIFT_NAME(TextEmbedderptions)
* Use this option only if the model does not already contain a native L2_NORMALIZATION TF Lite Op. * 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. * In most cases, this is already the case and L2 norm is thus achieved through TF Lite inference.
* *
* NO by default. * `NO` by default.
*/ */
@property(nonatomic) BOOL l2Normalize; @property(nonatomic) BOOL l2Normalize;
@ -38,7 +38,7 @@ NS_SWIFT_NAME(TextEmbedderptions)
* Embeddings are implicitly assumed to be unit-norm and therefore any dimensions is guaranteed to * 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. * have value in [-1.0, 1.0]. Use the `l2Normalize` property if this is not the case.
* *
* NO by default. * `NO` by default.
*/ */
@property(nonatomic) BOOL quantize; @property(nonatomic) BOOL quantize;