Package apple.coreml

Class MLModel

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.coreml.MLModel

All Implemented Interfaces:

NSObject

public class MLModel
extends NSObject

MLModel Construct a model and evaluate on a specific set of input features. Inputs and outputs are accessed via the MLFeatureProvider protocol. Returns a model or nil if there is an error. API-Since: 11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MLModel.Block_compileModelAtURLCompletionHandler
static interface	MLModel.Block_loadContentsOfURLConfigurationCompletionHandler
static interface	MLModel.Block_loadModelAssetConfigurationCompletionHandler
static interface	MLModel.Block_predictionFromFeaturesCompletionHandler
static interface	MLModel.Block_predictionFromFeaturesOptionsCompletionHandler

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Block_accessibilityActivateBlock_ret, NSObject.Block_accessibilityActivationPointBlock_ret, NSObject.Block_accessibilityAttributedHintBlock_ret, NSObject.Block_accessibilityAttributedLabelBlock_ret, NSObject.Block_accessibilityAttributedUserInputLabelsBlock_ret, NSObject.Block_accessibilityAttributedValueBlock_ret, NSObject.Block_accessibilityContainerTypeBlock_ret, NSObject.Block_accessibilityCustomActionsBlock_ret, NSObject.Block_accessibilityCustomRotorsBlock_ret, NSObject.Block_accessibilityDecrementBlock_ret, NSObject.Block_accessibilityElementsBlock_ret, NSObject.Block_accessibilityElementsHiddenBlock_ret, NSObject.Block_accessibilityFrameBlock_ret, NSObject.Block_accessibilityHeaderElementsBlock_ret, NSObject.Block_accessibilityHintBlock_ret, NSObject.Block_accessibilityIdentifierBlock_ret, NSObject.Block_accessibilityIncrementBlock_ret, NSObject.Block_accessibilityLabelBlock_ret, NSObject.Block_accessibilityLanguageBlock_ret, NSObject.Block_accessibilityMagicTapBlock_ret, NSObject.Block_accessibilityNavigationStyleBlock_ret, NSObject.Block_accessibilityPathBlock_ret, NSObject.Block_accessibilityPerformEscapeBlock_ret, NSObject.Block_accessibilityRespondsToUserInteractionBlock_ret, NSObject.Block_accessibilityShouldGroupAccessibilityChildrenBlock_ret, NSObject.Block_accessibilityTextualContextBlock_ret, NSObject.Block_accessibilityTraitsBlock_ret, NSObject.Block_accessibilityUserInputLabelsBlock_ret, NSObject.Block_accessibilityValueBlock_ret, NSObject.Block_accessibilityViewIsModalBlock_ret, NSObject.Block_automationElementsBlock_ret, NSObject.Block_isAccessibilityElementBlock_ret, NSObject.Block_setAccessibilityActivateBlock, NSObject.Block_setAccessibilityActivationPointBlock, NSObject.Block_setAccessibilityAttributedHintBlock, NSObject.Block_setAccessibilityAttributedLabelBlock, NSObject.Block_setAccessibilityAttributedUserInputLabelsBlock, NSObject.Block_setAccessibilityAttributedValueBlock, NSObject.Block_setAccessibilityContainerTypeBlock, NSObject.Block_setAccessibilityCustomActionsBlock, NSObject.Block_setAccessibilityCustomRotorsBlock, NSObject.Block_setAccessibilityDecrementBlock, NSObject.Block_setAccessibilityElementsBlock, NSObject.Block_setAccessibilityElementsHiddenBlock, NSObject.Block_setAccessibilityFrameBlock, NSObject.Block_setAccessibilityHeaderElementsBlock, NSObject.Block_setAccessibilityHintBlock, NSObject.Block_setAccessibilityIdentifierBlock, NSObject.Block_setAccessibilityIncrementBlock, NSObject.Block_setAccessibilityLabelBlock, NSObject.Block_setAccessibilityLanguageBlock, NSObject.Block_setAccessibilityMagicTapBlock, NSObject.Block_setAccessibilityNavigationStyleBlock, NSObject.Block_setAccessibilityPathBlock, NSObject.Block_setAccessibilityPerformEscapeBlock, NSObject.Block_setAccessibilityRespondsToUserInteractionBlock, NSObject.Block_setAccessibilityShouldGroupAccessibilityChildrenBlock, NSObject.Block_setAccessibilityTextualContextBlock, NSObject.Block_setAccessibilityTraitsBlock, NSObject.Block_setAccessibilityUserInputLabelsBlock, NSObject.Block_setAccessibilityValueBlock, NSObject.Block_setAccessibilityViewIsModalBlock, NSObject.Block_setAutomationElementsBlock, NSObject.Block_setIsAccessibilityElementBlock, NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MLModel(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method	Description
static boolean	accessInstanceVariablesDirectly()
static MLModel	alloc()
static MLModel	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(@NotNull java.lang.String key)
static @NotNull NSArray<?>	availableComputeDevices()	The list of available compute devices for CoreML.
static void	cancelPreviousPerformRequestsWithTarget(@NotNull java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(@NotNull java.lang.Object aTarget, @NotNull org.moe.natj.objc.SEL aSelector, @Nullable java.lang.Object anArgument)
static @NotNull NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static @NotNull org.moe.natj.objc.Class	classForKeyedUnarchiver()
static void	compileModelAtURLCompletionHandler(@NotNull NSURL modelURL, @NotNull MLModel.Block_compileModelAtURLCompletionHandler handler)	Compile a .mlmodel or .mlpackage for this device.
static @Nullable NSURL	compileModelAtURLError(@NotNull NSURL modelURL, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Deprecated.
@NotNull MLModelConfiguration	configuration()	The load-time parameters used to instantiate this MLModel object.
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static long	hash_static()
MLModel	init()
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static @NotNull NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(@NotNull java.lang.String key)
static void	loadContentsOfURLConfigurationCompletionHandler(@NotNull NSURL url, @NotNull MLModelConfiguration configuration, @NotNull MLModel.Block_loadContentsOfURLConfigurationCompletionHandler handler)	Construct a model asynchronously given the location of its on-disk representation and configuration.
static void	loadModelAssetConfigurationCompletionHandler(@NotNull MLModelAsset asset, @NotNull MLModelConfiguration configuration, @NotNull MLModel.Block_loadModelAssetConfigurationCompletionHandler handler)	Construct a model asynchronously from a compiled model asset.
@NotNull MLModelDescription	modelDescription()	A model holds a description of its required inputs and expected outputs.
static MLModel	modelWithContentsOfURLConfigurationError(@NotNull NSURL url, @NotNull MLModelConfiguration configuration, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Construct a model given the location of its on-disk representation.
static MLModel	modelWithContentsOfURLError(@NotNull NSURL url, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Construct a model with a default MLModelConfiguration object
static MLModel	new_objc()
@Nullable java.lang.Object	parameterValueForKeyError(@NotNull MLParameterKey key, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Provides value for the given parameter.
void	predictionFromFeaturesCompletionHandler(@NotNull MLFeatureProvider input, @NotNull MLModel.Block_predictionFromFeaturesCompletionHandler completionHandler)	Convenience method to run a prediction asynchronously with default prediction options.
@Nullable MLFeatureProvider	predictionFromFeaturesError(@NotNull MLFeatureProvider input, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Convenience method to run a prediction synchronously with default prediction options.
void	predictionFromFeaturesOptionsCompletionHandler(@NotNull MLFeatureProvider input, @NotNull MLPredictionOptions options, @NotNull MLModel.Block_predictionFromFeaturesOptionsCompletionHandler completionHandler)	Run a prediction on a model asynchronously.
@Nullable MLFeatureProvider	predictionFromFeaturesOptionsError(@NotNull MLFeatureProvider input, @NotNull MLPredictionOptions options, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Run a prediction on a model synchronously [@returns] The output features from the prediction
@Nullable MLBatchProvider	predictionsFromBatchError(@NotNull MLBatchProvider inputBatch, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Batch prediction without explicit options API-Since: 12.0
@Nullable MLBatchProvider	predictionsFromBatchOptionsError(@NotNull MLBatchProvider inputBatch, @NotNull MLPredictionOptions options, @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)	Batch prediction with explicit options API-Since: 12.0
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static boolean	useStoredAccessor()	Deprecated.
static long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivateBlock, accessibilityActivationPoint, accessibilityActivationPointBlock, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedHintBlock, accessibilityAttributedLabel, accessibilityAttributedLabelBlock, accessibilityAttributedUserInputLabels, accessibilityAttributedUserInputLabelsBlock, accessibilityAttributedValue, accessibilityAttributedValueBlock, accessibilityContainerType, accessibilityContainerTypeBlock, accessibilityCustomActions, accessibilityCustomActionsBlock, accessibilityCustomRotors, accessibilityCustomRotorsBlock, accessibilityDecrement, accessibilityDecrementBlock, accessibilityDirectTouchOptions, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsBlock, accessibilityElementsHidden, accessibilityElementsHiddenBlock, accessibilityFrame, accessibilityFrameBlock, accessibilityHeaderElementsBlock, accessibilityHint, accessibilityHintBlock, accessibilityIdentifierBlock, accessibilityIncrement, accessibilityIncrementBlock, accessibilityLabel, accessibilityLabelBlock, accessibilityLanguage, accessibilityLanguageBlock, accessibilityMagicTapBlock, accessibilityNavigationStyle, accessibilityNavigationStyleBlock, accessibilityPath, accessibilityPathBlock, accessibilityPerformEscape, accessibilityPerformEscapeBlock, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityRespondsToUserInteractionBlock, accessibilityScroll, accessibilityShouldGroupAccessibilityChildrenBlock, accessibilityTextualContext, accessibilityTextualContextBlock, accessibilityTraits, accessibilityTraitsBlock, accessibilityUserInputLabels, accessibilityUserInputLabelsBlock, accessibilityValue, accessibilityValueBlock, accessibilityViewIsModal, accessibilityViewIsModalBlock, accessibilityZoomInAtPoint, accessibilityZoomOutAtPoint, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, automationElements, automationElementsBlock, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hash, indexOfAccessibilityElement, isAccessibilityElement, isAccessibilityElementBlock, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivateBlock, setAccessibilityActivationPoint, setAccessibilityActivationPointBlock, setAccessibilityAttributedHint, setAccessibilityAttributedHintBlock, setAccessibilityAttributedLabel, setAccessibilityAttributedLabelBlock, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedUserInputLabelsBlock, setAccessibilityAttributedValue, setAccessibilityAttributedValueBlock, setAccessibilityContainerType, setAccessibilityContainerTypeBlock, setAccessibilityCustomActions, setAccessibilityCustomActionsBlock, setAccessibilityCustomRotors, setAccessibilityCustomRotorsBlock, setAccessibilityDecrementBlock, setAccessibilityDirectTouchOptions, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsBlock, setAccessibilityElementsHidden, setAccessibilityElementsHiddenBlock, setAccessibilityFrame, setAccessibilityFrameBlock, setAccessibilityHeaderElementsBlock, setAccessibilityHint, setAccessibilityHintBlock, setAccessibilityIdentifierBlock, setAccessibilityIncrementBlock, setAccessibilityLabel, setAccessibilityLabelBlock, setAccessibilityLanguage, setAccessibilityLanguageBlock, setAccessibilityMagicTapBlock, setAccessibilityNavigationStyle, setAccessibilityNavigationStyleBlock, setAccessibilityPath, setAccessibilityPathBlock, setAccessibilityPerformEscapeBlock, setAccessibilityRespondsToUserInteraction, setAccessibilityRespondsToUserInteractionBlock, setAccessibilityShouldGroupAccessibilityChildrenBlock, setAccessibilityTextualContext, setAccessibilityTextualContextBlock, setAccessibilityTraits, setAccessibilityTraitsBlock, setAccessibilityUserInputLabels, setAccessibilityUserInputLabelsBlock, setAccessibilityValue, setAccessibilityValueBlock, setAccessibilityViewIsModal, setAccessibilityViewIsModalBlock, setAutomationElements, setAutomationElementsBlock, setIsAccessibilityElement, setIsAccessibilityElementBlock, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, storedValueForKey, superclass, takeStoredValueForKey, takeValueForKey, takeValueForKeyPath, takeValuesFromDictionary, unableToSetNilForKey, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, valuesForKeys, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MLModel

protected MLModel(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MLModel alloc()

allocWithZone

public static MLModel allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(@NotNull
                                                           @NotNull java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(@NotNull
                                                           @NotNull java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

classFallbacksForKeyedArchiver

@NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

@NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

compileModelAtURLError

@Nullable
@Deprecated
public static @Nullable NSURL compileModelAtURLError(@NotNull
                                                     @NotNull NSURL modelURL,
                                                     @Nullable
                                                     @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Deprecated.

Compile a .mlmodel for this device [@returns] a URL to the compiled .mlmodelc directory if successful The model is compiled to a temporary location on disk You must move the compiled model to a permanent location if you wish to keep it The returned model can be loaded using: [@code] [MLModel modelWithContentsOfURL:error:] [@endcode] API-Since: 11.0 Deprecated-Since: 100000.0 Deprecated-Message: Use the asynchronous interface compileModelAtURL:completionHandler:error: instead.

Parameters:

modelURL - URL file path to .mlmodel file you wish to compile

error - Any errors are surfaced here

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

init

public MLModel init()

Overrides:

init in class NSObject

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

@NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(@NotNull
                                                                                     @NotNull java.lang.String key)

modelDescription

@NotNull
public @NotNull MLModelDescription modelDescription()

A model holds a description of its required inputs and expected outputs.

modelWithContentsOfURLError

public static MLModel modelWithContentsOfURLError(@NotNull
                                                  @NotNull NSURL url,
                                                  @Nullable
                                                  @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Construct a model with a default MLModelConfiguration object

new_objc

public static MLModel new_objc()

predictionFromFeaturesError

@Nullable
public @Nullable MLFeatureProvider predictionFromFeaturesError(@NotNull
                                                               @NotNull MLFeatureProvider input,
                                                               @Nullable
                                                               @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Convenience method to run a prediction synchronously with default prediction options.

predictionFromFeaturesOptionsError

@Nullable
public @Nullable MLFeatureProvider predictionFromFeaturesOptionsError(@NotNull
                                                                      @NotNull MLFeatureProvider input,
                                                                      @NotNull
                                                                      @NotNull MLPredictionOptions options,
                                                                      @Nullable
                                                                      @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Run a prediction on a model synchronously [@returns] The output features from the prediction

Parameters:

input - The input features to make a prediction from

options - Prediction options to modify how the prediction is run

error - The out parameter for error when nil is returned. On success, it is nil

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

version_static

public static long version_static()

configuration

@NotNull
public @NotNull MLModelConfiguration configuration()

The load-time parameters used to instantiate this MLModel object. API-Since: 12.0

modelWithContentsOfURLConfigurationError

public static MLModel modelWithContentsOfURLConfigurationError(@NotNull
                                                               @NotNull NSURL url,
                                                               @NotNull
                                                               @NotNull MLModelConfiguration configuration,
                                                               @Nullable
                                                               @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Construct a model given the location of its on-disk representation. Returns nil on error. API-Since: 12.0

parameterValueForKeyError

@Nullable
public @Nullable java.lang.Object parameterValueForKeyError(@NotNull
                                                            @NotNull MLParameterKey key,
                                                            @Nullable
                                                            @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Provides value for the given parameter. Returns nil on error. API-Since: 13.0

predictionsFromBatchError

@Nullable
public @Nullable MLBatchProvider predictionsFromBatchError(@NotNull
                                                           @NotNull MLBatchProvider inputBatch,
                                                           @Nullable
                                                           @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Batch prediction without explicit options API-Since: 12.0

predictionsFromBatchOptionsError

@Nullable
public @Nullable MLBatchProvider predictionsFromBatchOptionsError(@NotNull
                                                                  @NotNull MLBatchProvider inputBatch,
                                                                  @NotNull
                                                                  @NotNull MLPredictionOptions options,
                                                                  @Nullable
                                                                  @Nullable org.moe.natj.general.ptr.Ptr<NSError> error)

Batch prediction with explicit options API-Since: 12.0

loadContentsOfURLConfigurationCompletionHandler

public static void loadContentsOfURLConfigurationCompletionHandler(@NotNull
                                                                   @NotNull NSURL url,
                                                                   @NotNull
                                                                   @NotNull MLModelConfiguration configuration,
                                                                   @NotNull
                                                                   @NotNull MLModel.Block_loadContentsOfURLConfigurationCompletionHandler handler)

Construct a model asynchronously given the location of its on-disk representation and configuration. Model loading may take time when the model content is not immediately available (e.g. encrypted model). Use this factory method especially when the caller is on the main thread.

Parameters:

url - the location of its on-disk representation (.mlmodelc directory).

configuration - The model configuration

handler - When the model load completes successfully or unsuccessfully, the completion handler is invoked with a valid MLModel instance or NSError object. API-Since: 14.0

compileModelAtURLCompletionHandler

public static void compileModelAtURLCompletionHandler(@NotNull
                                                      @NotNull NSURL modelURL,
                                                      @NotNull
                                                      @NotNull MLModel.Block_compileModelAtURLCompletionHandler handler)

Compile a .mlmodel or .mlpackage for this device. Perform the compilation asynchronously. The model is compiled to a temporary location in the file system. You must move the compiled model to a permanent location if you wish to keep it. Then the model can be loaded using the returned URL: [@code] [MLModel modelWithContentsOfURL:error:] [@endcode] API-Since: 16.0

Parameters:

modelURL - URL file path to .mlmodel file you wish to compile

handler - When the model compilation completes successfully the completion handler is invoked with a valid URL to the compiled .mlmodelc directory. On failure, signified by nil compiledModelURL, the NSError object is populated.

loadModelAssetConfigurationCompletionHandler

public static void loadModelAssetConfigurationCompletionHandler(@NotNull
                                                                @NotNull MLModelAsset asset,
                                                                @NotNull
                                                                @NotNull MLModelConfiguration configuration,
                                                                @NotNull
                                                                @NotNull MLModel.Block_loadModelAssetConfigurationCompletionHandler handler)

Construct a model asynchronously from a compiled model asset.

Parameters:

asset - Compiled model asset derived from in-memory or on-disk Core ML model

configuration - Model configuration that hold options for loading a model

handler - When the model load completes successfully or unsuccessfully, the completion handler is invoked with a valid MLModel instance or NSError object. API-Since: 16.0

availableComputeDevices

@NotNull
public static @NotNull NSArray<?> availableComputeDevices()

The list of available compute devices for CoreML. Use the method to get the list of compute devices that MLModel's prediction can use. Some compute devices on the hardware are exclusive to the domain ML frameworks such as Vision and SoundAnalysis and not available to CoreML. See also `MLComputeDevice.allComputeDevices`. API-Since: 17.0

predictionFromFeaturesCompletionHandler

public void predictionFromFeaturesCompletionHandler(@NotNull
                                                    @NotNull MLFeatureProvider input,
                                                    @NotNull
                                                    @NotNull MLModel.Block_predictionFromFeaturesCompletionHandler completionHandler)

Convenience method to run a prediction asynchronously with default prediction options. API-Since: 17.0

predictionFromFeaturesOptionsCompletionHandler

public void predictionFromFeaturesOptionsCompletionHandler(@NotNull
                                                           @NotNull MLFeatureProvider input,
                                                           @NotNull
                                                           @NotNull MLPredictionOptions options,
                                                           @NotNull
                                                           @NotNull MLModel.Block_predictionFromFeaturesOptionsCompletionHandler completionHandler)

Run a prediction on a model asynchronously.

Parameters:

input - The input features to make a prediction from

options - Prediction options to modify how the prediction is run

completionHandler - A block that will be invoked once the prediction has completed successfully or unsuccessfully. On success, it is invoked with a valid model output. On failure, it is invoked with a nil output and NSError API-Since: 17.0

useStoredAccessor

@Deprecated
public static boolean useStoredAccessor()

Deprecated.