Updated documentation of embedding containers
This commit is contained in:
		
							parent
							
								
									61f7739ff6
								
							
						
					
					
						commit
						8531803462
					
				|  | @ -54,7 +54,6 @@ NS_SWIFT_NAME(Embedding) | |||
|  * | ||||
|  * @return An instance of `MPPEmbedding` initialized with the given float embedding, quantized | ||||
|  * embedding, head index and head name. | ||||
|  * | ||||
|  */ | ||||
| - (instancetype)initWithFloatEmbedding:(nullable float *)floatEmbedding | ||||
|                     quantizedEmbedding:(nullable char *)quantizedEmbedding | ||||
|  |  | |||
|  | @ -20,7 +20,6 @@ | |||
|                     quantizedEmbedding:(nullable char *)quantizedEmbedding | ||||
|                              headIndex:(NSInteger)headIndex | ||||
|                               headName:(nullable NSString *)headName { | ||||
|   // TODO: Should null check for embeddings be done here ? | ||||
|   self = [super init]; | ||||
|   if (self) { | ||||
|     _headIndex = headIndex; | ||||
|  |  | |||
|  | @ -30,7 +30,7 @@ NS_SWIFT_NAME(EmbeddingResult) | |||
|  * @brief The optional timestamp (in milliseconds) of the start of the chunk of data corresponding | ||||
|  * to these results. | ||||
|  * 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. | ||||
|  */ | ||||
| @property(nonatomic, readonly) NSInteger timestampMs; | ||||
|  |  | |||
|  | @ -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. | ||||
|  * 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; | ||||
| 
 | ||||
|  | @ -38,7 +38,7 @@ NS_SWIFT_NAME(TextEmbedderptions) | |||
|  * 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. | ||||
|  * `NO` by default. | ||||
|  */ | ||||
| @property(nonatomic) BOOL quantize; | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue
	
	Block a user