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

.in +1c
.ti -1c
.RI "(nonnull instancetype) \- \fBinitWithDevice:\fP"
.br
.ti -1c
.RI "(nullable instancetype) \- \fBinitWithCoder:device:\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
This depends on Metal\&.framework  The softMax gradient filter calculates the gradient to be backpropagated\&. The softMax gradient just as the softMax filter, is applied across feature channels and at all spatial locations\&. It computes the gradient for a given output generated by the corresponding softMax (i\&.e\&. \fBMPSCNNSoftMax\fP) layer and the gradient computed by the previous layer in the back-propagation pass\&. For each feature channel in an image in a feature map, the softMax gradient filter computes the following: result gradient channel in pixel outputGradient(x,y,k) = softMax(x,y,k) * (inputGradient(x,y,k) - sum(inputGradient(x,y,0) * softMax(x,y,0) \&.\&.\&. inputGradient(x,y,N-1) * softMax(x,y,N-1))) where N is the number of feature channels
.PP
The incoming gradient is the primary source\&. The original output of corresponding softMax is the secondary source\&. 
.SH "Method Documentation"
.PP 
.SS "\- (nullable instancetype) \fBinitWithCoder:\fP (NSCoder *__nonnull) aDecoder(nonnull id< MTLDevice >) device"
\fBNSSecureCoding\fP 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\&. 
.PP
\fBParameters:\fP
.RS 4
\fIaDecoder\fP The NSCoder subclass with your serialized \fBMPSKernel\fP 
.br
\fIdevice\fP The MTLDevice on which to make the \fBMPSKernel\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
\fBA\fP new \fBMPSKernel\fP object, or nil if failure\&. 
.RE
.PP

.PP
Reimplemented from \fBMPSCNNGradientKernel\fP\&.
.SS "\- (nonnull instancetype) initWithDevice: (nonnull id< MTLDevice >) device"
Initializes a \fBMPSCNNSoftMaxGradient\fP function 
.PP
\fBParameters:\fP
.RS 4
\fIdevice\fP The MTLDevice on which this \fBMPSCNNSoftMaxGradient\fP filter will be used
.RE
.PP
\fBReturns:\fP
.RS 4
\fBA\fP valid \fBMPSCNNSoftMaxGradient\fP object or nil, if failure\&. 
.RE
.PP

.PP
Reimplemented from \fBMPSCNNGradientKernel\fP\&.

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