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

Updated comments in MPPClassificationResult

Browse Source
This commit is contained in:
Prianka Liz Kariat 2023-01-06 13:20:03 +05:30
parent 2121cc89a4
commit 9da4d15ef4
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
mediapipe/tasks/ios/components/containers/sources/MPPClassificationResult.h
View File

@ -18,18 +18,20 @@
NS_ASSUME_NONNULL_BEGIN NS_ASSUME_NONNULL_BEGIN
/** Represents the list of classification for a given classifier head. Typically used as a result /** Represents the list of classification for a given classifier head. Typically used as a result
* for classification tasks. */ * for classification tasks.
**/
NS_SWIFT_NAME(Classifications) NS_SWIFT_NAME(Classifications)
@interface MPPClassifications : NSObject @interface MPPClassifications : NSObject
/** The index of the classifier head these entries refer to. This is useful for multi-head models. /**
*/ * The index of the classifier head these entries refer to. This is useful for multi-head models.
**/
@property(nonatomic, readonly) NSInteger headIndex; @property(nonatomic, readonly) NSInteger headIndex;
/** The optional name of the classifier head, which is the corresponding tensor metadata name. */ /** The optional name of the classifier head, which is the corresponding tensor metadata name. **/
@property(nonatomic, readonly, nullable) NSString *headName; @property(nonatomic, readonly, nullable) NSString *headName;
/** An array of `MPPCategory` objects containing the predicted categories. */ /** An array of `MPPCategory` objects containing the predicted categories. **/
@property(nonatomic, readonly) NSArray<MPPCategory *> *categories; @property(nonatomic, readonly) NSArray<MPPCategory *> *categories;
/** /**
@ -41,7 +43,7 @@ NS_SWIFT_NAME(Classifications)
* *
* @return An instance of `MPPClassifications` initialized with the given head index and * @return An instance of `MPPClassifications` initialized with the given head index and
* array of categories. * array of categories.
*/ **/
- (instancetype)initWithHeadIndex:(NSInteger)headIndex - (instancetype)initWithHeadIndex:(NSInteger)headIndex
categories:(NSArray<MPPCategory *> *)categories; categories:(NSArray<MPPCategory *> *)categories;
@ -56,7 +58,7 @@ NS_SWIFT_NAME(Classifications)
* *
* @return An object of `MPPClassifications` initialized with the given head index, head name and * @return An object of `MPPClassifications` initialized with the given head index, head name and
* array of categories. * array of categories.
*/ **/
- (instancetype)initWithHeadIndex:(NSInteger)headIndex - (instancetype)initWithHeadIndex:(NSInteger)headIndex
headName:(nullable NSString *)headName headName:(nullable NSString *)headName
categories:(NSArray<MPPCategory *> *)categories; categories:(NSArray<MPPCategory *> *)categories;
@ -66,19 +68,21 @@ NS_SWIFT_NAME(Classifications)
/** /**
* Represents the classification results of a model. Typically used as a result for classification * Represents the classification results of a model. Typically used as a result for classification
* tasks. * tasks.
*/ **/
NS_SWIFT_NAME(ClassificationResult) NS_SWIFT_NAME(ClassificationResult)
@interface MPPClassificationResult : NSObject @interface MPPClassificationResult : NSObject
/** An Array of `MPPClassifications` objects containing the predicted categories for each head of /** An Array of `MPPClassifications` objects containing the predicted categories for each head of
* the model. */ * the model.
**/
@property(nonatomic, readonly) NSArray<MPPClassifications *> *classifications; @property(nonatomic, readonly) NSArray<MPPClassifications *> *classifications;
/** The optional timestamp (in milliseconds) of the start of the chunk of data corresponding to /** The optional timestamp (in milliseconds) of the start of the chunk of data corresponding to
* these results. If it is set to the value -1, it signifies the absence of a time stamp. This is * these results. If it is set to the value -1, it signifies the absence of a time stamp. This is
* only used for classification on time series (e.g. audio classification). In these use cases, the * only used for classification on time series (e.g. audio classification). In these use cases, the
* amount of data to process might exceed the maximum size that the model can process: to solve * 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. */ * this, the input data is split into multiple chunks starting at different timestamps.
**/
@property(nonatomic, readonly) NSInteger timestampMs; @property(nonatomic, readonly) NSInteger timestampMs;
/** /**
@ -90,7 +94,7 @@ NS_SWIFT_NAME(ClassificationResult)
* *
* @return An instance of MPPClassificationResult initialized with the given array of * @return An instance of MPPClassificationResult initialized with the given array of
* classifications. * classifications.
*/ **/
- (instancetype)initWithClassifications:(NSArray<MPPClassifications *> *)classifications; - (instancetype)initWithClassifications:(NSArray<MPPClassifications *> *)classifications;
/** /**
@ -105,7 +109,7 @@ NS_SWIFT_NAME(ClassificationResult)
* *
* @return An instance of `MPPClassificationResult` initialized with the given array of * @return An instance of `MPPClassificationResult` initialized with the given array of
* classifications and timestampMs. * classifications and timestampMs.
*/ **/
- (instancetype)initWithClassifications:(NSArray<MPPClassifications *> *)classifications - (instancetype)initWithClassifications:(NSArray<MPPClassifications *> *)classifications
timestampMs:(NSInteger)timestampMs; timestampMs:(NSInteger)timestampMs;