mpscnnconvolutionweightsandbiasesstate(3) [mojave man page]

MPSCNNConvolutionWeightsAndBiasesState(3)		 MetalPerformanceShaders.framework		 MPSCNNConvolutionWeightsAndBiasesState(3)

NAME

       MPSCNNConvolutionWeightsAndBiasesState

SYNOPSIS

       #import <MPSCNNConvolution.h>

       Inherits MPSState.

   Instance Methods
       (nonnull instancetype) - initWithWeights:biases:
       (nonnull instancetype) - initWithDevice:cnnConvolutionDescriptor:

   Class Methods
       (nonnull instancetype) + temporaryCNNConvolutionWeightsAndBiasesStateWithCommandBuffer:cnnConvolutionDescriptor:

   Properties
       __nonnull id< MTLBuffer > weights
       __nullable id< MTLBuffer > biases

Detailed Description
       The MPSCNNConvolutionWeightsAndBiasesState is returned by exportWeightsAndBiasesWithCommandBuffer: method on MPSCNNConvolution object. This
       is mainly used for GPU side weights/biases update process. During training, application can keep a copy of weights, velocity, momentum
       MTLBuffers in its data source, update the weights (in-place or out of place) with gradients obtained from MPSCNNConvolutionGradientState
       and call [MPSCNNConvolution reloadWeightsAndBiasesWithCommandBuffer] with resulting updated MTLBuffer. If application does not want to keep
       a copy of weights/biases, it can call [MPSCNNConvolution exportWeightsAndBiasesWithCommandBuffer:] to get the current weights from
       convolution itself, do the updated and call reloadWithCommandBuffer.

Method Documentation
   - (nonnull instancetype) initWithDevice: (__nonnull id< MTLDevice >) device(MPSCNNConvolutionDescriptor *__nonnull) descriptor
   - (nonnull instancetype) initWithWeights: (__nonnull id< MTLBuffer >) weights(__nullable id< MTLBuffer >) biases
   + (nonnull instancetype) temporaryCNNConvolutionWeightsAndBiasesStateWithCommandBuffer: (__nonnull id< MTLCommandBuffer >)
       commandBuffer(MPSCNNConvolutionDescriptor *__nonnull) descriptor
Property Documentation
   - biases [read],  [nonatomic],  [assign]
       A buffer that contains the biases. Each value is float and there are ouputFeatureChannels values.

   - weights [read],  [nonatomic],  [assign]
       A buffer that contains the weights. Each value in the buffer is a float. The layout of the weights with respect to the weights is the same
       as the weights layout provided by data source i.e. it can be interpreted as 4D array

	weights[outputFeatureChannels][kernelHeight][kernelWidth][inputFeatureChannels/groups]

Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

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

Check Out this Related Man Page

MPSCNNConvolutionGradientNode(3)			 MetalPerformanceShaders.framework			  MPSCNNConvolutionGradientNode(3)

NAME

       MPSCNNConvolutionGradientNode

SYNOPSIS

       #import <MPSNNGraphNodes.h>

       Inherits MPSNNGradientFilterNode, and <MPSNNTrainableNode>.

   Instance Methods
       (nonnull instancetype) - initWithSourceGradient:sourceImage:convolutionGradientState:weights:

   Class Methods
       (nonnull instancetype) + nodeWithSourceGradient:sourceImage:convolutionGradientState:weights:

   Additional Inherited Members
Method Documentation
   - (nonnull instancetype) initWithSourceGradient: (MPSNNImageNode *__nonnull) sourceGradient(MPSNNImageNode *__nonnull)
       sourceImage(MPSCNNConvolutionGradientStateNode *__nonnull) gradientState(nullable id< MPSCNNConvolutionDataSource >) weights
       A node to represent the gradient calculation for convolution training.

       Parameters:
	   sourceGradient The input gradient from the 'downstream' gradient filter. Often that is a neuron gradient filter node.
	   sourceImage The input image from the forward convolution node
	   gradientState The gradient state from the forward convolution
	   weights The data source from the forward convolution. It may not contain an integrated neuron. Similary, any normalization should be
	   broken out into a separate node. Pass nil to use the weights from the forward convolution pass.

       Returns:
	   A MPSCNNConvolutionGradientNode

   + (nonnull instancetype) nodeWithSourceGradient: (MPSNNImageNode *__nonnull) sourceGradient(MPSNNImageNode *__nonnull)
       sourceImage(MPSCNNConvolutionGradientStateNode *__nonnull) gradientState(nullable id< MPSCNNConvolutionDataSource >) weights
       A node to represent the gradient calculation for convolution training.

       Parameters:
	   sourceGradient The input gradient from the 'downstream' gradient filter. Often that is a neuron gradient filter node.
	   sourceImage The input image from the forward convolution node
	   gradientState The gradient state from the forward convolution
	   weights The data source from the forward convolution. It may not contain an integrated neuron. Similary, any normalization should be
	   broken out into a separate node. Pass nil to use the weights from the forward convolution pass.

       Returns:
	   A MPSCNNConvolutionGradientNode

Author
       Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.

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

Linux and UNIX Man Pages

mpscnnconvolutionweightsandbiasesstate(3) [mojave man page]

Check Out this Related Man Page