MPSNNFilterNode(3) MetalPerformanceShaders.framework MPSNNFilterNode(3)
NAME
MPSNNFilterNode
SYNOPSIS
#import <MPSNNGraphNodes.h>
Inherits NSObject.
Inherited by MPSCNNBatchNormalizationNode, MPSCNNConvolutionNode, MPSCNNDilatedPoolingMaxNode, MPSCNNDropoutNode,
MPSCNNInstanceNormalizationNode, MPSCNNLogSoftMaxNode, MPSCNNLossNode, MPSCNNNeuronNode, MPSCNNNormalizationNode, MPSCNNPoolingNode,
MPSCNNSoftMaxNode, MPSCNNUpsamplingBilinearNode, MPSCNNUpsamplingNearestNode, MPSNNBinaryArithmeticNode, MPSNNConcatenationNode,
MPSNNGradientFilterNode, and MPSNNScaleNode.
Instance Methods
(nonnull instancetype) - init
(MPSNNGradientFilterNode *__nonnull) - gradientFilterWithSource:
(MPSNNGradientFilterNode *__nonnull) - gradientFilterWithSources:
(NSArray< MPSNNGradientFilterNode * > *__nonnull) - gradientFiltersWithSources:
(NSArray< MPSNNGradientFilterNode * > *__nonnull) - gradientFiltersWithSource:
Properties
MPSNNImageNode * resultImage
MPSNNStateNode * resultState
NSArray< MPSNNStateNode * > * resultStates
id< MPSNNPadding > paddingPolicy
NSString * label
Detailed Description
A placeholder node denoting a neural network filter stage There are as many MPSNNFilterNode subclasses as there are MPS neural network
filter objects. Make one of those. This class defines an polymorphic interface for them.
Method Documentation
- (NSArray <MPSNNGradientFilterNode*> * __nonnull) gradientFiltersWithSource: (MPSNNImageNode *__nonnull) gradientImage
Return multiple gradient versions of the filter MPSNNFilters that consume multiple inputs generally result in multiple conjugate filters
for the gradient computation at the end of training. For example, a single concatenation operation that concatenates multple images will
result in an array of slice operators that carve out subsections of the input gradient image.
Reimplemented in MPSNNGradientFilterNode.
- (NSArray <MPSNNGradientFilterNode*> * __nonnull) gradientFiltersWithSources: (NSArray< MPSNNImageNode * > *__nonnull) gradientImages
Return multiple gradient versions of the filter MPSNNFilters that consume multiple inputs generally result in multiple conjugate filters
for the gradient computation at the end of training. For example, a single concatenation operation that concatenates multple images will
result in an array of slice operators that carve out subsections of the input gradient image.
Reimplemented in MPSNNBinaryArithmeticNode, and MPSNNGradientFilterNode.
- (MPSNNGradientFilterNode*__nonnull) gradientFilterWithSource: (MPSNNImageNode *__nonnull) gradientImage
Return the gradient (backwards) version of this filter. The backwards training version of the filter will be returned. The non-gradient
image and state arguments for the filter are automatically obtained from the target.
Parameters:
gradientImage The gradient images corresponding with the resultImage of the target
Reimplemented in MPSNNGradientFilterNode.
- (MPSNNGradientFilterNode*__nonnull) gradientFilterWithSources: (NSArray< MPSNNImageNode * > *__nonnull) gradientImages
Return the gradient (backwards) version of this filter. The backwards training version of the filter will be returned. The non-gradient
image and state arguments for the filter are automatically obtained from the target.
Parameters:
gradientImages The gradient images corresponding with the resultImage of the target
Reimplemented in MPSCNNLossNode, MPSNNConcatenationNode, MPSNNBinaryArithmeticNode, and MPSNNGradientFilterNode.
- (nonnull instancetype) init
Reimplemented in MPSCNNNeuronGradientNode, and MPSCNNNeuronNode.
Property Documentation
- label [read], [write], [atomic], [copy]
A string to help identify this object.
- (id<MPSNNPadding>) paddingPolicy [read], [write], [nonatomic], [retain]
The padding method used for the filter node The default value varies per filter.
- (MPSNNImageNode*) resultImage [read], [nonatomic], [assign]
Get the node representing the image result of the filter Except where otherwise noted, the precision used for the result image (see format
property) is copied from the precision from the first input image node.
- (MPSNNStateNode*) resultState [read], [nonatomic], [assign]
convenience method for resultStates[0] If resultStates is nil, returns nil
- (NSArray<MPSNNStateNode*>*) resultStates [read], [nonatomic], [assign]
Get the node representing the state result of the filter If more than one, see description of subclass for ordering.
Author
Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.
Version MetalPerformanceShaders-100 Thu Feb 8 2018 MPSNNFilterNode(3)