Package apple.metalperformanceshaders

Class MPSMatrixSoftMaxGradient

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    Direct Known Subclasses:
    MPSMatrixLogSoftMaxGradient
    public class MPSMatrixSoftMaxGradient
extends MPSMatrixBinaryKernel
    MPSMatrixSoftMaxGradient [@dependency] This depends on Metal.framework. Computes the gradient corresponding to a forward MPSMatrixSoftMax object. A MPSMatrixSoftMaxGradient object computes: dL_dX_ij = Y_ij * (dL_dY_ij - sum_k(dL_dY_ik * Y_ik) Where dL_dX is the resulting gradient of the loss function with respect to the original input to the forward MPSMatrixSoftMax operation, Y is the output of the forward MPSMatrixSoftMax operation, and dL_dY is the gradient of the loss function with respect to Y.

    • Constructor Detail

      • MPSMatrixSoftMaxGradient

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • 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 java.lang.Object 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()

      • encodeToCommandBufferGradientMatrixForwardOutputMatrixResultMatrix

        public void encodeToCommandBufferGradientMatrixForwardOutputMatrixResultMatrix​(MTLCommandBuffer commandBuffer,
                                                                               MPSMatrix gradientMatrix,
                                                                               MPSMatrix forwardOutputMatrix,
                                                                               MPSMatrix resultMatrix)
        Encode a MPSMatrixSoftMaxGradient object to a command buffer.
        Parameters:
        commandBuffer - A valid MTLCommandBuffer to receive the encoded kernel.
        gradientMatrix - A MPSMatrix object containing gradient values with respect to the forward operation's output. dL_dY in the class description.
        forwardOutputMatrix - A MPSMatrix object containing the output values from the forward operation. Y in the class description.
        resultMatrix - The MPSMatrix object to hold the resulting gradient values with respect to the forward operation's input. dL_dX in the class description.

      • hash_static

        public static long hash_static()

      • initWithCoderDevice

        public MPSMatrixSoftMaxGradient initWithCoderDevice​(NSCoder aDecoder,
                                                    java.lang.Object device)
        NSSecureCoding compatability See @ref MPSKernel#initWithCoder.
        Overrides:
        initWithCoderDevice in class MPSMatrixBinaryKernel
        Parameters:
        aDecoder - The NSCoder subclass with your serialized MPSMatrixSoftMaxGradient
        device - The MTLDevice on which to make the MPSMatrixSoftMaxGradient
        Returns:
        A new MPSMatrixSoftMaxGradient object, or nil if failure.

      • initWithDevice

        public MPSMatrixSoftMaxGradient initWithDevice​(java.lang.Object device)
        Initialize an MPSMatrixSoftMaxGradient object on a device.
        Overrides:
        initWithDevice in class MPSMatrixBinaryKernel
        Parameters:
        device - The device on which the kernel will execute.
        Returns:
        A valid MPSMatrixSoftMaxGradient object or nil, if failure.

      • 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 java.lang.Object new_objc()

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setSourceColumns

        public void setSourceColumns​(long value)
        [@property] sourceColumns The number of columns to consider from the sources in the operation. This property is modifiable and defaults to NSUIntegerMax and the number is adjusted dynamically at kernel encode time (see encodeToCommandBuffer) to fit into the source matrices available starting from [primary/secondary]SourceMatrixOrigin.y, indicating that by default the whole source matrix is used. If a different size is desired then this should be modified prior to encoding the kernel. It is the user's responsibility to ensure that the resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: primarySourceMatrixOrigin, secondarySourceMatrixOrigin and resultMatrixOrigin from MPSMatrixBinaryKernel can be used to control the starting points in the primary source, secondary source, and result matrices respectively.

      • setSourceRows

        public void setSourceRows​(long value)
        [@property] sourceRows The number of rows to consider from the sources in the operation. This property is modifiable and defaults to NSUIntegerMax and the number is adjusted dynamically at kernel encode time (see encodeToCommandBuffer) to fit into the source matrices available starting from [primary/secondary]SourceMatrixOrigin.x, indicating that by default the whole source matrix is used. If a different size is desired then this should be modified prior to encoding the kernel. It is the user's responsibility to ensure that the resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: primarySourceMatrixOrigin, secondarySourceMatrixOrigin and resultMatrixOrigin from MPSMatrixBinaryKernel can be used to control the starting points in the primary source, secondary source, and result matrices respectively.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • sourceColumns

        public long sourceColumns()
        [@property] sourceColumns The number of columns to consider from the sources in the operation. This property is modifiable and defaults to NSUIntegerMax and the number is adjusted dynamically at kernel encode time (see encodeToCommandBuffer) to fit into the source matrices available starting from [primary/secondary]SourceMatrixOrigin.y, indicating that by default the whole source matrix is used. If a different size is desired then this should be modified prior to encoding the kernel. It is the user's responsibility to ensure that the resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: primarySourceMatrixOrigin, secondarySourceMatrixOrigin and resultMatrixOrigin from MPSMatrixBinaryKernel can be used to control the starting points in the primary source, secondary source, and result matrices respectively.

      • sourceRows

        public long sourceRows()
        [@property] sourceRows The number of rows to consider from the sources in the operation. This property is modifiable and defaults to NSUIntegerMax and the number is adjusted dynamically at kernel encode time (see encodeToCommandBuffer) to fit into the source matrices available starting from [primary/secondary]SourceMatrixOrigin.x, indicating that by default the whole source matrix is used. If a different size is desired then this should be modified prior to encoding the kernel. It is the user's responsibility to ensure that the resultMatrix parameter in encodeToCommandBuffer is large enough to accommodate the results of this operation, otherwise the results of the encode call are undefined. NOTE: primarySourceMatrixOrigin, secondarySourceMatrixOrigin and resultMatrixOrigin from MPSMatrixBinaryKernel can be used to control the starting points in the primary source, secondary source, and result matrices respectively.

      • 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 MPSMatrixBinaryKernel

      • version_static

        public static long version_static()