Img2ColOperator

public class Img2ColOperator: ComputableOperator

Operator works like img2col in matlab. It converts any 3D tensor ([H, W, C] or [C, H, W]) into a 2D tensor ([H*W, C*M*N]) according to patchSize [M, N] and stride.

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 = "Img2col"
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
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
Show on GitHub
trainable
Indicate if this operator would do paramter update.
Declaration
Swift

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

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

public var inPlaceble: Bool = false
Show on GitHub
patchSize
The patch size. 2D vecotr. [patchHeight, patchWidth]
Declaration
Swift

public var patchSize: [Int]
Show on GitHub
stride
The stride. 2D vector. Default is [1, 1]. [strideHeight, strideWidth]
Declaration
Swift

public var stride: [Int] = [1, 1]
Show on GitHub
channelPosition
Channel position. Default is ImageChannelOrder.First
Declaration
Swift

public var channelPosition: TensorChannelOrder = .First
Show on GitHub
padMode
Padding mode. Default is PaddingMode.Valid
Declaration
Swift

public var padMode: PaddingMode = .Valid
Show on GitHub
paddingValue
Padding value
Declaration
Swift

public var paddingValue: Float = 0.0
Show on GitHub

Init


                    
                    
                    init(patchSize:stride:channelPosition:padMode:computationDelegate:inputTensors:outputTensors:operatorLabel:disableInputOutputCheck:)

Designated init

Declaration

Swift

public init(patchSize: [Int], stride: [Int],
            channelPosition: TensorChannelOrder = .First,
            padMode: PaddingMode = PaddingMode.Valid,
			computationDelegate: OperatorCalculationDelegate? = nil,
			inputTensors: [Tensor]? = nil, outputTensors: [Tensor]? = nil,
			operatorLabel: String = "Img2ColOp",
			disableInputOutputCheck: Bool = false)

Parameters

`patchSize`	[patchHeight, patchWidth]
`channelPosition`	channelPosition description
`padMode`	padMode
`stride`	[strideHeight, strideWidth]
`computationDelegate`	computationDelegate description
`inputTensors`	inputTensors description
`outputTensors`	outputTensors description
`operatorLabel`	operatorLabel description

Show on GitHub

Methods


                    
                    
                    outputShape(shapeArray:)

Compute output shape according numFilters, kernelSize, stride and dilation.

Declaration

Swift

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

Parameters


                                shapes

shapes description

Return Value

return value description

Show on GitHub

inputOutputTensorsCheck()
Check input and output tensors.
Declaration
Swift

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

return value description

Show on GitHub


                    
                    
                    compute(_:)

Compute sync way.

Declaration

Swift

public func compute(_ computationMode: OperatorComputationMode)

Parameters


                                computationMode

mode

Show on GitHub


                    
                    
                    computeAsync(_:)

Compute async

Declaration

Swift

public func computeAsync(_ computationMode: OperatorComputationMode)

Parameters


                                computationMode

computationMode

Show on GitHub


                    
                    
                    gradCompute(_:)

This operator itself does not do any grad update.

Declaration

Swift

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

Parameters


                                computationMode

computationMode description

Return Value

return value description

Show on GitHub


                    
                    
                    gradComputAsync(_:)

This operator itself does not do any grad update.

Declaration

Swift

public func gradComputAsync(_ computationMode: OperatorComputationMode)

Parameters

`computationMode`	computationMode description
`upGrads`	upGrads description

Show on GitHub


                    
                    
                    updateParams(grads:LR:)

Do nothing. No param to update

Declaration

Swift

public func updateParams(grads: [Tensor], LR: Float)

Parameters

`grads`	grads description
`LR`	LR description

Show on GitHub

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

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

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

empty array

Show on GitHub
cpu()
CPU calculation
Declaration
Swift

internal func cpu()
Show on GitHub


                    
                    
                    makeImg2ColInfo(inputShape:outputShape:)

make Img2ColInfo

Declaration

Swift

internal func makeImg2ColInfo(inputShape: TensorShape, outputShape: TensorShape) -> Img2ColInfo

Parameters

`inputShape`	input
`outputShape`	output

Return Value

struct

Show on GitHub

gpu()
GPU calculation.

Split the output 2D matrix into threadgroups based on each patch and channel index. Calculate each element in each group independently.
Declaration
Swift

internal func gpu()
Show on GitHub