apple.mlcompute

Class MLCAdamOptimizer

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.mlcompute.MLCOptimizer

apple.mlcompute.MLCAdamOptimizer

All Implemented Interfaces:

NSCopying, NSObject

public class MLCAdamOptimizer
extends MLCOptimizer
implements NSCopying

MLCAdamOptimizer

The MLCAdamOptimizer specifies the Adam optimizer.

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

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static MLCAdamOptimizer	alloc()
static MLCAdamOptimizer	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
float	beta1() [@property] beta1
float	beta2() [@property] beta2
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()
java.lang.Object	copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
float	epsilon() [@property] epsilon
static long	hash_static()
MLCAdamOptimizer	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 MLCAdamOptimizer	new_objc()
static MLCAdamOptimizer	optimizerWithDescriptor(MLCOptimizerDescriptor optimizerDescriptor) Create a MLCAdamOptimizer object with defaults
static MLCAdamOptimizer	optimizerWithDescriptorBeta1Beta2EpsilonTimeStep(MLCOptimizerDescriptor optimizerDescriptor, float beta1, float beta2, float epsilon, long timeStep) Create a MLCAdamOptimizer object
static MLCAdamOptimizer	optimizerWithDescriptorBeta1Beta2EpsilonUsesAMSGradTimeStep(MLCOptimizerDescriptor optimizerDescriptor, float beta1, float beta2, float epsilon, boolean usesAMSGrad, long timeStep) Create a MLCAdamOptimizer object
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()
long	timeStep() [@property] timeStep
boolean	usesAMSGrad() [@property] usesAMSGrad
static long	version_static()

Methods inherited from class apple.mlcompute.MLCOptimizer

appliesGradientClipping, customGlobalNorm, gradientClipMax, gradientClipMin, gradientClippingType, gradientRescale, learningRate, maximumClippingNorm, regularizationScale, regularizationType, setAppliesGradientClipping, setLearningRate

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

MLCAdamOptimizer

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MLCAdamOptimizer alloc()

allocWithZone

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

automaticallyNotifiesObserversForKey

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

beta1

public float beta1()

[@property] beta1

Coefficent used for computing running averages of gradient.

The default is 0.9.

beta2

public float beta2()

[@property] beta2

Coefficent used for computing running averages of square of gradient.

The default is 0.999.

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

copyWithZone

public java.lang.Object copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)

Specified by:

copyWithZone in interface NSCopying

Overrides:

copyWithZone in class MLCOptimizer

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

epsilon

public float epsilon()

[@property] epsilon

A term added to improve numerical stability.

The default is 1e-8.

hash_static

public static long hash_static()

init

public MLCAdamOptimizer init()

Overrides:

init in class MLCOptimizer

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

optimizerWithDescriptor

public static MLCAdamOptimizer optimizerWithDescriptor(MLCOptimizerDescriptor optimizerDescriptor)

Create a MLCAdamOptimizer object with defaults

Returns:

A new MLCAdamOptimizer object.

optimizerWithDescriptorBeta1Beta2EpsilonTimeStep

public static MLCAdamOptimizer optimizerWithDescriptorBeta1Beta2EpsilonTimeStep(MLCOptimizerDescriptor optimizerDescriptor,
                                                                                float beta1,
                                                                                float beta2,
                                                                                float epsilon,
                                                                                long timeStep)

Create a MLCAdamOptimizer object

Parameters:

optimizerDescriptor - The optimizer descriptor object

beta1 - The beta1 value

beta2 - The beta2 value

epsilon - The epsilon value to use to improve numerical stability

timeStep - The initial timestep to use for the update

Returns:

A new MLCAdamOptimizer object.

optimizerWithDescriptorBeta1Beta2EpsilonUsesAMSGradTimeStep

public static MLCAdamOptimizer optimizerWithDescriptorBeta1Beta2EpsilonUsesAMSGradTimeStep(MLCOptimizerDescriptor optimizerDescriptor,
                                                                                           float beta1,
                                                                                           float beta2,
                                                                                           float epsilon,
                                                                                           boolean usesAMSGrad,
                                                                                           long timeStep)

Create a MLCAdamOptimizer object

Parameters:

optimizerDescriptor - The optimizer descriptor object

beta1 - The beta1 value

beta2 - The beta2 value

epsilon - The epsilon value to use to improve numerical stability

usesAMSGrad - Whether to use the AMSGrad variant of this algorithm from the paper (https://arxiv.org/abs/1904.09237)

timeStep - The initial timestep to use for the update

Returns:

A new MLCAdamOptimizer object.

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

timeStep

public long timeStep()

[@property] timeStep

The current timestep used for the update.

The default is 1.

usesAMSGrad

public boolean usesAMSGrad()

[@property] usesAMSGrad

Whether to use the AMSGrad variant of this algorithm

The default is false

version_static

public static long version_static()