apple.mlcompute

Class MLCLSTMDescriptor

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.mlcompute.MLCLSTMDescriptor

All Implemented Interfaces:

NSCopying, NSObject

public class MLCLSTMDescriptor
extends NSObject
implements NSCopying

MLCLSTMDescriptor

The MLCLSTMDescriptor specifies a LSTM descriptor

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

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static MLCLSTMDescriptor	alloc()
static MLCLSTMDescriptor	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
boolean	batchFirst() [@property] batchFirst
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()
static MLCLSTMDescriptor	descriptorWithInputSizeHiddenSizeLayerCount(long inputSize, long hiddenSize, long layerCount) Creates a LSTM descriptor with batchFirst = YES
static MLCLSTMDescriptor	descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalDropout(long inputSize, long hiddenSize, long layerCount, boolean usesBiases, boolean batchFirst, boolean isBidirectional, float dropout)
static MLCLSTMDescriptor	descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalReturnsSequencesDropout(long inputSize, long hiddenSize, long layerCount, boolean usesBiases, boolean batchFirst, boolean isBidirectional, boolean returnsSequences, float dropout)
static MLCLSTMDescriptor	descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalReturnsSequencesDropoutResultMode(long inputSize, long hiddenSize, long layerCount, boolean usesBiases, boolean batchFirst, boolean isBidirectional, boolean returnsSequences, float dropout, long resultMode) Creates a LSTM descriptor.
static MLCLSTMDescriptor	descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesIsBidirectionalDropout(long inputSize, long hiddenSize, long layerCount, boolean usesBiases, boolean isBidirectional, float dropout) Creates a LSTM descriptor descriptor with batchFirst = YES
float	dropout() [@property] dropout
static long	hash_static()
long	hiddenSize() [@property] hiddenSize
MLCLSTMDescriptor	init()
long	inputSize() [@property] inputSize
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)
boolean	isBidirectional() [@property] isBidirectional
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
long	layerCount() [@property] layerCount
static MLCLSTMDescriptor	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
long	resultMode() [@property] resultMode
boolean	returnsSequences() [@property] returnsSequences
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
boolean	usesBiases() [@property] usesBiases
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

MLCLSTMDescriptor

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

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MLCLSTMDescriptor alloc()

allocWithZone

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

automaticallyNotifiesObserversForKey

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

batchFirst

public boolean batchFirst()

[@property] batchFirst

LSTM only supports batchFirst=YES. This means the input and output will have shape [batch size, time steps, feature]. Default is YES.

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

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

descriptorWithInputSizeHiddenSizeLayerCount

public static MLCLSTMDescriptor descriptorWithInputSizeHiddenSizeLayerCount(long inputSize,
                                                                            long hiddenSize,
                                                                            long layerCount)

Creates a LSTM descriptor with batchFirst = YES

Parameters:

inputSize - The number of expected features in the input

hiddenSize - The number of features in the hidden state

layerCount - Number of recurrent layers

Returns:

A valid MLCLSTMDescriptor object or nil, if failure.

descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalDropout

public static MLCLSTMDescriptor descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalDropout(long inputSize,
                                                                                                                      long hiddenSize,
                                                                                                                      long layerCount,
                                                                                                                      boolean usesBiases,
                                                                                                                      boolean batchFirst,
                                                                                                                      boolean isBidirectional,
                                                                                                                      float dropout)

descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalReturnsSequencesDropout

public static MLCLSTMDescriptor descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalReturnsSequencesDropout(long inputSize,
                                                                                                                                      long hiddenSize,
                                                                                                                                      long layerCount,
                                                                                                                                      boolean usesBiases,
                                                                                                                                      boolean batchFirst,
                                                                                                                                      boolean isBidirectional,
                                                                                                                                      boolean returnsSequences,
                                                                                                                                      float dropout)

descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalReturnsSequencesDropoutResultMode

public static MLCLSTMDescriptor descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesBatchFirstIsBidirectionalReturnsSequencesDropoutResultMode(long inputSize,
                                                                                                                                                long hiddenSize,
                                                                                                                                                long layerCount,
                                                                                                                                                boolean usesBiases,
                                                                                                                                                boolean batchFirst,
                                                                                                                                                boolean isBidirectional,
                                                                                                                                                boolean returnsSequences,
                                                                                                                                                float dropout,
                                                                                                                                                long resultMode)

Creates a LSTM descriptor.

Parameters:

inputSize - The number of expected features in the input

hiddenSize - The number of features in the hidden state

layerCount - Number of recurrent layers

usesBiases - If NO, the layer does not use bias weights. Default: YES

batchFirst - LSTM only supports batchFirst=YES. This means the input and output will have shape [batch size, time steps, feature]. Default is YES.

isBidirectional - If YES, becomes a bi-directional LSTM. Default: NO

returnsSequences - if YES return output for all sequences else return output only for the last sequences. Default: YES

dropout - If non-zero, introduces a dropout layer on the outputs of each LSTM layer except the last layer with dropout probability equal to dropout.

resultMode - expected result tensors. MLCLSTMResultModeOutput returns output data. MLCLSTMResultModeOutputAndStates returns output data, last hidden state h_n, and last cell state c_n. Default: MLCLSTMResultModeOutput.

Returns:

A valid MLCLSTMDescriptor object or nil, if failure.

descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesIsBidirectionalDropout

public static MLCLSTMDescriptor descriptorWithInputSizeHiddenSizeLayerCountUsesBiasesIsBidirectionalDropout(long inputSize,
                                                                                                            long hiddenSize,
                                                                                                            long layerCount,
                                                                                                            boolean usesBiases,
                                                                                                            boolean isBidirectional,
                                                                                                            float dropout)

Creates a LSTM descriptor descriptor with batchFirst = YES

Parameters:

inputSize - The number of expected features in the input

hiddenSize - The number of features in the hidden state

layerCount - Number of recurrent layers

usesBiases - If NO, the layer does not use bias weights. Default: YES

isBidirectional - If YES, becomes a bi-directional LSTM. Default: NO

dropout - If non-zero, introduces a dropout layer on the outputs of each LSTM layer except the last layer with dropout probability equal to dropout.

Returns:

A valid MLCLSTMDescriptor object or nil, if failure.

dropout

public float dropout()

[@property] dropout

If non-zero, intrdouces a dropout layer on the outputs of each LSTM layer except the last layer, with dropout probablity equal to dropout. Default is 0.0.

hash_static

public static long hash_static()

hiddenSize

public long hiddenSize()

[@property] hiddenSize

The number of feature channels in the hidden state

init

public MLCLSTMDescriptor init()

Overrides:

init in class NSObject

inputSize

public long inputSize()

[@property] inputSize

The number of expected feature channels in the input

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)

isBidirectional

public boolean isBidirectional()

[@property] isBidirectional

If YES, becomes a bidirectional LSTM. Default is NO.

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

layerCount

public long layerCount()

[@property] layerCount

The number of recurrent layers. Default is 1.

new_objc

public static MLCLSTMDescriptor new_objc()

resolveClassMethod

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

resolveInstanceMethod

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

resultMode

public long resultMode()

[@property] resultMode

MLCLSTMResultModeOutput returns output data. MLCLSTMResultModeOutputAndStates returns output data, last hidden state h_n, and last cell state c_n. Default MLCLSTMResultModeOutput.

returnsSequences

public boolean returnsSequences()

[@property] returnsSequences

if YES return output for all sequences else return output only for the last sequences. Default: YES

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

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

usesBiases

public boolean usesBiases()

[@property] usesBiases

If NO, the layer does not use bias terms. Default is YES.

version_static

public static long version_static()