Package apple.metalperformanceshaders

Class MPSCNNGroupNormalization

  • All Implemented Interfaces:
    NSCoding, NSCopying, NSSecureCoding, NSObject
    public class MPSCNNGroupNormalization
extends MPSCNNKernel
    MPSCNNGroupNormalization [@dependency] This depends on Metal.framework This kernel normalizes each image, on a per-group basis, to have zero mean and unit variance: for each image: for each channel: y = (x - mean) * gamma / sqrt(variance + epsilon) + beta; The mean and variance are computed per group of channels, as given by the dataSource. API-Since: 13.0

    • Constructor Detail

      • MPSCNNGroupNormalization

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • automaticallyNotifiesObserversForKey

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

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

      • classFallbacksForKeyedArchiver

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

      • classForKeyedUnarchiver

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

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • epsilon

        public float epsilon()
        [@property] epsilon The epsilon value used to bias the variance when normalizing.

      • hash_static

        public static long hash_static()

      • initWithCoderDevice

        public MPSCNNGroupNormalization initWithCoderDevice​(@NotNull
                                                    @NotNull NSCoder aDecoder,
                                                    @NotNull
                                                    @NotNull java.lang.Object device)
        NSSecureCoding compatability While the standard NSSecureCoding/NSCoding method -initWithCoder: should work, since the file can't know which device your data is allocated on, we have to guess and may guess incorrectly. To avoid that problem, use initWithCoder:device instead.
        Overrides:
        initWithCoderDevice in class MPSCNNKernel
        Parameters:
        aDecoder - The NSCoder subclass with your serialized MPSKernel
        device - The MTLDevice on which to make the MPSKernel
        Returns:
        A new MPSCNNGroupNormalization object, or nil if failure.

      • initWithDevice

        public MPSCNNGroupNormalization initWithDevice​(@NotNull
                                               @NotNull java.lang.Object device)
        Description copied from class: MPSCNNKernel
        Standard init with default properties per filter type
        Overrides:
        initWithDevice in class MPSCNNKernel
        Parameters:
        device - The device that the filter will be used on. May not be NULL.
        Returns:
        A pointer to the newly initialized object. This will fail, returning nil if the device is not supported. Devices must be MTLFeatureSet_iOS_GPUFamily2_v1 or later.

      • initWithDeviceDataSource

        public MPSCNNGroupNormalization initWithDeviceDataSource​(@NotNull
                                                         @NotNull MTLDevice device,
                                                         @NotNull
                                                         @NotNull MPSCNNGroupNormalizationDataSource dataSource)
        Initialize a MPSCNNGroupNormalization kernel on a device.
        Parameters:
        dataSource - An object conforming to the MPSCNNGroupNormalizationDataSource protocol which

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

      • reloadGammaAndBetaFromDataSource

        public void reloadGammaAndBetaFromDataSource()
        Reinitialize the filter using the data source provided at kernel initialization.

      • reloadGammaAndBetaWithCommandBufferGammaAndBetaState

        public void reloadGammaAndBetaWithCommandBufferGammaAndBetaState​(@NotNull
                                                                 @NotNull MTLCommandBuffer commandBuffer,
                                                                 @NotNull
                                                                 @NotNull MPSCNNNormalizationGammaAndBetaState gammaAndBetaState)
        Reload data using new gamma and beta terms contained within an MPSCNNGroupNormalizationGradientState object.
        Parameters:
        commandBuffer - The command buffer on which to encode the reload.
        gammaAndBetaState - The state containing the updated weights which are to be reloaded.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • resultStateForSourceImageSourceStatesDestinationImage

        @Nullable
public @Nullable MPSCNNGroupNormalizationGradientState resultStateForSourceImageSourceStatesDestinationImage​(@NotNull
                                                                                                             @NotNull MPSImage sourceImage,
                                                                                                             @Nullable
                                                                                                             @Nullable NSArray<? extends MPSState> sourceStates,
                                                                                                             @NotNull
                                                                                                             @NotNull MPSImage destinationImage)
        Return a MPSCNNGroupNormalizationGradientState object for the provided source image, source states, and destination image.
        Overrides:
        resultStateForSourceImageSourceStatesDestinationImage in class MPSCNNKernel
        Parameters:
        sourceImage - The MPSImage consumed by the associated -encode call.
        sourceStates - The list of MPSStates consumed by the associated -encode call, for a batch size of 1.
        destinationImage - The destination image for the encode call
        Returns:
        The list of states produced by the -encode call for batch size of 1. When the batch size is not 1, this function will be called repeatedly unless -isResultStateReusedAcrossBatch returns YES. If -isResultStateReusedAcrossBatch returns YES, then it will be called once per batch and the MPSStateBatch array will contain MPSStateBatch.length references to the same object. API-Since: 11.3

      • setEpsilon

        public void setEpsilon​(float value)
        [@property] epsilon The epsilon value used to bias the variance when normalizing.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

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

      • temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage

        @Nullable
public @Nullable MPSCNNGroupNormalizationGradientState temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage​(@NotNull
                                                                                                                                   @NotNull MTLCommandBuffer commandBuffer,
                                                                                                                                   @NotNull
                                                                                                                                   @NotNull MPSImage sourceImage,
                                                                                                                                   @Nullable
                                                                                                                                   @Nullable NSArray<? extends MPSState> sourceStates,
                                                                                                                                   @NotNull
                                                                                                                                   @NotNull MPSImage destinationImage)
        Return a temporary MPSCNNGroupNormalizationGradientState object which may be used with a MPSCNNGroupNormalization filter.
        Overrides:
        temporaryResultStateForCommandBufferSourceImageSourceStatesDestinationImage in class MPSCNNKernel
        Parameters:
        commandBuffer - The command buffer to allocate the temporary storage against The state will only be valid on this command buffer.
        sourceImage - The MPSImage consumed by the associated -encode call.
        sourceStates - The list of MPSStates consumed by the associated -encode call, for a batch size of 1.
        destinationImage - The destination image for the encode call
        Returns:
        The list of states produced by the -encode call for batch size of 1. When the batch size is not 1, this function will be called repeatedly unless -isResultStateReusedAcrossBatch returns YES. If -isResultStateReusedAcrossBatch returns YES, then it will be called once per batch and the MPSStateBatch array will contain MPSStateBatch.length references to the same object. API-Since: 11.3

      • version_static

        public static long version_static()

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.