ReduceOperator

public class ReduceOperator: ComputableOperator

The abstract class for all reduce operators. Should not be used directly. A reduce operator do some aggregate calculation along given axes. An example given by TensorFlow is here.

Attributes

computationDelegate
/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
Declaration
Swift

public var computationDelegate: OperatorCalculationDelegate?
Show on GitHub
metalKernelFuncLabel
Declaration
Swift

public var metalKernelFuncLabel: String
Show on GitHub
operatorLabel
Declaration
Swift

public var operatorLabel: String
Show on GitHub
inputTensors
Declaration
Swift

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

public var outputTensors: [Tensor]?
Show on GitHub
axis
The axes to do the computation
Declaration
Swift

public var axis: [Int]
Show on GitHub
keepDim
Indicate if keep dimensions in result tensor. This just affects result tensor’s shape attributes. Default false
Declaration
Swift

public var keepDim: Bool = false
Show on GitHub
cpuComputeBlock
The element compuation block in CPU mode. In most cases, subclass should just override this part in init method instead overriding the whole cpu() method. The firat pointer is the input tensor, / the second is the output tensor
Declaration
Swift

public lazy var cpuComputeBlock: (Tensor, Tensor, [Int]) -> Void = { (inputTensor: Tensor, outputTensor: Tensor, axis: [Int]) -> Void in
Show on GitHub
disableUpGradShapeCheck
If true, operator will not check the upGrads‘s shape. This is used inside framework to speed up in situation we know it will not be wrong. Cases like auto generated differentiation graph.
Declaration
Swift

public var disableUpGradShapeCheck: Bool = false
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.

Note
All UnaryOperators are not trainable.
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
Reduce operator cannot do in-place calculation
Declaration
Swift

public var inPlaceble: Bool = false
Show on GitHub

Initializers


                    
                    
                    init(computationDelegate:operatorLabel:metalKernelFuncLabel:inputTensors:outputTensors:axis:)

Undocumented

Declaration

Swift

init(computationDelegate: OperatorCalculationDelegate?,
            operatorLabel: String = "NEED OVERRIDE",
            metalKernelFuncLabel kernelLabel: String = "NEED OVERRIDE",
            inputTensors: [Tensor]?, outputTensors: [Tensor]?,
            axis: [Int])

Show on GitHub


                    
                    
                    init(inputTensors:outputTensors:axis:)

Conenience init.

Declaration

Swift

public convenience required init(inputTensors: [Tensor]? = nil, outputTensors: [Tensor]? = nil, axis: [Int])

Parameters

`inputTensors`	inputTensors description
`outputTensors`	outputTensors description
`axis`	axis description

Show on GitHub


                    
                    
                    init(axis:keepDim:)

Conenience init.

Declaration

Swift

public convenience init(axis: [Int], keepDim: Bool)

Parameters

`axis`	axis
`keepDim`	keepDim

Show on GitHub

Methods


                    
                    
                    outputShape(shapeArray:)

Check if for each input shape operator could do reduce operation with axis attribute value.

Declaration

Swift

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

Parameters


                                shapes

shapes description

Return Value

return value description

Show on GitHub

inputOutputTensorsCheck()
Validate shapesinputTensors and outputTensors.
Declaration
Swift

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

check passing and message if not passing

Show on GitHub


                    
                    
                    compute(_:)

Comput sync

Declaration

Swift

public func compute(_ computationMode: OperatorComputationMode = SerranoEngine.configuredEngine.defaultComputationMode)

Parameters


                                computationMode

computationMode description

Show on GitHub


                    
                    
                    computeAsync(_:)

Comput async

Declaration

Swift

public func computeAsync(_ computationMode: OperatorComputationMode = SerranoEngine.configuredEngine.defaultComputationMode)

Parameters


                                computationMode

computationMode description

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


                    
                    
                    updateParams(grads:LR:)

Update params if possible. No update parameters for binary operators.

Declaration

Swift

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

Parameters

`grads`	grads tensor list
`LR`	learning rate

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()
Undocumented
Declaration
Swift

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

internal func gpu()
Show on GitHub