mojave man page for mpscnnbatchnormalizationstate

MPSCNNBatchNormalizationState(3)			 MetalPerformanceShaders.framework			  MPSCNNBatchNormalizationState(3)

NAME
       MPSCNNBatchNormalizationState

SYNOPSIS
       #import <MPSCNNBatchNormalization.h>

       Inherits MPSState.

   Instance Methods
       (nonnull instancetype) - initWithResource:
       (void) - reset
       (nullable id< MTLBuffer >) - mean
       (nullable id< MTLBuffer >) - variance
       (nullable id< MTLBuffer >) - gradientForGamma
       (nullable id< MTLBuffer >) - gradientForBeta

   Class Methods
       (nonnull instancetype) + temporaryStateWithCommandBuffer:bufferSize:
       (__nonnull instancetype) + temporaryStateWithCommandBuffer:textureDescriptor:

   Properties
       MPSCNNBatchNormalization * batchNormalization
       MPSCNNNormalizationGammaAndBetaState * gammaAndBetaState

Detailed Description
       MPSCNNBatchNormalizationState encapsulates the data necessary to execute batch normalization.

       MPSCNNBatchNormalizationState cannot initialize the size of its own underlying resources. Use [MPSCNNBatchNormalizationStatistics
       resultStateForSourceImages:] or [MPSCNNBatchNormalizationStatistics temporaryResultStateForCommandBuffer:sourceImages:].

Method Documentation
   - (nullable id<MTLBuffer>) gradientForBeta
       Return an MTLBuffer object containing the values of the gradient of the loss function with respect to the bias terms. If a
       MPSCNNBatchNormalizationGradient kernel has not successfully generated these values nil will be returned.

   - (nullable id<MTLBuffer>) gradientForGamma
       Return an MTLBuffer object containing the values of the gradient of the loss function with respect to the scale factors. If a
       MPSCNNBatchNormalizationGradient kernel has not successfully generated these values nil will be returned.

   - (nonnull instancetype) initWithResource: (__nullable id< MTLResource >) resource
       Unavailable. Use MPSCNNBatchNormalizationStatistics methods to initialize the state object.

       Reimplemented from MPSState.

   - (nullable id<MTLBuffer>) mean
       Return an MTLBuffer object with the most recently computed batch mean values.

   - (void) reset
       Reset any accumulated state data to its initial values.

   + (nonnull instancetype) temporaryStateWithCommandBuffer: (__nonnull id< MTLCommandBuffer >) cmdBuf(size_t) bufferSize
       Unavailable. Use MPSCNNBatchNormalizationStatistics methods to create the temporary state object.

       Reimplemented from MPSState.

   + (__nonnull instancetype) temporaryStateWithCommandBuffer: (__nonnull id< MTLCommandBuffer >) cmdBuf(MTLTextureDescriptor *__nonnull)
       descriptor
       Create a MPSState holding a temporary MTLTexture

       Parameters:
	   cmdBuf The command buffer against which the temporary resource is allocated
	   descriptor A descriptor for the new temporary texture

       Reimplemented from MPSState.

   - (nullable id<MTLBuffer>) variance
       Return an MTLBuffer object with the most recently computed batch variance values.

Property Documentation
   - (MPSCNNBatchNormalization*) batchNormalization [read],  [nonatomic],  [retain]
   - (MPSCNNNormalizationGammaAndBetaState*) gammaAndBetaState [read],	[nonatomic],  [retain]
Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

Version MetalPerformanceShaders-100				  Thu Feb 8 2018				  MPSCNNBatchNormalizationState(3)