MPSCNNConvolutionDescriptor(3)

NAME
MPSCNNConvolutionDescriptor -

SYNOPSIS

#import <MPSCNN.h>

Inherits NSObject, and <NSCopying>.

  Class Methods
(nonnull instancetype) + cnnConvolutionDescriptorWithKernelWidth:kernelHeight:inputFeatureChannels:outputFeatureChannels:neuronFilter:

  Properties
NSUInteger kernelWidth
NSUInteger kernelHeight
NSUInteger inputFeatureChannels
NSUInteger outputFeatureChannels
NSUInteger strideInPixelsX
NSUInteger strideInPixelsY
NSUInteger groups
const MPSCNNNeuron *__nullable neuron

Detailed Description

This depends on Metal.framework The MPSCNNConvolutionDescriptor specifies a convolution descriptor

Method Documentation

  + (nonnull instancetype) cnnConvolutionDescriptorWithKernelWidth: (NSUInteger) kernelWidth(NSUInteger) kernelHeight(NSUInteger) inputFeatureChannels(NSUInteger) outputFeatureChannels(const MPSCNNNeuron *__nullable) neuronFilter
Creates a convolution descriptor with a neuron filter

Parameters:
    kernelWidth The width of the filter window. Must be > 0. Large values will take a long time.
    kernelHeight The height of the filter window. Must be > 0. Large values will take a long time.
    inputFeatureChannels The number of feature channels in the input image. Must be >= 1.
    outputFeatureChannels The number of feature channels in the output image. Must be >= 1.
    neuronFilter An optional neuron filter that can be applied to the output of convolution.

Returns:
    A valid MPSCNNConvolutionDescriptor object or nil, if failure.

Property Documentation

  - groups [read], [write], [nonatomic], [assign]
Number of groups input and output channels are divided into. The default value is 1. Groups lets you reduce the parametrization. If groups is set to n, input is divided into n groups with inputFeatureChannels/n channels in each group. Similarly output is divided into n groups with outputFeatureChannels/n channels in each group. ith group in input is only connected to ith group in output so number of weights (parameters) needed is reduced by factor of n. Both inputFeatureChannels and outputFeatureChannels must be divisible by n and number of channels in each group must be multiple of 4.

  - inputFeatureChannels [read], [write], [nonatomic], [assign]
The number of feature channels per pixel in the input image.

  - kernelHeight [read], [write], [nonatomic], [assign]
The height of the filter window. The default value is 3. Any positive non-zero value is valid, including even values. The position of the top edge of the filter window is given by offset.y - (kernelHeight>>1)

  - kernelWidth [read], [write], [nonatomic], [assign]
The width of the filter window. The default value is 3. Any positive non-zero value is valid, including even values. The position of the left edge of the filter window is given by offset.x - (kernelWidth>>1)

  - neuron [read], [write], [nonatomic], [retain]
MPSCNNNeuron filter to be applied as part of convolution. Default is nil.

  - outputFeatureChannels [read], [write], [nonatomic], [assign]
The number of feature channels per pixel in the output image.

  - strideInPixelsX [read], [write], [nonatomic], [assign]
The output stride (downsampling factor) in the x dimension. The default value is 1.

  - strideInPixelsY [read], [write], [nonatomic], [assign]
The output stride (downsampling factor) in the y dimension. The default value is 1.

Author

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