apple.mlcompute

Class MLCInferenceGraph

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.mlcompute.MLCGraph

apple.mlcompute.MLCInferenceGraph

All Implemented Interfaces:

NSObject

public class MLCInferenceGraph
extends MLCGraph

MLCInferenceGraph

An inference graph created from one or more MLCGraph objects plus additional layers added directly to the inference graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MLCInferenceGraph.Block_executeWithInputsDataBatchSizeOptionsCompletionHandler
static interface	MLCInferenceGraph.Block_executeWithInputsDataLossLabelsDataLossLabelWeightsDataBatchSizeOptionsCompletionHandler
static interface	MLCInferenceGraph.Block_executeWithInputsDataLossLabelsDataLossLabelWeightsDataOutputsDataBatchSizeOptionsCompletionHandler
static interface	MLCInferenceGraph.Block_executeWithInputsDataOutputsDataBatchSizeOptionsCompletionHandler

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
boolean	addInputs(NSDictionary<java.lang.String,? extends MLCTensor> inputs) Add the list of inputs to the inference graph
boolean	addInputsLossLabelsLossLabelWeights(NSDictionary<java.lang.String,? extends MLCTensor> inputs, NSDictionary<java.lang.String,? extends MLCTensor> lossLabels, NSDictionary<java.lang.String,? extends MLCTensor> lossLabelWeights) Add the list of inputs to the inference graph
boolean	addOutputs(NSDictionary<java.lang.String,? extends MLCTensor> outputs) Add the list of outputs to the inference graph
static MLCInferenceGraph	alloc()
static MLCInferenceGraph	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()
boolean	compileWithOptionsDevice(long options, MLCDevice device) Compile the training graph for a device.
boolean	compileWithOptionsDeviceInputTensorsInputTensorsData(long options, MLCDevice device, NSDictionary<java.lang.String,? extends MLCTensor> inputTensors, NSDictionary<java.lang.String,? extends MLCTensorData> inputTensorsData) Compile the inference graph for a device.
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
long	deviceMemorySize() [@property] The device memory size used by the inference graph
boolean	executeWithInputsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData, long batchSize, long options, MLCInferenceGraph.Block_executeWithInputsDataBatchSizeOptionsCompletionHandler completionHandler) Execute the inference graph with given input data
boolean	executeWithInputsDataLossLabelsDataLossLabelWeightsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData, NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelsData, NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelWeightsData, long batchSize, long options, MLCInferenceGraph.Block_executeWithInputsDataLossLabelsDataLossLabelWeightsDataBatchSizeOptionsCompletionHandler completionHandler) Execute the inference graph with given input data
boolean	executeWithInputsDataLossLabelsDataLossLabelWeightsDataOutputsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData, NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelsData, NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelWeightsData, NSDictionary<java.lang.String,? extends MLCTensorData> outputsData, long batchSize, long options, MLCInferenceGraph.Block_executeWithInputsDataLossLabelsDataLossLabelWeightsDataOutputsDataBatchSizeOptionsCompletionHandler completionHandler) Execute the inference graph with given input data
boolean	executeWithInputsDataOutputsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData, NSDictionary<java.lang.String,? extends MLCTensorData> outputsData, long batchSize, long options, MLCInferenceGraph.Block_executeWithInputsDataOutputsDataBatchSizeOptionsCompletionHandler completionHandler) Execute the inference graph with given input data
static MLCInferenceGraph	graph()
static MLCInferenceGraph	graphWithGraphObjects(NSArray<? extends MLCGraph> graphObjects) Create an inference graph
static long	hash_static()
MLCInferenceGraph	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)
boolean	linkWithGraphs(NSArray<? extends MLCInferenceGraph> graphs) Link mutiple inference graphs
static MLCInferenceGraph	new_objc()
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.mlcompute.MLCGraph

bindAndWriteDataForInputsToDeviceBatchSizeSynchronous, bindAndWriteDataForInputsToDeviceSynchronous, concatenateWithSourcesDimension, device, gatherWithDimensionSourceIndices, layers, nodeWithLayerSource, nodeWithLayerSources, nodeWithLayerSourcesDisableUpdate, nodeWithLayerSourcesLossLabels, reshapeWithShapeSource, resultTensorsForLayer, scatterWithDimensionSourceIndicesCopyFromReductionType, selectWithSourcesCondition, sourceTensorsForLayer, splitWithSourceSplitCountDimension, splitWithSourceSplitSectionLengthsDimension, summarizedDOTDescription, transposeWithDimensionsSource

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

MLCInferenceGraph

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

addInputs

public boolean addInputs(NSDictionary<java.lang.String,? extends MLCTensor> inputs)

Add the list of inputs to the inference graph

Parameters:

inputs - The inputs

Returns:

A boolean indicating success or failure

addInputsLossLabelsLossLabelWeights

public boolean addInputsLossLabelsLossLabelWeights(NSDictionary<java.lang.String,? extends MLCTensor> inputs,
                                                   NSDictionary<java.lang.String,? extends MLCTensor> lossLabels,
                                                   NSDictionary<java.lang.String,? extends MLCTensor> lossLabelWeights)

Add the list of inputs to the inference graph

Each input, loss label or label weights tensor is identified by a NSString. When the inference graph is executed, this NSString is used to identify which data object should be as input data for each tensor whose device memory needs to be updated before the graph is executed.

Parameters:

inputs - The inputs

lossLabels - The loss label inputs

lossLabelWeights - The loss label weights

Returns:

A boolean indicating success or failure

addOutputs

public boolean addOutputs(NSDictionary<java.lang.String,? extends MLCTensor> outputs)

Add the list of outputs to the inference graph

Parameters:

outputs - The outputs

Returns:

A boolean indicating success or failure

alloc

public static MLCInferenceGraph alloc()

allocWithZone

public static MLCInferenceGraph 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()

compileWithOptionsDevice

public boolean compileWithOptionsDevice(long options,
                                        MLCDevice device)

Compile the training graph for a device.

Parameters:

options - The compiler options to use when compiling the training graph

device - The MLCDevice object

Returns:

A boolean indicating success or failure

compileWithOptionsDeviceInputTensorsInputTensorsData

public boolean compileWithOptionsDeviceInputTensorsInputTensorsData(long options,
                                                                    MLCDevice device,
                                                                    NSDictionary<java.lang.String,? extends MLCTensor> inputTensors,
                                                                    NSDictionary<java.lang.String,? extends MLCTensorData> inputTensorsData)

Compile the inference graph for a device.

Specifying the list of constant tensors when we compile the graph allows MLCompute to perform additional optimizations at compile time.

Parameters:

options - The compiler options to use when compiling the inference graph

device - The MLCDevice object

inputTensors - The list of input tensors that are constants

inputTensorsData - The tensor data to be used with these constant input tensors

Returns:

A boolean indicating success or failure

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

deviceMemorySize

public long deviceMemorySize()

[@property] The device memory size used by the inference graph

Returns the total size in bytes of device memory used by all intermediate tensors in the inference graph

Returns:

A NSUInteger value

executeWithInputsDataBatchSizeOptionsCompletionHandler

public boolean executeWithInputsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData,
                                                                      long batchSize,
                                                                      long options,
                                                                      MLCInferenceGraph.Block_executeWithInputsDataBatchSizeOptionsCompletionHandler completionHandler)

Execute the inference graph with given input data

Execute the inference graph given input data. If MLCExecutionOptionsSynchronous is specified in 'options', this method returns after the graph has been executed. Otherwise, this method returns after the graph has been queued for execution. The completion handler is called after the graph has finished execution.

Parameters:

inputsData - The data objects to use for inputs

batchSize - The batch size to use. For a graph where batch size changes between layers this value must be 0.

options - The execution options

completionHandler - The completion handler

Returns:

A boolean indicating success or failure

executeWithInputsDataLossLabelsDataLossLabelWeightsDataBatchSizeOptionsCompletionHandler

public boolean executeWithInputsDataLossLabelsDataLossLabelWeightsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData,
                                                                                                        NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelsData,
                                                                                                        NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelWeightsData,
                                                                                                        long batchSize,
                                                                                                        long options,
                                                                                                        MLCInferenceGraph.Block_executeWithInputsDataLossLabelsDataLossLabelWeightsDataBatchSizeOptionsCompletionHandler completionHandler)

Execute the inference graph with given input data

Execute the inference graph given input data. If MLCExecutionOptionsSynchronous is specified in 'options', this method returns after the graph has been executed. Otherwise, this method returns after the graph has been queued for execution. The completion handler is called after the graph has finished execution.

Parameters:

inputsData - The data objects to use for inputs

lossLabelsData - The data objects to use for loss labels

lossLabelWeightsData - The data objects to use for loss label weights

batchSize - The batch size to use. For a graph where batch size changes between layers this value must be 0.

options - The execution options

completionHandler - The completion handler

Returns:

A boolean indicating success or failure

executeWithInputsDataLossLabelsDataLossLabelWeightsDataOutputsDataBatchSizeOptionsCompletionHandler

public boolean executeWithInputsDataLossLabelsDataLossLabelWeightsDataOutputsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData,
                                                                                                                   NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelsData,
                                                                                                                   NSDictionary<java.lang.String,? extends MLCTensorData> lossLabelWeightsData,
                                                                                                                   NSDictionary<java.lang.String,? extends MLCTensorData> outputsData,
                                                                                                                   long batchSize,
                                                                                                                   long options,
                                                                                                                   MLCInferenceGraph.Block_executeWithInputsDataLossLabelsDataLossLabelWeightsDataOutputsDataBatchSizeOptionsCompletionHandler completionHandler)

Execute the inference graph with given input data

Execute the inference graph given input data. If MLCExecutionOptionsSynchronous is specified in 'options', this method returns after the graph has been executed. Otherwise, this method returns after the graph has been queued for execution. The completion handler is called after the graph has finished execution.

Parameters:

inputsData - The data objects to use for inputs

lossLabelsData - The data objects to use for loss labels

lossLabelWeightsData - The data objects to use for loss label weights

outputsData - The data objects to use for outputs

batchSize - The batch size to use. For a graph where batch size changes between layers this value must be 0.

options - The execution options

completionHandler - The completion handler

Returns:

A boolean indicating success or failure

executeWithInputsDataOutputsDataBatchSizeOptionsCompletionHandler

public boolean executeWithInputsDataOutputsDataBatchSizeOptionsCompletionHandler(NSDictionary<java.lang.String,? extends MLCTensorData> inputsData,
                                                                                 NSDictionary<java.lang.String,? extends MLCTensorData> outputsData,
                                                                                 long batchSize,
                                                                                 long options,
                                                                                 MLCInferenceGraph.Block_executeWithInputsDataOutputsDataBatchSizeOptionsCompletionHandler completionHandler)

Execute the inference graph with given input data

Execute the inference graph given input data. If MLCExecutionOptionsSynchronous is specified in 'options', this method returns after the graph has been executed. Otherwise, this method returns after the graph has been queued for execution. The completion handler is called after the graph has finished execution.

Parameters:

inputsData - The data objects to use for inputs

outputsData - The data objects to use for outputs

batchSize - The batch size to use. For a graph where batch size changes between layers this value must be 0.

options - The execution options

completionHandler - The completion handler

Returns:

A boolean indicating success or failure

graph

public static MLCInferenceGraph graph()

graphWithGraphObjects

public static MLCInferenceGraph graphWithGraphObjects(NSArray<? extends MLCGraph> graphObjects)

Create an inference graph

Parameters:

graphObjects - The layers from these graph objects will be added to the training graph

Returns:

A new inference graph object

hash_static

public static long hash_static()

init

public MLCInferenceGraph init()

Overrides:

init in class MLCGraph

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)

linkWithGraphs

public boolean linkWithGraphs(NSArray<? extends MLCInferenceGraph> graphs)

Link mutiple inference graphs

This is used to link subsequent inference graphs with first inference sub-graph. This method should be used when we have tensors shared by one or more layers in multiple sub-graphs

Parameters:

graphs - The list of inference graphs to link

Returns:

A boolean indicating success or failure

new_objc

public static MLCInferenceGraph new_objc()

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()