Skip to content

Main content

RMSProp Optimizer Step Calculator Source Code

Browse the implementation files for RMSProp Optimizer Step Calculator.
tool.ts typescript
import { parseFiniteNumber } from '../../parse/number/tool';

export const calculateRmspropStep = (
	parameterInput: unknown,
	gradientInput: unknown,
	averageInput: unknown,
	learningRateInput: unknown,
	decayInput: unknown,
	epsilonInput: unknown
): string => {
	const parameter = parseFiniteNumber(parameterInput);
	const gradient = parseFiniteNumber(gradientInput);
	const average = parseFiniteNumber(averageInput);
	const learningRate = parseFiniteNumber(learningRateInput);
	const decay = parseFiniteNumber(decayInput);
	const epsilon = parseFiniteNumber(epsilonInput);
	if (
		[
			parameter,
			gradient,
			average,
			learningRate,
			decay,
			epsilon
		].some((value) => value === null) ||
		average! < 0 ||
		learningRate! <= 0 ||
		decay! < 0 ||
		decay! >= 1 ||
		epsilon! <= 0
	)
		return '';
	const nextAverage =
		decay! * average! + (1 - decay!) * gradient! ** 2;
	const update =
		(learningRate! * gradient!) /
		(Math.sqrt(nextAverage) + epsilon!);
	const nextParameter = parameter! - update;
	if (
		![nextAverage, update, nextParameter].every(Number.isFinite)
	)
		return '';
	return JSON.stringify(
		{
			averageSquaredGradient: Number(
				nextAverage.toPrecision(12)
			),
			parameter: Number(nextParameter.toPrecision(12)),
			update: Number(update.toPrecision(12))
		},
		null,
		2
	);
};

export const Tool: TypeTool = {
	name: 'RMSProp Optimizer Step Calculator',
	slug: 'optimization/rmsprop-step',
	intro:
		'Calculate one scalar RMSProp parameter update and its moving squared-gradient state.',
	tool: calculateRmspropStep,
	i: [
		{
			example: '1',
			label: 'Parameter',
			placeholder: 'Current parameter',
			type: 'number'
		},
		{
			example: '0.1',
			label: 'Gradient',
			placeholder: 'Current gradient',
			type: 'number'
		},
		{
			example: '0',
			label: 'Squared-Gradient Average',
			placeholder: 'Previous moving average',
			type: 'number'
		},
		{
			example: '0.001',
			label: 'Learning Rate',
			placeholder: 'Positive learning rate',
			type: 'number'
		},
		{
			example: '0.9',
			label: 'Decay',
			placeholder: 'Decay from 0 to less than 1',
			type: 'number'
		},
		{
			example: '0.00000001',
			label: 'Epsilon',
			placeholder: 'Positive stability value',
			type: 'number'
		}
	],
	o: [
		{
			example: '{ "parameter": 0.9968 }',
			label: 'RMSProp Step',
			placeholder: 'Updated state will appear here...',
			render: 'textarea',
			type: 'text'
		}
	]
};
export default Tool;

Description

Browse the implementation files for RMSProp Optimizer Step Calculator.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools