Package apple.metalperformanceshadersgraph

Class MPSGraphLSTMDescriptor

  • All Implemented Interfaces:
    NSCopying, NSObject
    public class MPSGraphLSTMDescriptor
extends MPSGraphObject
implements NSCopying
    This class defines parameters for a Long Short Term Memory (LSTM) operation. Use this descriptor with the following ``MPSGraph`` methods: - ``MPSGraph/LSTMWithSourceTensor:recurrentWeight:initState:initCell:descriptor:name:``, - ``MPSGraph/LSTMWithSourceTensor:recurrentWeight:inputWeight:bias:initState:initCell:descriptor:name:``, - ``MPSGraph/LSTMWithSourceTensor:recurrentWeight:inputWeight:bias:initState:initCell:mask:peephole:descriptor:name:``, - ``MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:descriptor:name:``, - ``MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:descriptor:name:``, - ``MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:inputWeight:bias:initState:initCell:mask:descriptor:name:`` and - ``MPSGraph/LSTMGradientsWithSourceTensor:recurrentWeight:sourceGradient:zState:cellOutputFwd:stateGradient:cellGradient:inputWeight:bias:initState:initCell:mask:peephole:descriptor:name:``. API-Since: 15.4

    • Constructor Detail

      • MPSGraphLSTMDescriptor

        protected MPSGraphLSTMDescriptor​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • activation

        public long activation()
        A parameter which defines the activation function used with the current cell value of the LSTM operation. Default value: `MPSGraphRNNActivationTanh`.

      • allocWithZone

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

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • bidirectional

        public boolean bidirectional()
        A parameter that defines a bidirectional LSTM layer. If set to `YES` then the input sequence is traversed in both directions and the two results are concatenated together on the channel-axis. Default value: `NO`.

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • cellGateActivation

        public long cellGateActivation()
        A parameter which defines the activation function used with the cell gate of the LSTM operation. Default value: `MPSGraphRNNActivationTanh`.

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • copyWithZone

        @NotNull
public @NotNull java.lang.Object copyWithZone​(@Nullable
                                              @Nullable 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()

      • descriptor

        public static MPSGraphLSTMDescriptor descriptor()
        Creates an LSTM descriptor with default values.

      • forgetGateActivation

        public long forgetGateActivation()
        A parameter which defines the activation function used with the forget gate of the LSTM operation. Default value: `MPSGraphRNNActivationSigmoid`.

      • forgetGateLast

        public boolean forgetGateLast()
        A parameter that controls the internal order of the LSTM gates. If set to `YES` then the layer will use the gate-ordering `[ i, z, f, o ]` instead of default `[ i, f, z, o ]`. Default value: `NO`

      • hash_static

        public static long hash_static()

      • inputGateActivation

        public long inputGateActivation()
        A parameter which defines the activation function used with the input gate of the LSTM operation. Default value: `MPSGraphRNNActivationSigmoid`.

      • 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

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

      • outputGateActivation

        public long outputGateActivation()
        A parameter which defines the activation function used with the output gate of the LSTM operation. Default value: `MPSGraphRNNActivationSigmoid`.

      • produceCell

        public boolean produceCell()
        A parameter that controls whether or not to return the output cell from the LSTM layer. If set to `YES` then this layer will produce the internal cell of the LSTM unit as secondary output. Default value: `NO`.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • reverse

        public boolean reverse()
        A parameter that defines time direction of the input sequence. If set to `YES` then the input sequence is passed in reverse time order to the layer. Note: Ignored when `bidirectional = YES`. Default value: `NO`.

      • setActivation

        public void setActivation​(long value)
        A parameter which defines the activation function used with the current cell value of the LSTM operation. Default value: `MPSGraphRNNActivationTanh`.

      • setBidirectional

        public void setBidirectional​(boolean value)
        A parameter that defines a bidirectional LSTM layer. If set to `YES` then the input sequence is traversed in both directions and the two results are concatenated together on the channel-axis. Default value: `NO`.

      • setCellGateActivation

        public void setCellGateActivation​(long value)
        A parameter which defines the activation function used with the cell gate of the LSTM operation. Default value: `MPSGraphRNNActivationTanh`.

      • setForgetGateActivation

        public void setForgetGateActivation​(long value)
        A parameter which defines the activation function used with the forget gate of the LSTM operation. Default value: `MPSGraphRNNActivationSigmoid`.

      • setForgetGateLast

        public void setForgetGateLast​(boolean value)
        A parameter that controls the internal order of the LSTM gates. If set to `YES` then the layer will use the gate-ordering `[ i, z, f, o ]` instead of default `[ i, f, z, o ]`. Default value: `NO`

      • setInputGateActivation

        public void setInputGateActivation​(long value)
        A parameter which defines the activation function used with the input gate of the LSTM operation. Default value: `MPSGraphRNNActivationSigmoid`.

      • setOutputGateActivation

        public void setOutputGateActivation​(long value)
        A parameter which defines the activation function used with the output gate of the LSTM operation. Default value: `MPSGraphRNNActivationSigmoid`.

      • setProduceCell

        public void setProduceCell​(boolean value)
        A parameter that controls whether or not to return the output cell from the LSTM layer. If set to `YES` then this layer will produce the internal cell of the LSTM unit as secondary output. Default value: `NO`.

      • setReverse

        public void setReverse​(boolean value)
        A parameter that defines time direction of the input sequence. If set to `YES` then the input sequence is passed in reverse time order to the layer. Note: Ignored when `bidirectional = YES`. Default value: `NO`.

      • setTraining

        public void setTraining​(boolean value)
        A parameter that makes the LSTM layer support training. If set to `YES` then the layer will produce training state tensor as a secondary output. Default value: `NO`.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

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

      • training

        public boolean training()
        A parameter that makes the LSTM layer support training. If set to `YES` then the layer will produce training state tensor as a secondary output. Default value: `NO`.

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.