apple.metalperformanceshaders

Class MPSCNNFullyConnected

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSKernel

apple.metalperformanceshaders.MPSCNNKernel

apple.metalperformanceshaders.MPSCNNConvolution

apple.metalperformanceshaders.MPSCNNFullyConnected

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject

public class MPSCNNFullyConnected
extends MPSCNNConvolution

MPSCNNFullyConnected [@dependency] This depends on Metal.framework

The MPSCNNFullyConnected specifies a fully connected convolution layer a.k.a. Inner product layer. A fully connected CNN layer is one where every input channel is connected to every output channel. The kernel width is equal to width of source image and the kernel height is equal to the height of source image. Width and height of the output is 1x1. Thus, it takes a srcW x srcH x Ni MPSCNNImage, convolves it with Weights[No][SrcW][srcH][Ni] and produces a 1 x 1 x No output. The following must be true: [@code] kernelWidth == source.width kernelHeight == source.height clipRect.size.width == 1 clipRect.size.height == 1 [@endcode] One can think of a fully connected layer as a matrix multiplication that flattens an image into a vector of length srcW*srcH*Ni. The weights are arragned in a matrix of dimension No x (srcW*srcH*Ni) for product output vectors of length No. The strideInPixelsX, strideInPixelsY, and group must be 1. Offset is not applicable and is ignored. Since clipRect is clamped to the destination image bounds, if the destination is 1x1, one doesn't need to set the clipRect.

Note that one can implement an inner product using MPSCNNConvolution by setting [@code] offset = (kernelWidth/2,kernelHeight/2) clipRect.origin = (ox,oy), clipRect.size = (1,1) strideX = strideY = group = 1 [@endcode] However, using the MPSCNNFullyConnected for this is better for performance as it lets us choose the most performant method which may not be possible when using a general convolution. For example, we may internally use matrix multiplication or special reduction kernels for a specific platform.

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	_supportsSecureCoding() This property must return YES on all classes that allow secure coding.
static boolean	accessInstanceVariablesDirectly()
static MPSCNNFullyConnected	alloc()
static MPSCNNFullyConnected	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 java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static long	hash_static()
MPSCNNFullyConnected	init()
MPSCNNFullyConnected	initWithCoder(NSCoder aDecoder) NS_DESIGNATED_INITIALIZER
MPSCNNFullyConnected	initWithCoderDevice(NSCoder aDecoder, java.lang.Object device) NSSecureCoding compatability
MPSCNNFullyConnected	initWithDevice(java.lang.Object device) Standard init with default properties per filter type
MPSCNNFullyConnected	initWithDeviceConvolutionDescriptorKernelWeightsBiasTermsFlags(MTLDevice device, MPSCNNConvolutionDescriptor convolutionDescriptor, org.moe.natj.general.ptr.ConstFloatPtr kernelWeights, org.moe.natj.general.ptr.ConstFloatPtr biasTerms, long flags) Initializes a convolution kernel WARNING: This API is depreated and will be removed in the future.
MPSCNNFullyConnected	initWithDeviceWeights(MTLDevice device, MPSCNNConvolutionDataSource weights) Initializes a fully connected kernel
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 MPSCNNFullyConnected	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 boolean	supportsSecureCoding()
static long	version_static()

Methods inherited from class apple.metalperformanceshaders.MPSCNNConvolution

accumulatorPrecisionOption, channelMultiplier, dataSource, exportWeightsAndBiasesWithCommandBufferResultStateCanBeTemporary, fusedNeuronDescriptor, groups, inputFeatureChannels, neuron, neuronParameterA, neuronParameterB, neuronParameterC, neuronType, outputFeatureChannels, reloadWeightsAndBiasesFromDataSource, reloadWeightsAndBiasesWithCommandBufferState, reloadWeightsAndBiasesWithDataSource, resultStateForSourceImageSourceStatesDestinationImage, setAccumulatorPrecisionOption, subPixelScaleFactor, temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage

Methods inherited from class apple.metalperformanceshaders.MPSCNNKernel

appendBatchBarrier, clipRect, destinationFeatureChannelOffset, destinationImageAllocator, destinationImageDescriptorForSourceImagesSourceStates, dilationRateX, dilationRateY, edgeMode, encodeToCommandBufferSourceImage, encodeToCommandBufferSourceImageDestinationImage, encodeToCommandBufferSourceImageDestinationStateDestinationImage, encodeToCommandBufferSourceImageDestinationStateDestinationStateIsTemporary, encodingStorageSizeForSourceImageSourceStatesDestinationImage, isBackwards, isResultStateReusedAcrossBatch, isStateModified, kernelHeight, kernelWidth, offset, padding, setClipRect, setDestinationFeatureChannelOffset, setDestinationImageAllocator, setEdgeMode, setOffset, setPadding, setSourceFeatureChannelMaxCount, setSourceFeatureChannelOffset, sourceFeatureChannelMaxCount, sourceFeatureChannelOffset, strideInPixelsX, strideInPixelsY

Methods inherited from class apple.metalperformanceshaders.MPSKernel

copyWithZone, copyWithZoneDevice, device, encodeWithCoder, label, options, setLabel, setOptions

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

MPSCNNFullyConnected

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSCNNFullyConnected alloc()

allocWithZone

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

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

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)

new_objc

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

init

public MPSCNNFullyConnected init()

Overrides:

init in class MPSCNNConvolution

initWithDevice

public MPSCNNFullyConnected initWithDevice(java.lang.Object device)

Description copied from class: MPSCNNKernel

Standard init with default properties per filter type

Overrides:

initWithDevice in class MPSCNNConvolution

Parameters:

device - The device that the filter will be used on. May not be NULL.

Returns:

A pointer to the newly initialized object. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later.

initWithDeviceConvolutionDescriptorKernelWeightsBiasTermsFlags

public MPSCNNFullyConnected initWithDeviceConvolutionDescriptorKernelWeightsBiasTermsFlags(MTLDevice device,
                                                                                           MPSCNNConvolutionDescriptor convolutionDescriptor,
                                                                                           org.moe.natj.general.ptr.ConstFloatPtr kernelWeights,
                                                                                           org.moe.natj.general.ptr.ConstFloatPtr biasTerms,
                                                                                           long flags)

Initializes a convolution kernel WARNING: This API is depreated and will be removed in the future. It cannot be used when training. Also serialization/unserialization wont work for MPSCNNConvolution objects created with this init. Please move onto using initWithDevice:weights:.

Overrides:

initWithDeviceConvolutionDescriptorKernelWeightsBiasTermsFlags in class MPSCNNConvolution

Parameters:

device - The MTLDevice on which this MPSCNNConvolution filter will be used

convolutionDescriptor - A pointer to a MPSCNNConvolutionDescriptor.

kernelWeights - A pointer to a weights array. Each entry is a float value. The number of entries is = inputFeatureChannels * outputFeatureChannels * kernelHeight * kernelWidth The layout of filter weight is so that it can be reinterpreted as 4D tensor (array) weight[ outputChannels ][ kernelHeight ][ kernelWidth ][ inputChannels / groups ] Weights are converted to half float (fp16) internally for best performance.

biasTerms - A pointer to bias terms to be applied to the convolution output. Each entry is a float value. The number of entries is = numberOfOutputFeatureMaps

flags - Currently unused. Pass MPSCNNConvolutionFlagsNone

Returns:

A valid MPSCNNConvolution object or nil, if failure.

initWithCoder

public MPSCNNFullyConnected initWithCoder(NSCoder aDecoder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class MPSCNNConvolution

initWithCoderDevice

public MPSCNNFullyConnected initWithCoderDevice(NSCoder aDecoder,
                                                java.lang.Object device)

NSSecureCoding compatability

While the standard NSSecureCoding/NSCoding method -initWithCoder: should work, since the file can't know which device your data is allocated on, we have to guess and may guess incorrectly. To avoid that problem, use initWithCoder:device instead.

Overrides:

initWithCoderDevice in class MPSCNNConvolution

Parameters:

aDecoder - The NSCoder subclass with your serialized MPSKernel

device - The MTLDevice on which to make the MPSKernel

Returns:

A new MPSKernel object, or nil if failure.

initWithDeviceWeights

public MPSCNNFullyConnected initWithDeviceWeights(MTLDevice device,
                                                  MPSCNNConvolutionDataSource weights)

Initializes a fully connected kernel

Overrides:

initWithDeviceWeights in class MPSCNNConvolution

Parameters:

device - The MTLDevice on which this MPSCNNFullyConnected filter will be used

weights - A pointer to a object that conforms to the MPSCNNConvolutionDataSource protocol. The MPSCNNConvolutionDataSource protocol declares the methods that an instance of MPSCNNFullyConnected uses to obtain the weights and bias terms for the CNN fully connected filter.

Returns:

A valid MPSCNNFullyConnected object or nil, if failure.

supportsSecureCoding

public static boolean supportsSecureCoding()

_supportsSecureCoding

public boolean _supportsSecureCoding()

Description copied from interface: NSSecureCoding

This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.

Specified by:

_supportsSecureCoding in interface NSSecureCoding

Overrides:

_supportsSecureCoding in class MPSCNNConvolution