Accelerate · IOS API REFERENCE

BNNS.AdamOptimizer

struct · iOS 14.0+ · SDK 27.1

struct AdamOptimizer

A structure that updates parameters according to AdamW algorithm.

Members (26)

get · iOS 14.0+

bnnsOptimizerFunction

TypeScript

get bnnsOptimizerFunction(): BNNSOptimizerFunction

Swift declaration

var bnnsOptimizerFunction: BNNSOptimizerFunction { get }

The underlying `BNNSOptimizerFunction`.

get · iOS 15.0+

usesAMSGrad

TypeScript

get usesAMSGrad(): boolean

Swift declaration

var usesAMSGrad: Bool { get set }

A Boolean value that specifies whether to use the AMSGrad variant.

set · iOS 15.0+

usesAMSGrad

TypeScript

set usesAMSGrad(value: boolean)

Swift declaration

var usesAMSGrad: Bool { get set }

A Boolean value that specifies whether to use the AMSGrad variant.

init · iOS 15.0+

init

TypeScript

static initLearningRateBeta1Beta2TimeStepEpsilonGradientScaleRegularizationScaleGradientClippingRegularizationFunctionUsesAMSGrad(learningRate: number, beta1: number, beta2: number, timeStep: number, epsilon: number, gradientScale: number, regularizationScale: number, gradientClipping: BNNS_GradientClipping, regularizationFunction: BNNSOptimizerRegularizationFunction, usesAMSGrad?: boolean): BNNS_AdamOptimizer

Swift declaration

init(learningRate: Float = 0.001, beta1: Float = 0.9, beta2: Float = 0.999, timeStep: Float, epsilon: Float = 1e-8, gradientScale: Float, regularizationScale: Float, gradientClipping: BNNS.GradientClipping, regularizationFunction: BNNSOptimizerRegularizationFunction, usesAMSGrad: Bool = false)

Returns a new Adam optimizer that supports clipping gradient values to a maximum L2-norm. - Parameter learningRate: The optimizer learning rate. - Parameter beta1: First moment constant, in the range [0,1). - Parameter beta1: Second moment constant, in the range [0,1). - Parameter timeStep:The optimizer time step. - Parameter epsilon: An addition for the division in the parameter update stage. - Parameter gradientScale: Gradient scaling factor. - Parameter regularizationScale: The regularization scaling factor. - Parameter gradientClipping: The gradient clipping. - Parameter regularizationFunction: The regularization function. - Parameter useAMSGrad: A Boolean value that specifies whether to use the AMSGrad variant.

init · iOS 14.0+

init

TypeScript

static initLearningRateBeta1Beta2TimeStepEpsilonGradientScaleRegularizationScaleClipsGradientsToRegularizationFunction(learningRate: number, beta1: number, beta2: number, timeStep: number, epsilon: number, gradientScale: number, regularizationScale: number, gradientBounds: (SDKHandle) | null, regularizationFunction: BNNSOptimizerRegularizationFunction): BNNS_AdamOptimizer

Swift declaration

init(learningRate: Float, beta1: Float, beta2: Float, timeStep: Float, epsilon: Float, gradientScale: Float, regularizationScale: Float, clipsGradientsTo gradientBounds: ClosedRange<Float>? = nil, regularizationFunction: BNNSOptimizerRegularizationFunction)

Returns a new Adam Optimizer. - Parameter learningRate: The optimizer learning rate. - Parameter beta1: First moment constant, in the range [0,1). - Parameter beta1: Second moment constant, in the range [0,1). - Parameter timeStep: The optimizer time step. You are responsible for maintaining the time step. Set the initial value to `1`, and increase by `1` after optimizing all of the layer parameters in the network. - Parameter epsilon: An addition for the division in the parameter update stage. - Parameter gradientScale: Gradient scaling factor. - Parameter regularizationScale: The regularization scaling factor. - Parameter clipsGradientsTo: A range to clip the gradient within; set to `nil` for no clipping. - Parameter regularizationFunction: The regularization function.

get · iOS 14.0+

learningRate

TypeScript

get learningRate(): number

Swift declaration

var learningRate: Float { get set }

The optimizer learning rate.

set · iOS 14.0+

learningRate

TypeScript

set learningRate(value: number)

Swift declaration

var learningRate: Float { get set }

The optimizer learning rate.

get · iOS 14.0+

gradientScale

TypeScript

get gradientScale(): number

Swift declaration

var gradientScale: Float { get set }

Gradient scaling factor.

set · iOS 14.0+

gradientScale

TypeScript

set gradientScale(value: number)

Swift declaration

var gradientScale: Float { get set }

Gradient scaling factor.

get · iOS 14.0+

gradientBounds

TypeScript

get gradientBounds(): (SDKHandle) | null

Swift declaration

var gradientBounds: ClosedRange<Float>? { get set }

A range to clip the gradient within; set to `nil` for no clipping.

set · iOS 14.0+

gradientBounds

TypeScript

set gradientBounds(value: (SDKHandle) | null)

Swift declaration

var gradientBounds: ClosedRange<Float>? { get set }

A range to clip the gradient within; set to `nil` for no clipping.

get · iOS 15.0+

gradientClipping

TypeScript

get gradientClipping(): BNNS_GradientClipping

Swift declaration

var gradientClipping: BNNS.GradientClipping { get set }

The gradient clipping.

set · iOS 15.0+

gradientClipping

TypeScript

set gradientClipping(value: BNNS_GradientClipping)

Swift declaration

var gradientClipping: BNNS.GradientClipping { get set }

The gradient clipping.

get · iOS 14.0+

regularizationScale

TypeScript

get regularizationScale(): number

Swift declaration

var regularizationScale: Float { get set }

The regularization scaling factor.

set · iOS 14.0+

regularizationScale

TypeScript

set regularizationScale(value: number)

Swift declaration

var regularizationScale: Float { get set }

The regularization scaling factor.

get · iOS 14.0+

regularizationFunction

TypeScript

get regularizationFunction(): BNNSOptimizerRegularizationFunction

Swift declaration

var regularizationFunction: BNNSOptimizerRegularizationFunction { get set }

The regularization function.

set · iOS 14.0+

regularizationFunction

TypeScript

set regularizationFunction(value: BNNSOptimizerRegularizationFunction)

Swift declaration

var regularizationFunction: BNNSOptimizerRegularizationFunction { get set }

The regularization function.

get · iOS 14.0+

accumulatorCountMultiplier

TypeScript

get accumulatorCountMultiplier(): number

Swift declaration

var accumulatorCountMultiplier: Int { get }

The number of accumulators required for each parameter.

get · iOS 14.0+

beta1

TypeScript

get beta1(): number

Swift declaration

var beta1: Float { get set }

First moment constant, in the range [0,1).

set · iOS 14.0+

beta1

TypeScript

set beta1(value: number)

Swift declaration

var beta1: Float { get set }

First moment constant, in the range [0,1).

get · iOS 14.0+

beta2

TypeScript

get beta2(): number

Swift declaration

var beta2: Float { get set }

Second moment constant, in the range [0,1).

set · iOS 14.0+

beta2

TypeScript

set beta2(value: number)

Swift declaration

var beta2: Float { get set }

Second moment constant, in the range [0,1).

get · iOS 14.0+

epsilon

TypeScript

get epsilon(): number

Swift declaration

var epsilon: Float { get set }

An addition for the division in the parameter update stage.

set · iOS 14.0+

epsilon

TypeScript

set epsilon(value: number)

Swift declaration

var epsilon: Float { get set }

An addition for the division in the parameter update stage.

get · iOS 14.0+

timeStep

TypeScript

get timeStep(): number

Swift declaration

var timeStep: Float { get set }

The optimizer time step. You are responsible for maintaining the time step. Set the initial value to `1`, and increase by `1` after optimizing all of the layer parameters in the network.

set · iOS 14.0+

timeStep

TypeScript

set timeStep(value: number)

Swift declaration

var timeStep: Float { get set }

The optimizer time step. You are responsible for maintaining the time step. Set the initial value to `1`, and increase by `1` after optimizing all of the layer parameters in the network.

Skipped declarations

No declarations were skipped in this snapshot.

All Accelerate types →