MetalPerformanceShaders · IOS API REFERENCE

MPSNNOptimizerAdam

class · iOS 12.0+ · SDK 27.1

class MPSNNOptimizerAdam

Members (17)

method · iOS 13.0+

encode

TypeScript

encodeCommandBufferBatchNormalizationGradientStateBatchNormalizationSourceStateInputMomentumVectorsInputVelocityVectorsMaximumVelocityVectorsResultState(commandBuffer: SDKHandle, batchNormalizationGradientState: MPSCNNBatchNormalizationState, batchNormalizationSourceState: MPSCNNBatchNormalizationState, inputMomentumVectors: Array<MPSVector>, inputVelocityVectors: Array<MPSVector>, maximumVelocityVectors: (Array<MPSVector>) | null, resultState: MPSCNNNormalizationGammaAndBetaState): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, batchNormalizationGradientState: MPSCNNBatchNormalizationState, batchNormalizationSourceState: MPSCNNBatchNormalizationState, inputMomentumVectors: [MPSVector], inputVelocityVectors: [MPSVector], maximumVelocityVectors: [MPSVector]?, resultState: MPSCNNNormalizationGammaAndBetaState)

method · iOS 12.0+

encode

TypeScript

encodeCommandBufferBatchNormalizationGradientStateBatchNormalizationSourceStateInputMomentumVectorsInputVelocityVectorsResultState(commandBuffer: SDKHandle, batchNormalizationGradientState: MPSCNNBatchNormalizationState, batchNormalizationSourceState: MPSCNNBatchNormalizationState, inputMomentumVectors: (Array<MPSVector>) | null, inputVelocityVectors: (Array<MPSVector>) | null, resultState: MPSCNNNormalizationGammaAndBetaState): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, batchNormalizationGradientState: MPSCNNBatchNormalizationState, batchNormalizationSourceState: MPSCNNBatchNormalizationState, inputMomentumVectors: [MPSVector]?, inputVelocityVectors: [MPSVector]?, resultState: MPSCNNNormalizationGammaAndBetaState)

method · iOS 13.0+

encode

TypeScript

encodeCommandBufferBatchNormalizationStateInputMomentumVectorsInputVelocityVectorsMaximumVelocityVectorsResultState(commandBuffer: SDKHandle, batchNormalizationState: MPSCNNBatchNormalizationState, inputMomentumVectors: Array<MPSVector>, inputVelocityVectors: Array<MPSVector>, maximumVelocityVectors: (Array<MPSVector>) | null, resultState: MPSCNNNormalizationGammaAndBetaState): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, batchNormalizationState: MPSCNNBatchNormalizationState, inputMomentumVectors: [MPSVector], inputVelocityVectors: [MPSVector], maximumVelocityVectors: [MPSVector]?, resultState: MPSCNNNormalizationGammaAndBetaState)

method · iOS 12.0+

encode

TypeScript

encodeCommandBufferBatchNormalizationStateInputMomentumVectorsInputVelocityVectorsResultState(commandBuffer: SDKHandle, batchNormalizationState: MPSCNNBatchNormalizationState, inputMomentumVectors: (Array<MPSVector>) | null, inputVelocityVectors: (Array<MPSVector>) | null, resultState: MPSCNNNormalizationGammaAndBetaState): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, batchNormalizationState: MPSCNNBatchNormalizationState, inputMomentumVectors: [MPSVector]?, inputVelocityVectors: [MPSVector]?, resultState: MPSCNNNormalizationGammaAndBetaState)

method · iOS 13.0+

encode

TypeScript

encodeCommandBufferConvolutionGradientStateConvolutionSourceStateInputMomentumVectorsInputVelocityVectorsMaximumVelocityVectorsResultState(commandBuffer: SDKHandle, convolutionGradientState: MPSCNNConvolutionGradientState, convolutionSourceState: MPSCNNConvolutionWeightsAndBiasesState, inputMomentumVectors: Array<MPSVector>, inputVelocityVectors: Array<MPSVector>, maximumVelocityVectors: (Array<MPSVector>) | null, resultState: MPSCNNConvolutionWeightsAndBiasesState): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, convolutionGradientState: MPSCNNConvolutionGradientState, convolutionSourceState: MPSCNNConvolutionWeightsAndBiasesState, inputMomentumVectors: [MPSVector], inputVelocityVectors: [MPSVector], maximumVelocityVectors: [MPSVector]?, resultState: MPSCNNConvolutionWeightsAndBiasesState)

method · iOS 12.0+

encode

TypeScript

encodeCommandBufferConvolutionGradientStateConvolutionSourceStateInputMomentumVectorsInputVelocityVectorsResultState(commandBuffer: SDKHandle, convolutionGradientState: MPSCNNConvolutionGradientState, convolutionSourceState: MPSCNNConvolutionWeightsAndBiasesState, inputMomentumVectors: (Array<MPSVector>) | null, inputVelocityVectors: (Array<MPSVector>) | null, resultState: MPSCNNConvolutionWeightsAndBiasesState): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, convolutionGradientState: MPSCNNConvolutionGradientState, convolutionSourceState: MPSCNNConvolutionWeightsAndBiasesState, inputMomentumVectors: [MPSVector]?, inputVelocityVectors: [MPSVector]?, resultState: MPSCNNConvolutionWeightsAndBiasesState)

method · iOS 13.0+

encode

TypeScript

encodeCommandBufferInputGradientMatrixInputValuesMatrixInputMomentumMatrixInputVelocityMatrixMaximumVelocityMatrixResultValuesMatrix(commandBuffer: SDKHandle, inputGradientMatrix: MPSMatrix, inputValuesMatrix: MPSMatrix, inputMomentumMatrix: MPSMatrix, inputVelocityMatrix: MPSMatrix, maximumVelocityMatrix: (MPSMatrix) | null, resultValuesMatrix: MPSMatrix): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, inputGradientMatrix: MPSMatrix, inputValuesMatrix: MPSMatrix, inputMomentumMatrix: MPSMatrix, inputVelocityMatrix: MPSMatrix, maximumVelocityMatrix: MPSMatrix?, resultValuesMatrix: MPSMatrix)

method · iOS 13.0+

encode

TypeScript

encodeCommandBufferInputGradientMatrixInputValuesMatrixInputMomentumMatrixInputVelocityMatrixResultValuesMatrix(commandBuffer: SDKHandle, inputGradientMatrix: MPSMatrix, inputValuesMatrix: MPSMatrix, inputMomentumMatrix: MPSMatrix, inputVelocityMatrix: MPSMatrix, resultValuesMatrix: MPSMatrix): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, inputGradientMatrix: MPSMatrix, inputValuesMatrix: MPSMatrix, inputMomentumMatrix: MPSMatrix, inputVelocityMatrix: MPSMatrix, resultValuesMatrix: MPSMatrix)

method · iOS 13.0+

encode

TypeScript

encodeCommandBufferInputGradientVectorInputValuesVectorInputMomentumVectorInputVelocityVectorMaximumVelocityVectorResultValuesVector(commandBuffer: SDKHandle, inputGradientVector: MPSVector, inputValuesVector: MPSVector, inputMomentumVector: MPSVector, inputVelocityVector: MPSVector, maximumVelocityVector: (MPSVector) | null, resultValuesVector: MPSVector): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, inputGradientVector: MPSVector, inputValuesVector: MPSVector, inputMomentumVector: MPSVector, inputVelocityVector: MPSVector, maximumVelocityVector: MPSVector?, resultValuesVector: MPSVector)

method · iOS 12.0+

encode

TypeScript

encodeCommandBufferInputGradientVectorInputValuesVectorInputMomentumVectorInputVelocityVectorResultValuesVector(commandBuffer: SDKHandle, inputGradientVector: MPSVector, inputValuesVector: MPSVector, inputMomentumVector: MPSVector, inputVelocityVector: MPSVector, resultValuesVector: MPSVector): void

Swift declaration

func encode(commandBuffer: any MTLCommandBuffer, inputGradientVector: MPSVector, inputValuesVector: MPSVector, inputMomentumVector: MPSVector, inputVelocityVector: MPSVector, resultValuesVector: MPSVector)

init · iOS 12.0+

init

TypeScript

static initDeviceBeta1Beta2EpsilonTimeStepOptimizerDescriptor(device: SDKHandle, beta1: number, beta2: number, epsilon: number, timeStep: number, optimizerDescriptor: MPSNNOptimizerDescriptor): MPSNNOptimizerAdam

Swift declaration

init(device: any MTLDevice, beta1: Double, beta2: Double, epsilon: Float, timeStep: Int, optimizerDescriptor: MPSNNOptimizerDescriptor)

init · iOS 12.0+

init

TypeScript

static initDeviceLearningRate(device: SDKHandle, learningRate: number): MPSNNOptimizerAdam

Swift declaration

init(device: any MTLDevice, learningRate: Float)

get · iOS 12.0+

beta1

TypeScript

get beta1(): number

Swift declaration

var beta1: Double { get }

get · iOS 12.0+

beta2

TypeScript

get beta2(): number

Swift declaration

var beta2: Double { get }

get · iOS 12.0+

epsilon

TypeScript

get epsilon(): number

Swift declaration

var epsilon: Float { get }

get · iOS 12.0+

timeStep

TypeScript

get timeStep(): number

Swift declaration

var timeStep: Int { get set }

set · iOS 12.0+

timeStep

TypeScript

set timeStep(value: number)

Swift declaration

var timeStep: Int { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

MPSNNOptimizerAdam.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

All MetalPerformanceShaders types →