MLKitImageLabelingCustom Framework Reference

AI-generated Key Takeaways

• MLKCustomImageLabelerOptions configures custom-model image labelers, controlling aspects like the maximum number of returned labels.

• It allows initialization with either a local or remote custom image labeling model, setting a default confidence threshold if not explicitly defined.

• maxResultCount property dictates the maximum number of labels to be returned, defaulting to 10 if unset or invalid.

• Initialization methods accept MLKLocalModel for local models and MLKCustomRemoteModel for remote models, handling confidence thresholds based on model metadata.

MLKCustomImageLabelerOptions

@interface MLKCustomImageLabelerOptions : MLKCommonImageLabelerOptions

Configurations for a custom-model image labeler.

• maxResultCount

  The maximum number of labels to return for an image. Must be positive. If unset or an invalid value is set, the default value of 10 is used.

  Declaration

  Objective-C

  @property (nonatomic) NSInteger maxResultCount;

• -initWithLocalModel:

  Initializes a CustomImageLabelerOptions instance using the given LocalModel with the confidenceThreshold property set to nil. If that remains unset, it will use the confidence threshold value included in the model metadata, if available. If that does not exist, a value of 0.0 will be used instead.

  Declaration

  Objective-C

  - (nonnull instancetype)initWithLocalModel:(nonnull MLKLocalModel *)localModel;

  Parameters

  localModel

  A custom image labeling model stored locally on the device.

  Return Value

  A new instance of CustomImageLabelerOptions with the given LocalModel.

• -initWithRemoteModel:

  Initializes a CustomImageLabelerOptions instance using the given CustomRemoteModel with the confidenceThreshold property set to nil. If that remains unset, it will use the confidence threshold value included in the model metadata, if available. If that does not exist, a value of 0.0 will be used instead.

  Declaration

  Objective-C

  - (nonnull instancetype)initWithRemoteModel:
      (nonnull MLKCustomRemoteModel *)remoteModel;

  Parameters

  remoteModel

  A custom image labeling model stored remotely on the server and downloaded to the device.

  Return Value

  A new instance of CustomImageLabelerOptions with the given CustomRemoteModel.

• -init

  Unavailable.

  Declaration

  Objective-C

  - (nonnull instancetype)init;