apple.metalperformanceshaders

Class MPSMatrixNeuron

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSKernel

apple.metalperformanceshaders.MPSMatrixUnaryKernel

apple.metalperformanceshaders.MPSMatrixNeuron

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject

public class MPSMatrixNeuron
extends MPSMatrixUnaryKernel

MPSMatrixNeuron

[@dependency] This depends on Metal.framework.

A neuron activation kernel that operates on matrices.

A MPSMatrixNeuron object computes:

y = neuron(alpha * x + bias)

y is the output matrix, x is the input matrix corresponding to a collection of input vectors and bias is a vector which is broadcast and accumulated to each row of the intermediate result. alpha is a scale factor applied to the input.

neuron() defines the pointwise function that is applied to the intermediate result.

Note: This function computes the same result as MPSMatrixFullyConnected that has unit weight matrix.

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	MPSMatrixNeuron(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 MPSMatrixNeuron	alloc()
static MPSMatrixNeuron	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
double	alpha() [@property] alpha
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()
MPSMatrixNeuron	copyWithZoneDevice(org.moe.natj.general.ptr.VoidPtr zone, MTLDevice device) Make a copy of this kernel for a new device - @see MPSKernel
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
void	encodeToCommandBufferInputMatrixBiasVectorResultMatrix(MTLCommandBuffer commandBuffer, MPSMatrix inputMatrix, MPSVector biasVector, MPSMatrix resultMatrix) Encode a MPSMatrixNeuron object to a command buffer.
static long	hash_static()
MPSMatrixNeuron	init()
MPSMatrixNeuron	initWithCoder(NSCoder aDecoder) NS_DESIGNATED_INITIALIZER
MPSMatrixNeuron	initWithCoderDevice(NSCoder aDecoder, java.lang.Object device) NSSecureCoding compatability
MPSMatrixNeuron	initWithDevice(java.lang.Object device) Standard init with default properties per filter type
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)
float	neuronParameterA() Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method
float	neuronParameterB() Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method
float	neuronParameterC() Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method
int	neuronType() Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method
static MPSMatrixNeuron	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setAlpha(double value) [@property] alpha
void	setNeuronToPReLUWithParametersA(NSData A) Add per output value neuron parameters A for PReLu neuron activation functions.
void	setNeuronTypeParameterAParameterBParameterC(int neuronType, float parameterA, float parameterB, float parameterC) Specifies a neuron activation function to be used.
void	setSourceInputFeatureChannels(long value) [@property] sourceInputFeatureChannels
void	setSourceNumberOfFeatureVectors(long value) [@property] sourceNumberOfFeatureVectors
static void	setVersion_static(long aVersion)
long	sourceInputFeatureChannels() [@property] sourceInputFeatureChannels
long	sourceNumberOfFeatureVectors() [@property] sourceNumberOfFeatureVectors
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
static long	version_static()

Methods inherited from class apple.metalperformanceshaders.MPSMatrixUnaryKernel

batchSize, batchStart, resultMatrixOrigin, setBatchSize, setBatchStart, setResultMatrixOrigin, setSourceMatrixOrigin, sourceMatrixOrigin

Methods inherited from class apple.metalperformanceshaders.MPSKernel

copyWithZone, 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

MPSMatrixNeuron

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSMatrixNeuron alloc()

allocWithZone

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

alpha

public double alpha()

[@property] alpha

The scale factor to apply to the input. Specified in double precision. Will be converted to the appropriate precision in the implementation subject to rounding and/or clamping as necessary. Defaults to 1.0 at initialization time.

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

copyWithZoneDevice

public MPSMatrixNeuron copyWithZoneDevice(org.moe.natj.general.ptr.VoidPtr zone,
                                          MTLDevice device)

Make a copy of this kernel for a new device - @see MPSKernel

Overrides:

copyWithZoneDevice in class MPSKernel

Parameters:

zone - The NSZone in which to allocate the object

device - The device for the new MPSKernel. If nil, then use self.device.

Returns:

A pointer to a copy of this MPSKernel. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later.

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

encodeToCommandBufferInputMatrixBiasVectorResultMatrix

public void encodeToCommandBufferInputMatrixBiasVectorResultMatrix(MTLCommandBuffer commandBuffer,
                                                                   MPSMatrix inputMatrix,
                                                                   MPSVector biasVector,
                                                                   MPSMatrix resultMatrix)

Encode a MPSMatrixNeuron object to a command buffer.

Encodes the operation to the specified command buffer. resultMatrix must be large enough to hold a MIN(sourceNumberOfFeatureVectors, inputMatrix.rows - sourceMatrixOrigin.x) x MIN(inputMatrix.columns - sourceMatrixOrigin.y, sourceInputFeatureChannels) array.

The bias vector must contain at least MIN(inputMatrix.columns - sourceMatrixOrigin.y, sourceInputFeatureChannels) elements.

Parameters:

commandBuffer - A valid MTLCommandBuffer to receive the encoded kernel.

inputMatrix - A valid MPSMatrix object which specifies the input array.

biasVector - A valid MPSVector object which specifies the bias values, or a null object to indicate that no bias is to be applied.

resultMatrix - A valid MPSMatrix object which specifies the output array.

hash_static

public static long hash_static()

init

public MPSMatrixNeuron init()

Overrides:

init in class MPSMatrixUnaryKernel

initWithCoder

public MPSMatrixNeuron initWithCoder(NSCoder aDecoder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class MPSMatrixUnaryKernel

initWithCoderDevice

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

NSSecureCoding compatability

See @ref MPSKernel#initWithCoder.

Overrides:

initWithCoderDevice in class MPSMatrixUnaryKernel

Parameters:

aDecoder - The NSCoder subclass with your serialized MPSMatrixNeuron

device - The MTLDevice on which to make the MPSMatrixNeuron object.

Returns:

A new MPSMatrixNeuron object, or nil if failure.

initWithDevice

public MPSMatrixNeuron initWithDevice(java.lang.Object device)

Description copied from class: MPSKernel

Standard init with default properties per filter type

Overrides:

initWithDevice in class MPSMatrixUnaryKernel

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.

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)

neuronParameterA

public float neuronParameterA()

Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

neuronParameterB

public float neuronParameterB()

Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

neuronParameterC

public float neuronParameterC()

Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

neuronType

public int neuronType()

Getter funtion for neuronType set using setNeuronType:parameterA:parameterB:parameterC method

new_objc

public static MPSMatrixNeuron new_objc()

resolveClassMethod

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

resolveInstanceMethod

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

setAlpha

public void setAlpha(double value)

[@property] alpha

The scale factor to apply to the input. Specified in double precision. Will be converted to the appropriate precision in the implementation subject to rounding and/or clamping as necessary. Defaults to 1.0 at initialization time.

setNeuronToPReLUWithParametersA

public void setNeuronToPReLUWithParametersA(NSData A)

Add per output value neuron parameters A for PReLu neuron activation functions.

This method sets the neuron to PReLU, zeros parameters A and B and sets the per output value neuron parameters A to an array containing a unique value of A for each output value.

If the neuron function is f(v,a,b), it will apply

resultMatrix(i, j) = f( input(i, j), A[j], B[j] ) where j in [0, sourceInputFeatureChannels]

See https://arxiv.org/pdf/1502.01852.pdf for details.

All other neuron types, where parameter A and parameter B are shared across output values must be set using -setNeuronType:parameterA:parameterB:

Parameters:

A - An array containing float values for neuron parameter A. Number of entries must be equal to MIN(inputMatrix.columns - sourceMatrixOrigin.y, sourceInputFeatureChannels)

setNeuronTypeParameterAParameterBParameterC

public void setNeuronTypeParameterAParameterBParameterC(int neuronType,
                                                        float parameterA,
                                                        float parameterB,
                                                        float parameterC)

Specifies a neuron activation function to be used.

This method can be used to add a neuron activation funtion of given type with associated scalar parameters A, B, and C that are shared across all output values. Note that this method can only be used to specify neurons which are specified by three (or fewer) parameters shared across all output values (or channels, in CNN nomenclature). It is an error to call this method for neuron activation functions like MPSCNNNeuronTypePReLU, which require per-channel parameter values. For those kind of neuron activation functions, use appropriate setter functions. An MPSMatrixNeuron kernel is initialized with a default neuron function of MPSCNNNeuronTypeNone.

Parameters:

neuronType - Type of neuron activation function. For full list see MPSCNNNeuronType.h

parameterA - parameterA of neuron activation that is shared across all output values.

parameterB - parameterB of neuron activation that is shared across all output values.

parameterC - parameterC of neuron activation that is shared across all output values.

setSourceInputFeatureChannels

public void setSourceInputFeatureChannels(long value)

[@property] sourceInputFeatureChannels

The input size to to use in the operation. This is equivalent to the number of columns in the primary (input array) source matrix to consider and the number of channels to produce for the output matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available input size is used. The value of NSUIntegerMax thus indicates that all available columns in the input array (beginning at sourceMatrixOrigin.y) should be considered. Defines also the number of output feature channels. Note: The value used in the operation will be MIN(inputMatrix.columns - sourceMatrixOrigin.y, sourceInputFeatureChannels)

setSourceNumberOfFeatureVectors

public void setSourceNumberOfFeatureVectors(long value)

[@property] sourceNumberOfFeatureVectors

The number of input vectors which make up the input array. This is equivalent to the number of rows to consider from the primary source matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available number of inputs is used. The value of NSUIntegerMax thus indicates that all available input rows (beginning at sourceMatrixOrigin.x) should be considered.

setVersion_static

public static void setVersion_static(long aVersion)

sourceInputFeatureChannels

public long sourceInputFeatureChannels()

[@property] sourceInputFeatureChannels

The input size to to use in the operation. This is equivalent to the number of columns in the primary (input array) source matrix to consider and the number of channels to produce for the output matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available input size is used. The value of NSUIntegerMax thus indicates that all available columns in the input array (beginning at sourceMatrixOrigin.y) should be considered. Defines also the number of output feature channels. Note: The value used in the operation will be MIN(inputMatrix.columns - sourceMatrixOrigin.y, sourceInputFeatureChannels)

sourceNumberOfFeatureVectors

public long sourceNumberOfFeatureVectors()

[@property] sourceNumberOfFeatureVectors

The number of input vectors which make up the input array. This is equivalent to the number of rows to consider from the primary source matrix. This property is modifiable and defaults to NSUIntegerMax. At encode time the larger of this property or the available number of inputs is used. The value of NSUIntegerMax thus indicates that all available input rows (beginning at sourceMatrixOrigin.x) should be considered.

superclass_static

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

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 MPSMatrixUnaryKernel

version_static

public static long version_static()