Pooling2DOperator

public class Pooling2DOperator: ComputableOperator

This class is an abstract class for 2D pooling operators.

Attributes

operatorLabel
Operator label. Conforms to ComputableOperator
Declaration
Swift

public var operatorLabel: String
Show on GitHub
metalKernelFuncLabel
This operator does not operator on GPU. Conforms to ComputableOperator
Declaration
Swift

public var metalKernelFuncLabel:String = "" // need override by child class
Show on GitHub
computationDelegate
Conforms to ComputableOperator
Declaration
Swift

public var computationDelegate: OperatorCalculationDelegate?
Show on GitHub
inputTensors
Conforms to ComputableOperator
Declaration
Swift

public var inputTensors: [Tensor]?
Show on GitHub
outputTensors
Conforms to ComputableOperator
Declaration
Swift

public var outputTensors: [Tensor]?
Show on GitHub
paddingMode
Pad mode, default is PaddingMode.Valid.
Declaration
Swift

public var paddingMode: PaddingMode = PaddingMode.Valid
Show on GitHub
kernelSize
Kernel size array which contains the kernel size in each dimension.
Declaration
Swift

public var kernelSize: [Int]
Show on GitHub
stride
Stride array which contains the stride in each dimension.
Declaration
Swift

public var stride: [Int]
Show on GitHub
cpuComputeBlock
CPU computation block. Two tensors are input and output tensors.
Declaration
Swift

public lazy var cpuComputeBlock: ((Tensor, Tensor) -> Void)? = nil
Show on GitHub
channelPosition
Channel position. Default is ImageChannelOrder.First
Declaration
Swift

public var channelPosition: TensorChannelOrder = .First
Show on GitHub
disableInputOutputCheck
If true, operator will not call inputOutputTensorsCheck() before doing calculation. This is used inside framework to speed up in situation we know it will not be wrong.
Declaration
Swift

public var disableInputOutputCheck: Bool = false
Show on GitHub
trainable
Indicate if this operator would do paramter update.
Declaration
Swift

public var trainable: Bool = false
Show on GitHub
mapType
The mapping type of this operator. OneToOne for this operator.
Declaration
Swift

public var mapType: OperatorMappingType
Show on GitHub
inPlaceble
Pool operator cannot do in-place calculation
Declaration
Swift

public var inPlaceble: Bool = false
Show on GitHub
disabledMPS
if disable MPS kernel
Declaration
Swift

public var disabledMPS: Bool = false
Show on GitHub

Initializers


                    
                    
                    init(kernelSize:stride:channelPosition:paddingMode:inputTensors:outputTensors:computationDelegate:operatorLabel:)

Initializer.

Declaration

Swift

required public init(kernelSize: [Int],
            stride: [Int]? = nil,
            channelPosition: TensorChannelOrder = TensorChannelOrder.First,
            paddingMode: PaddingMode = PaddingMode.Valid,
            inputTensors: [Tensor]? = nil,
            outputTensors: [Tensor]? = nil,
            computationDelegate: OperatorCalculationDelegate? = nil,
            operatorLabel: String = "Pooling")

Parameters

`kernelSize`	Array of int values. Should has 2 elemetns for height and width dimesnsions.
`stride`	Array of int values. If `stride` is `nil`, it will be assigned as same value as `kernelSize`
`channelPosition`	channel position in input data
`paddingMode`	paddingMode
`inputTensors`	inputTensors
`outputTensors`	outputTensors
`computationDelegate`	computationDelegate
`operatorLabel`	operatorLabel

Show on GitHub

Methods


                    
                    
                    outputShape(shapeArray:)

Compute output shape according to kernelSize, stride and paddingMode

Declaration

Swift

public func outputShape(shapeArray shapes: [TensorShape]) -> [TensorShape]?

Parameters


                                shapes

shapes description

Return Value

return value description

Show on GitHub

inputOutputTensorsCheck()
Check validation between inputTensors/outputTensors and stride, kernelSize.
Declaration
Swift

public func inputOutputTensorsCheck() -> (check: Bool, msg: String)
Return Value

check indicating if pass checking, msg for error message.

Show on GitHub


                    
                    
                    compute(_:)

Compute sync

Declaration

Swift

public func compute(_ computationMode: OperatorComputationMode)

Parameters


                                computationMode

computationMode

Show on GitHub


                    
                    
                    computeAsync(_:)

Compute async

Declaration

Swift

public func computeAsync(_ computationMode: OperatorComputationMode)

Parameters


                                computationMode

computationMode

Show on GitHub


                    
                    
                    gradCompute(_:)

Calulate grads sync. All unary operator return grads tensor with same number and shape as attribute inputTensors.

Declaration

Swift

public func gradCompute(_ computationMode: OperatorComputationMode) -> [String: DataSymbolSupportedDataType]

Parameters


                                computationMode

computationMode

Return Value

return grads tensor

Show on GitHub


                    
                    
                    gradComputAsync(_:)

Cal grads async

Declaration

Swift

public func gradComputAsync(_ computationMode: OperatorComputationMode)

Parameters


                                computationMode

computationMode

Show on GitHub

bindParamSymbols(_:)
This operator has no parameters. Do nothing
Declaration
Swift

public func bindParamSymbols(_ symbols: [GraphSymbol])
Show on GitHub
paramSymbols()
This operator has no parameters.
Declaration
Swift

public func paramSymbols() -> [GraphSymbol]
Return Value

An empty array

Show on GitHub
cpu()
CPU calcualtion. Call cpuComputeBlock which is defined in subclass
Declaration
Swift

internal func cpu()
Show on GitHub
gpu()
GPU calculation
Declaration
Swift

internal func gpu()
Show on GitHub
gpu_kernel_MPS()
Undocumented
Declaration
Swift

internal func gpu_kernel_MPS()
Show on GitHub