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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MLModel.Block_loadContentsOfURLConfigurationCompletionHandler

Nested classes/interfaces inherited from class apple.NSObject

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 java.lang.Object	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static NSURL	compileModelAtURLError(NSURL modelURL, org.moe.natj.general.ptr.Ptr<NSError> error)	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 permenant location if you wish to keep it the returned model can be loaded using: [@code] [MLModel modelWithContentsOfURL:error:] [@endcode]
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 NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
static void	loadContentsOfURLConfigurationCompletionHandler(NSURL url, MLModelConfiguration configuration, MLModel.Block_loadContentsOfURLConfigurationCompletionHandler handler)	Construct a model asynchronously given the location of its on-disk representation and configuration.
MLModelDescription	modelDescription()	A model holds a description of its required inputs and expected outputs.
static MLModel	modelWithContentsOfURLConfigurationError(NSURL url, MLModelConfiguration configuration, org.moe.natj.general.ptr.Ptr<NSError> error)	Construct a model given the location of its on-disk representation.
static MLModel	modelWithContentsOfURLError(NSURL url, org.moe.natj.general.ptr.Ptr<NSError> error)	Construct a model with a default MLModelConfiguration object
static java.lang.Object	new_objc()
java.lang.Object	parameterValueForKeyError(MLParameterKey key, org.moe.natj.general.ptr.Ptr<NSError> error)	Provides value for the given parameter.
MLFeatureProvider	predictionFromFeaturesError(MLFeatureProvider input, org.moe.natj.general.ptr.Ptr<NSError> error)	All models can predict on a specific set of input features.
MLFeatureProvider	predictionFromFeaturesOptionsError(MLFeatureProvider input, MLPredictionOptions options, org.moe.natj.general.ptr.Ptr<NSError> error)	Prediction with explicit options
MLBatchProvider	predictionsFromBatchError(MLBatchProvider inputBatch, org.moe.natj.general.ptr.Ptr<NSError> error)	Batch prediction without explicit options
MLBatchProvider	predictionsFromBatchOptionsError(MLBatchProvider inputBatch, MLPredictionOptions options, org.moe.natj.general.ptr.Ptr<NSError> error)	Batch prediction with explicit options
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 long	version_static()

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, 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, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, 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 java.lang.Object allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

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

cancelPreviousPerformRequestsWithTarget

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

cancelPreviousPerformRequestsWithTargetSelectorObject

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

classFallbacksForKeyedArchiver

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

classForKeyedUnarchiver

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

compileModelAtURLError

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

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 permenant location if you wish to keep it the returned model can be loaded using: [@code] [MLModel modelWithContentsOfURL:error:] [@endcode]

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

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

modelDescription

public MLModelDescription modelDescription()

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

modelWithContentsOfURLError

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

Construct a model with a default MLModelConfiguration object

new_objc

public static java.lang.Object new_objc()

predictionFromFeaturesError

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

All models can predict on a specific set of input features.

predictionFromFeaturesOptionsError

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

Prediction with explicit options

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

public MLModelConfiguration configuration()

The load-time parameters used to instantiate this MLModel object.

modelWithContentsOfURLConfigurationError

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

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

parameterValueForKeyError

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

Provides value for the given parameter. Returns nil on error.

predictionsFromBatchError

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

Batch prediction without explicit options

predictionsFromBatchOptionsError

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

Batch prediction with explicit options

loadContentsOfURLConfigurationCompletionHandler

public static void loadContentsOfURLConfigurationCompletionHandler(NSURL url,
                                                                   MLModelConfiguration configuration,
                                                                   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.