.TH "MPSCNNBatchNormalizationState" 3 "Mon Jul 9 2018" "Version MetalPerformanceShaders-119.3" "MetalPerformanceShaders.framework" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MPSCNNBatchNormalizationState
.SH SYNOPSIS
.br
.PP
.PP
\fC#import <MPSCNNBatchNormalization\&.h>\fP
.PP
Inherits \fBMPSNNGradientState\fP\&.
.SS "Instance Methods"

.in +1c
.ti -1c
.RI "(nonnull instancetype) \- \fBinitWithResource:\fP"
.br
.ti -1c
.RI "(void) \- \fBreset\fP"
.br
.ti -1c
.RI "(nullable id< MTLBuffer >) \- \fBgamma\fP"
.br
.ti -1c
.RI "(nullable id< MTLBuffer >) \- \fBbeta\fP"
.br
.ti -1c
.RI "(nullable id< MTLBuffer >) \- \fBmean\fP"
.br
.ti -1c
.RI "(nullable id< MTLBuffer >) \- \fBvariance\fP"
.br
.ti -1c
.RI "(nullable id< MTLBuffer >) \- \fBgradientForGamma\fP"
.br
.ti -1c
.RI "(nullable id< MTLBuffer >) \- \fBgradientForBeta\fP"
.br
.in -1c
.SS "Class Methods"

.in +1c
.ti -1c
.RI "(nonnull instancetype) + \fBtemporaryStateWithCommandBuffer:bufferSize:\fP"
.br
.ti -1c
.RI "(__nonnull instancetype) + \fBtemporaryStateWithCommandBuffer:textureDescriptor:\fP"
.br
.in -1c
.SS "Properties"

.in +1c
.ti -1c
.RI "\fBMPSCNNBatchNormalization\fP * \fBbatchNormalization\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBMPSCNNBatchNormalizationState\fP encapsulates the data necessary to execute batch normalization\&.
.PP
\fBMPSCNNBatchNormalizationState\fP cannot initialize the size of its own underlying resources\&. Use [\fBMPSCNNBatchNormalizationStatistics\fP resultStateForSourceImages:] or [\fBMPSCNNBatchNormalizationStatistics\fP temporaryResultStateForCommandBuffer:sourceImages:]\&. 
.SH "Method Documentation"
.PP 
.SS "\- (nullable id<MTLBuffer>) beta "
Return an MTLBuffer object with the state's current beta values\&.\&. 
.SS "\- (nullable id<MTLBuffer>) gamma "
Return an MTLBuffer object with the state's current gamma values\&. 
.SS "\- (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 \fBMPSCNNBatchNormalizationGradient\fP kernel has not successfully generated these values nil will be returned\&. 
.SS "\- (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 \fBMPSCNNBatchNormalizationGradient\fP kernel has not successfully generated these values nil will be returned\&. 
.SS "\- (nonnull instancetype) initWithResource: (__nullable id< MTLResource >) resource"
Unavailable\&. Use \fBMPSCNNBatchNormalizationStatistics\fP methods to initialize the state object\&. 
.PP
Reimplemented from \fBMPSState\fP\&.
.SS "\- (nullable id<MTLBuffer>) mean "
Return an MTLBuffer object with the most recently computed batch mean values\&. 
.SS "\- (void) reset "
Reset any accumulated state data to its initial values\&. 
.SS "+ (nonnull instancetype) \fBtemporaryStateWithCommandBuffer:\fP (__nonnull id< MTLCommandBuffer >) cmdBuf(size_t) bufferSize"
Unavailable\&. Use \fBMPSCNNBatchNormalizationStatistics\fP methods to create the temporary state object\&. 
.PP
Reimplemented from \fBMPSState\fP\&.
.SS "+ (__nonnull instancetype) \fBtemporaryStateWithCommandBuffer:\fP (__nonnull id< MTLCommandBuffer >) cmdBuf(MTLTextureDescriptor *__nonnull) descriptor"
Create a \fBMPSState\fP holding a temporary MTLTexture 
.PP
\fBParameters:\fP
.RS 4
\fIcmdBuf\fP The command buffer against which the temporary resource is allocated 
.br
\fIdescriptor\fP \fBA\fP descriptor for the new temporary texture 
.RE
.PP

.PP
Reimplemented from \fBMPSState\fP\&.
.SS "\- (nullable id<MTLBuffer>) variance "
Return an MTLBuffer object with the most recently computed batch variance values\&. 
.SH "Property Documentation"
.PP 
.SS "\- (\fBMPSCNNBatchNormalization\fP*) batchNormalization\fC [read]\fP, \fC [nonatomic]\fP, \fC [retain]\fP"


.SH "Author"
.PP 
Generated automatically by Doxygen for MetalPerformanceShaders\&.framework from the source code\&.