Accelerate · IOS API REFERENCE

BNNS.AdamWOptimizer

struct · iOS 15.0+ · SDK 27.1

struct AdamWOptimizer

A structure that updates parameters according to AdamW algorithm.

Members (19)

get · iOS 15.0+

weightDecay

TypeScript

get weightDecay(): number

Swift declaration

var weightDecay: Float { get set }

The weight decay coefficient.

set · iOS 15.0+

weightDecay

TypeScript

set weightDecay(value: number)

Swift declaration

var weightDecay: Float { get set }

The weight decay coefficient.

init · iOS 15.0+

init

TypeScript

static init(learningRate: number, beta1: number, beta2: number, timeStep: number, epsilon: number, gradientScale: number, weightDecay: number, gradientClipping: BNNS_GradientClipping, usesAMSGrad?: boolean): BNNS_AdamWOptimizer

Swift declaration

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

Returns a new AdamW 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 weightDecay: The weight decay coefficient. - Parameter gradientClipping: The gradient clipping. - Parameter useAMSGrad: A Boolean value that specifies whether to use the AMSGrad variant.

get · iOS 15.0+

learningRate

TypeScript

get learningRate(): number

Swift declaration

var learningRate: Float { get set }

The optimizer learning rate.

set · iOS 15.0+

learningRate

TypeScript

set learningRate(value: number)

Swift declaration

var learningRate: Float { get set }

The optimizer learning rate.

get · iOS 15.0+

gradientScale

TypeScript

get gradientScale(): number

Swift declaration

var gradientScale: Float { get set }

Gradient scaling factor.

set · iOS 15.0+

gradientScale

TypeScript

set gradientScale(value: number)

Swift declaration

var gradientScale: Float { get set }

Gradient scaling factor.

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 15.0+

bnnsOptimizerFunction

TypeScript

get bnnsOptimizerFunction(): BNNSOptimizerFunction

Swift declaration

var bnnsOptimizerFunction: BNNSOptimizerFunction { get }

The underlying `BNNSOptimizerFunction`.

get · iOS 15.0+

accumulatorCountMultiplier

TypeScript

get accumulatorCountMultiplier(): number

Swift declaration

var accumulatorCountMultiplier: Int { get }

The number of accumulators required for each parameter.

get · iOS 15.0+

beta1

TypeScript

get beta1(): number

Swift declaration

var beta1: Float { get set }

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

set · iOS 15.0+

beta1

TypeScript

set beta1(value: number)

Swift declaration

var beta1: Float { get set }

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

get · iOS 15.0+

beta2

TypeScript

get beta2(): number

Swift declaration

var beta2: Float { get set }

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

set · iOS 15.0+

beta2

TypeScript

set beta2(value: number)

Swift declaration

var beta2: Float { get set }

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

get · iOS 15.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 15.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 15.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 15.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 →