CopyOperator

public class CopyOperator: ComputableOperator

Do copy operation on inputTensors.

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 = ""
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
Declaration
Swift

public var outputTensors: [Tensor]?
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
CopyOperator is 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
Copy operator cannot do in-place calculation
Declaration
Swift

public var inPlaceble: Bool = false
Show on GitHub

Initializers


                    
                    
                    init(operatorLabel:computationDelegate:inputTensors:outputTensors:)

Designated init function

Declaration

Swift

public init(operatorLabel label: String, computationDelegate delegate: OperatorCalculationDelegate?,
            inputTensors: [Tensor]?, outputTensors: [Tensor]?)

Parameters

`label`	label description
`delegate`	delegate description

Show on GitHub


                    
                    
                    init(operatorLabel:)

Convenience init function

Declaration

Swift

public convenience init(operatorLabel label: String = "CopyOperator")

Parameters


                                label

label description

Show on GitHub

init(inputTensors:)
Undocumented
Declaration
Swift

public convenience init(inputTensors tensors: [Tensor])
Show on GitHub


                    
                    
                    init(inputTensors:outputTensors:)

Undocumented

Declaration

Swift

public convenience init(inputTensors tensors: [Tensor], outputTensors: [Tensor])

Show on GitHub

Methods


                    
                    
                    outputShape(shapeArray:)

For any input shapes, the output tensor’s shapes will be exactly the same

Declaration

Swift

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

Parameters


                                shapes

shapes description

Return Value

return value description

Show on GitHub

inputOutputTensorsCheck()
The inputTensors should not be nil.
Declaration
Swift

public func inputOutputTensorsCheck() -> (check: Bool, msg: String)
Show on GitHub


                    
                    
                    compute(_:)

Compute sync

Note

This operator always runs on CPU.

Declaration

Swift

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

Parameters

`tensors`	tensors description
`computationMode`	computationMode description. Will be ignored.

Return Value

return value description

Show on GitHub


                    
                    
                    computeAsync(_:)

Compute Async

Declaration

Swift

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

Parameters

`tensors`	tensors description
`computationMode`	computationMode description

Show on GitHub


                    
                    
                    gradCompute(_:)

Calulate grads sync. The gradient of copy is 1.

Declaration

Swift

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

Parameters


                                computationMode

computationMode

Return Value

return upGrads if not nil. Else return an empty array.

Show on GitHub


                    
                    
                    gradComputAsync(_:)

Cal grads async

Declaration

Swift

public func gradComputAsync(_ computationMode: OperatorComputationMode)

Parameters

`computationMode`	computationMode
`upGrds`	upGrds

Show on GitHub


                    
                    
                    updateParams(grads:LR:)

No updatable parameters. This function just returns.

Declaration

Swift

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

Parameters

`grads`	grads
`LR`	LR

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