Accelerate · IOS API REFERENCE

BNNS.RMSPropOptimizer

struct · iOS 14.0+ · SDK 27.1

struct RMSPropOptimizer

A structure that updates parameters according to RMSProp algorithm.

Members (24)

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 initLearningRateAlphaEpsilonCenteredMomentumGradientScaleRegularizationScaleGradientClippingRegularizationFunction(learningRate: number, alpha: number, epsilon: number, centered: boolean, momentum: number, gradientScale: number, regularizationScale: number, gradientClipping: BNNS_GradientClipping, regularizationFunction: BNNSOptimizerRegularizationFunction): BNNS_RMSPropOptimizer

Swift declaration

init(learningRate: Float = 1e-2, alpha: Float = 0.99, epsilon: Float = 1e-8, centered: Bool, momentum: Float = 0, gradientScale: Float, regularizationScale: Float, gradientClipping: BNNS.GradientClipping, regularizationFunction: BNNSOptimizerRegularizationFunction)

Returns a new RMSProp optimizer that supports clipping gradient values to a maximum L2-norm. - Parameter learningRate: The optimizer learning rate - Parameter alpha: A constant that specifies smoothing. - Parameter epsilon:A term added to denominator. - Parameter centered:A Boolean value that specifies whether to use the centered variant. - Parameter momentum: The rate of momentum decay. - Parameter gradientScale:A value that specifies the gradient scaling factor. - Parameter regularizationScale: The regularization scaling factor. - Parameter gradientClipping: The gradient clipping. - Parameter regularizationFunction:The regularization function.

init · iOS 14.0+

init

TypeScript

static initLearningRateAlphaEpsilonCenteredMomentumGradientScaleRegularizationScaleClipsGradientsToRegularizationFunction(learningRate: number, alpha: number, epsilon: number, centered: boolean, momentum: number, gradientScale: number, regularizationScale: number, gradientBounds: (SDKHandle) | null, regularizationFunction: BNNSOptimizerRegularizationFunction): BNNS_RMSPropOptimizer

Swift declaration

init(learningRate: Float, alpha: Float, epsilon: Float, centered: Bool, momentum: Float, gradientScale: Float, regularizationScale: Float, clipsGradientsTo gradientBounds: ClosedRange<Float>? = nil, regularizationFunction: BNNSOptimizerRegularizationFunction)

Returns a new RMSProp optimizer. - Parameter learningRate: A value that specifies the learning rate. - Parameter alpha: A constant that specifies smoothing, in the range 0 to 1. - Parameter epsilon: A term added to denominator. - Parameter centered: A Boolean value that specifies whether to use the centered variant. - 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 regularizationFunction: The variable that specifies 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 }

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. 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. The gradient clipping.

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+

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+

alpha

TypeScript

get alpha(): number

Swift declaration

var alpha: Float { get set }

A constant that specifies smoothing, in the range 0 to 1.

set · iOS 14.0+

alpha

TypeScript

set alpha(value: number)

Swift declaration

var alpha: Float { get set }

A constant that specifies smoothing, in the range 0 to 1.

get · iOS 14.0+

epsilon

TypeScript

get epsilon(): number

Swift declaration

var epsilon: Float { get set }

A term added to denominator.

set · iOS 14.0+

epsilon

TypeScript

set epsilon(value: number)

Swift declaration

var epsilon: Float { get set }

A term added to denominator.

get · iOS 14.0+

centered

TypeScript

get centered(): boolean

Swift declaration

var centered: Bool { get set }

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

set · iOS 14.0+

centered

TypeScript

set centered(value: boolean)

Swift declaration

var centered: Bool { get set }

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

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 →