oa::Adam

Adam class in the OA Ml public surface.

ClC++ public headers

Inheritance

public Optimizer

Public Methods

oa::Status oa::Adam::loadFrom(Engine & inEngine, const ModelFile & inFile)

oa::Status oa::Adam::saveTo(Engine & inEngine, ModelFile & outFile)

void oa::Adam::step()

oa::Status oa::Adam::validateLoad(const ModelFile & inFile)

void oa::Adam::zeroGrad()

Constructor & Destructor Documentation

oa::Adam::Adam(
	oa::Span<Parameter *> inParamPtrs,
	oa::F32 inLr = 1e-3f,
	oa::F32 inBeta1 = 0.9f,
	oa::F32 inBeta2 = 0.999f,
	oa::F32 inEps = 1e-8f
)

No public source comment is attached to this declaration.

Parameters

inParamPtrs

oa::Span<Parameter *>

—

inLr

oa::F32

Default: 1e-3f

inBeta1

oa::F32

Default: 0.9f

inBeta2

oa::F32

Default: 0.999f

inEps

oa::F32

Default: 1e-8f

oa::Adam::Adam(
	oa::Vector<Parameter *> & inParamPtrs,
	oa::F32 inLr = 1e-3f,
	oa::F32 inBeta1 = 0.9f,
	oa::F32 inBeta2 = 0.999f,
	oa::F32 inEps = 1e-8f
)

No public source comment is attached to this declaration.

Parameters

inParamPtrs

oa::Vector<Parameter *> &

—

inLr

oa::F32

Default: 1e-3f

inBeta1

oa::F32

Default: 0.9f

inBeta2

oa::F32

Default: 0.999f

inEps

oa::F32

Default: 1e-8f

oa::Adam::Adam(
	oa::Vector<Parameter> & inParams,
	oa::F32 inLr = 1e-3f,
	oa::F32 inBeta1 = 0.9f,
	oa::F32 inBeta2 = 0.999f,
	oa::F32 inEps = 1e-8f
)

No public source comment is attached to this declaration.

Parameters

inParams

oa::Vector<Parameter> &

—

inLr

oa::F32

Default: 1e-3f

inBeta1

oa::F32

Default: 0.9f

inBeta2

oa::F32

Default: 0.999f

inEps

oa::F32

Default: 1e-8f

Public Method Documentation

oa::Status oa::Adam::loadFrom(
	Engine & inEngine,
	const ModelFile & inFile
)

No public source comment is attached to this declaration.

Parameters

inEngine

Engine &

—

inFile

const ModelFile &

—

Returns

oa::Status

The declared return value.

oa::Status oa::Adam::saveTo(
	Engine & inEngine,
	ModelFile & outFile
)

No public source comment is attached to this declaration.

Parameters

inEngine

Engine &

—

outFile

ModelFile &

—

Returns

oa::Status

The declared return value.

void oa::Adam::step()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

oa::Status oa::Adam::validateLoad(
	const ModelFile & inFile
)

No public source comment is attached to this declaration.

Parameters

inFile

const ModelFile &

—

Returns

oa::Status

The declared return value.

void oa::Adam::zeroGrad()

No public source comment is attached to this declaration.

Returns

void

The declared return value.