oa::Sgd

SGD

ClC++ public headers

Inheritance

public Optimizer

Public Methods

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

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

void oa::Sgd::step()

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

void oa::Sgd::zeroGrad()

Constructor & Destructor Documentation

oa::Sgd::Sgd(
	oa::Span<Parameter *> inParamPtrs,
	oa::F32 inLr = 1e-2f,
	oa::F32 inMomentum = 0.0f,
	oa::F32 inWeightDecay = 0.0f
)

No public source comment is attached to this declaration.

Parameters

inParamPtrs

oa::Span<Parameter *>

—

inLr

oa::F32

Default: 1e-2f

inMomentum

oa::F32

Default: 0.0f

inWeightDecay

oa::F32

Default: 0.0f

oa::Sgd::Sgd(
	oa::Vector<Parameter *> & inParamPtrs,
	oa::F32 inLr = 1e-2f,
	oa::F32 inMomentum = 0.0f,
	oa::F32 inWeightDecay = 0.0f
)

No public source comment is attached to this declaration.

Parameters

inParamPtrs

oa::Vector<Parameter *> &

—

inLr

oa::F32

Default: 1e-2f

inMomentum

oa::F32

Default: 0.0f

inWeightDecay

oa::F32

Default: 0.0f

oa::Sgd::Sgd(
	oa::Vector<Parameter> & inParams,
	oa::F32 inLr = 1e-2f,
	oa::F32 inMomentum = 0.0f,
	oa::F32 inWeightDecay = 0.0f
)

No public source comment is attached to this declaration.

Parameters

inParams

oa::Vector<Parameter> &

—

inLr

oa::F32

Default: 1e-2f

inMomentum

oa::F32

Default: 0.0f

inWeightDecay

oa::F32

Default: 0.0f

Public Method Documentation

oa::Status oa::Sgd::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::Sgd::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::Sgd::step()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

oa::Status oa::Sgd::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::Sgd::zeroGrad()

No public source comment is attached to this declaration.

Returns

void

The declared return value.