apple.metalperformanceshaders

Class MPSNNOptimizerDescriptor

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSNNOptimizerDescriptor

All Implemented Interfaces:

NSObject

public class MPSNNOptimizerDescriptor
extends NSObject

MPSNNOptimizerDescriptor

The MPSNNOptimizerDescriptor base class. Optimizers are generally used to update trainable neural network parameters. Users are usually expected to call these MPSKernels from the update methods on their Convolution or BatchNormalization data sources.

Before the gradient is used to update the original value, some preprocessing occurs on each gradient where it is scaled or clipped If regularization is chosen the appropriate regularization loss gradient is added to the value gradient.

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	MPSNNOptimizerDescriptor(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static MPSNNOptimizerDescriptor	alloc()
static MPSNNOptimizerDescriptor	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
boolean	applyGradientClipping() [@property] applyGradientClipping
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()
float	gradientClipMax() [@property] gradientClipMax
float	gradientClipMin() [@property] gradientClipMin
float	gradientRescale() [@property] gradientRescale
static long	hash_static()
MPSNNOptimizerDescriptor	init()
MPSNNOptimizerDescriptor	initWithLearningRateGradientRescaleApplyGradientClippingGradientClipMaxGradientClipMinRegularizationTypeRegularizationScale(float learningRate, float gradientRescale, boolean applyGradientClipping, float gradientClipMax, float gradientClipMin, long regularizationType, float regularizationScale) Initialization for the MPSNNOptimizerDescriptor object
MPSNNOptimizerDescriptor	initWithLearningRateGradientRescaleRegularizationTypeRegularizationScale(float learningRate, float gradientRescale, long regularizationType, float regularizationScale) Initialization for the MPSNNOptimizerDescriptor object, no gradient clipping would be applied
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	learningRate() [@property] learningRate
static MPSNNOptimizerDescriptor	new_objc()
static MPSNNOptimizerDescriptor	optimizerDescriptorWithLearningRateGradientRescaleApplyGradientClippingGradientClipMaxGradientClipMinRegularizationTypeRegularizationScale(float learningRate, float gradientRescale, boolean applyGradientClipping, float gradientClipMax, float gradientClipMin, long regularizationType, float regularizationScale) Creates a descriptor on autoreleaspool for the MPSNNOptimizerDescriptor object
static MPSNNOptimizerDescriptor	optimizerDescriptorWithLearningRateGradientRescaleRegularizationTypeRegularizationScale(float learningRate, float gradientRescale, long regularizationType, float regularizationScale) Creates a descriptor on autoreleaspool for the MPSNNOptimizerDescriptor object, no gradient clipping would be applied
float	regularizationScale() [@property] regularizationScale
long	regularizationType() [@property] regularizationType
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
void	setApplyGradientClipping(boolean value) [@property] applyGradientClipping
void	setGradientClipMax(float value) [@property] gradientClipMax
void	setGradientClipMin(float value) [@property] gradientClipMin
void	setGradientRescale(float value) [@property] gradientRescale
void	setLearningRate(float value) [@property] learningRate
void	setRegularizationScale(float value) [@property] regularizationScale
void	setRegularizationType(long value) [@property] regularizationType
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

MPSNNOptimizerDescriptor

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSNNOptimizerDescriptor alloc()

allocWithZone

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

applyGradientClipping

public boolean applyGradientClipping()

[@property] applyGradientClipping

A bool which decides if gradient will be clipped

The default value is NO

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

gradientClipMax

public float gradientClipMax()

[@property] gradientClipMax

The maximum value at which incoming gradient will be clipped before rescaling, applyGradientClipping must be true

gradientClipMin

public float gradientClipMin()

[@property] gradientClipMin

The minimum value at which incoming gradient will be clipped before rescaling, applyGradientClipping must be true

gradientRescale

public float gradientRescale()

[@property] gradientRescale

The gradientRescale at which we apply to incoming gradient values

The default value is 1.0

hash_static

public static long hash_static()

init

public MPSNNOptimizerDescriptor init()

Overrides:

init in class NSObject

initWithLearningRateGradientRescaleApplyGradientClippingGradientClipMaxGradientClipMinRegularizationTypeRegularizationScale

public MPSNNOptimizerDescriptor initWithLearningRateGradientRescaleApplyGradientClippingGradientClipMaxGradientClipMinRegularizationTypeRegularizationScale(float learningRate,
                                                                                                                                                            float gradientRescale,
                                                                                                                                                            boolean applyGradientClipping,
                                                                                                                                                            float gradientClipMax,
                                                                                                                                                            float gradientClipMin,
                                                                                                                                                            long regularizationType,
                                                                                                                                                            float regularizationScale)

Initialization for the MPSNNOptimizerDescriptor object

Parameters:

learningRate - The learningRate which will be applied

gradientRescale - The gradientRescale which will be applied

applyGradientClipping - The BOOL which sets if gradientClipping would be applied to the gradient

gradientClipMax - The gradientClipMax which will be applied

gradientClipMin - The gradientClipMin which will be applied

regularizationType - The regularizationType which will be applied

regularizationScale - The regularizationScale which will be applied

Returns:

A valid MPSNNOptimizerDescriptor object or nil, if failure.

initWithLearningRateGradientRescaleRegularizationTypeRegularizationScale

public MPSNNOptimizerDescriptor initWithLearningRateGradientRescaleRegularizationTypeRegularizationScale(float learningRate,
                                                                                                         float gradientRescale,
                                                                                                         long regularizationType,
                                                                                                         float regularizationScale)

Initialization for the MPSNNOptimizerDescriptor object, no gradient clipping would be applied

Parameters:

learningRate - The learningRate which will be applied

gradientRescale - The gradientRescale which will be applied

regularizationType - The regularizationType which will be applied

regularizationScale - The regularizationScale which will be applied

Returns:

A valid MPSNNOptimizerDescriptor object or nil, if failure.

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)

learningRate

public float learningRate()

[@property] learningRate

The learningRate at which we update values

The default value is 0.001f

new_objc

public static MPSNNOptimizerDescriptor new_objc()

optimizerDescriptorWithLearningRateGradientRescaleApplyGradientClippingGradientClipMaxGradientClipMinRegularizationTypeRegularizationScale

public static MPSNNOptimizerDescriptor optimizerDescriptorWithLearningRateGradientRescaleApplyGradientClippingGradientClipMaxGradientClipMinRegularizationTypeRegularizationScale(float learningRate,
                                                                                                                                                                                  float gradientRescale,
                                                                                                                                                                                  boolean applyGradientClipping,
                                                                                                                                                                                  float gradientClipMax,
                                                                                                                                                                                  float gradientClipMin,
                                                                                                                                                                                  long regularizationType,
                                                                                                                                                                                  float regularizationScale)

Creates a descriptor on autoreleaspool for the MPSNNOptimizerDescriptor object

Parameters:

learningRate - The learningRate which will be applied

gradientRescale - The gradientRescale which will be applied

applyGradientClipping - The BOOL which sets if gradientClipping would be applied to the gradient

gradientClipMax - The gradientClipMax which will be applied

gradientClipMin - The gradientClipMin which will be applied

regularizationType - The regularizationType which will be applied

regularizationScale - The regularizationScale which will be applied

Returns:

A valid MPSNNOptimizerDescriptor object or nil, if failure.

optimizerDescriptorWithLearningRateGradientRescaleRegularizationTypeRegularizationScale

public static MPSNNOptimizerDescriptor optimizerDescriptorWithLearningRateGradientRescaleRegularizationTypeRegularizationScale(float learningRate,
                                                                                                                               float gradientRescale,
                                                                                                                               long regularizationType,
                                                                                                                               float regularizationScale)

Creates a descriptor on autoreleaspool for the MPSNNOptimizerDescriptor object, no gradient clipping would be applied

Parameters:

learningRate - The learningRate which will be applied

gradientRescale - The gradientRescale which will be applied

regularizationType - The regularizationType which will be applied

regularizationScale - The regularizationScale which will be applied

Returns:

A valid MPSNNOptimizerDescriptor object or nil, if failure.

regularizationScale

public float regularizationScale()

[@property] regularizationScale

The regularizationScale at which we apply L1 or L2 regularization, it gets ignored if regularization is None

The default value is 0.0

regularizationType

public long regularizationType()

[@property] regularizationType

The regularizationType which we apply.

The default value is MPSRegularizationTypeNone

resolveClassMethod

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

resolveInstanceMethod

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

setApplyGradientClipping

public void setApplyGradientClipping(boolean value)

[@property] applyGradientClipping

A bool which decides if gradient will be clipped

The default value is NO

setGradientClipMax

public void setGradientClipMax(float value)

[@property] gradientClipMax

The maximum value at which incoming gradient will be clipped before rescaling, applyGradientClipping must be true

setGradientClipMin

public void setGradientClipMin(float value)

[@property] gradientClipMin

The minimum value at which incoming gradient will be clipped before rescaling, applyGradientClipping must be true

setGradientRescale

public void setGradientRescale(float value)

[@property] gradientRescale

The gradientRescale at which we apply to incoming gradient values

The default value is 1.0

setLearningRate

public void setLearningRate(float value)

[@property] learningRate

The learningRate at which we update values

The default value is 0.001f

setRegularizationScale

public void setRegularizationScale(float value)

[@property] regularizationScale

The regularizationScale at which we apply L1 or L2 regularization, it gets ignored if regularization is None

The default value is 0.0

setRegularizationType

public void setRegularizationType(long value)

[@property] regularizationType

The regularizationType which we apply.

The default value is MPSRegularizationTypeNone

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