Accelerate · IOS API REFERENCE

BNNS.SGDMomentumOptimizer

struct · iOS 14.0+ · SDK 27.1

struct SGDMomentumOptimizer

A structure that updates parameters according to SGD with momentum.

Members (25)

get · iOS 14.0+

bnnsOptimizerFunction

TypeScript

get bnnsOptimizerFunction(): BNNSOptimizerFunction

Swift declaration

var bnnsOptimizerFunction: BNNSOptimizerFunction { get }

The underlying `BNNSOptimizerFunction`.

init · iOS 15.0+

init

TypeScript

static initLearningRateMomentumGradientScaleRegularizationScaleGradientClippingUsesNesterovMomentumRegularizationFunctionSgdMomentumVariant(learningRate: number, momentum: number, gradientScale: number, regularizationScale: number, gradientClipping: BNNS_GradientClipping, usesNesterovMomentum: boolean, regularizationFunction: BNNSOptimizerRegularizationFunction, sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant): BNNS_SGDMomentumOptimizer

Swift declaration

init(learningRate: Float, momentum: Float = 0, gradientScale: Float, regularizationScale: Float, gradientClipping: BNNS.GradientClipping, usesNesterovMomentum: Bool = false, regularizationFunction: BNNSOptimizerRegularizationFunction, sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant)

Returns a new SGD with momentum optimizer that supports clipping gradient values to a maximum L2-norm. - Parameter learningRate: The optimizer learning rate. - Parameter momentum: The rate of momentum decay. - Parameter gradientScale: Gradient scaling factor. - Parameter regularizationScale: The regularization scaling factor. - Parameter gradientClipping: The gradient clipping. - Parameter usesNesterovMomentum: A Boolean value that specifies whether to use Nesterov momentum update. - Parameter regularizationFunction: The regularization function. - Parameter sgdMomentumVariant: The variable that specifies the momentum variant.

init · iOS 14.0+ · Deprecated in iOS 15.0

init

TypeScript

static initLearningRateMomentumGradientScaleRegularizationScaleClipsGradientsToUsesNestrovMomentumRegularizationFunctionSgdMomentumVariant(learningRate: number, momentum: number, gradientScale: number, regularizationScale: number, gradientBounds: (SDKHandle) | null, usesNestrovMomentum: boolean, regularizationFunction: BNNSOptimizerRegularizationFunction, sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant): BNNS_SGDMomentumOptimizer

Swift declaration

init(learningRate: Float, momentum: Float, gradientScale: Float, regularizationScale: Float, clipsGradientsTo gradientBounds: ClosedRange<Float>? = nil, usesNestrovMomentum: Bool, regularizationFunction: BNNSOptimizerRegularizationFunction, sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant)

Returns a new SGD with momentum optimizer. - Parameter learningRate: A value that specifies the learning rate. - Parameter momentum: The rate of momentum decay. - Parameter gradientScale: A value that specifies the gradient scaling factor. - Parameter regularizationScale: A value that specifies the regularization scaling factor. - Parameter gradientBounds: A range to clip the gradient within; set to `nil` for no clipping. - Parameter usesNestrovMomentum: A Boolean value that specifies whether to use Nesterov momentum update. - Parameter regularizationFunction: The variable that specifies the regularization function. - Parameter sgdMomentumVariant: The variable that specifies the momentum variant.

init · iOS 15.0+

init

TypeScript

static initLearningRateMomentumGradientScaleRegularizationScaleClipsGradientsToUsesNesterovMomentumRegularizationFunctionSgdMomentumVariant(learningRate: number, momentum: number, gradientScale: number, regularizationScale: number, gradientBounds: (SDKHandle) | null, usesNesterovMomentum: boolean, regularizationFunction: BNNSOptimizerRegularizationFunction, sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant): BNNS_SGDMomentumOptimizer

Swift declaration

init(learningRate: Float, momentum: Float, gradientScale: Float, regularizationScale: Float, clipsGradientsTo gradientBounds: ClosedRange<Float>? = nil, usesNesterovMomentum: Bool, regularizationFunction: BNNSOptimizerRegularizationFunction, sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant)

Returns a new SGD with momentum optimizer. - Parameter learningRate: A value that specifies the learning rate. - Parameter momentum: The rate of momentum decay. - Parameter gradientScale: A value that specifies the gradient scaling factor. - Parameter regularizationScale: A value that specifies the regularization scaling factor. - Parameter gradientBounds: A range to clip the gradient within; set to `nil` for no clipping. - Parameter usesNesterovMomentum: A Boolean value that specifies whether to use Nesterov momentum update. - Parameter regularizationFunction: The variable that specifies the regularization function. - Parameter sgdMomentumVariant: The variable that specifies the momentum variant.

get · iOS 14.0+

learningRate

TypeScript

get learningRate(): number

Swift declaration

var learningRate: Float { get set }

A value that specifies the learning rate.

set · iOS 14.0+

learningRate

TypeScript

set learningRate(value: number)

Swift declaration

var learningRate: Float { get set }

A value that specifies the learning rate.

get · iOS 14.0+

gradientScale

TypeScript

get gradientScale(): number

Swift declaration

var gradientScale: Float { get set }

A value that specifies the gradient scaling factor.

set · iOS 14.0+

gradientScale

TypeScript

set gradientScale(value: number)

Swift declaration

var gradientScale: Float { get set }

A value that specifies the 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+

sgdMomentumVariant

TypeScript

get sgdMomentumVariant(): BNNSOptimizerSGDMomentumVariant

Swift declaration

var sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant { get set }

The variable that specifies the momentum variant.

set · iOS 14.0+

sgdMomentumVariant

TypeScript

set sgdMomentumVariant(value: BNNSOptimizerSGDMomentumVariant)

Swift declaration

var sgdMomentumVariant: BNNSOptimizerSGDMomentumVariant { get set }

The variable that specifies the momentum variant.

get · iOS 14.0+

regularizationScale

TypeScript

get regularizationScale(): number

Swift declaration

var regularizationScale: Float { get set }

A value that specifies the regularization scaling factor.

set · iOS 14.0+

regularizationScale

TypeScript

set regularizationScale(value: number)

Swift declaration

var regularizationScale: Float { get set }

A value that specifies the regularization scaling factor.

get · iOS 14.0+ · Deprecated in iOS 15.0

usesNestrovMomentum

TypeScript

get usesNestrovMomentum(): boolean

Swift declaration

var usesNestrovMomentum: Bool { get set }

A Boolean value that specifies whether to use Nesterov momentum update.

set · iOS 14.0+ · Deprecated in iOS 15.0

usesNestrovMomentum

TypeScript

set usesNestrovMomentum(value: boolean)

Swift declaration

var usesNestrovMomentum: Bool { get set }

A Boolean value that specifies whether to use Nesterov momentum update.

get · iOS 15.0+

usesNesterovMomentum

TypeScript

get usesNesterovMomentum(): boolean

Swift declaration

var usesNesterovMomentum: Bool { get set }

A Boolean value that specifies whether to use Nesterov momentum update.

set · iOS 15.0+

usesNesterovMomentum

TypeScript

set usesNesterovMomentum(value: boolean)

Swift declaration

var usesNesterovMomentum: Bool { get set }

A Boolean value that specifies whether to use Nesterov momentum update.

get · iOS 14.0+

regularizationFunction

TypeScript

get regularizationFunction(): BNNSOptimizerRegularizationFunction

Swift declaration

var regularizationFunction: BNNSOptimizerRegularizationFunction { get set }

The variable that specifies the regularization function.

set · iOS 14.0+

regularizationFunction

TypeScript

set regularizationFunction(value: BNNSOptimizerRegularizationFunction)

Swift declaration

var regularizationFunction: BNNSOptimizerRegularizationFunction { get set }

The variable that specifies 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+

momentum

TypeScript

get momentum(): number

Swift declaration

var momentum: Float { get set }

The rate of momentum decay.

set · iOS 14.0+

momentum

TypeScript

set momentum(value: number)

Swift declaration

var momentum: Float { get set }

The rate of momentum decay.

Skipped declarations

No declarations were skipped in this snapshot.

All Accelerate types →