oa::ReduceOnPlateauScheduler

ReduceOnPlateauScheduler class in the OA Ml public surface.

ClC++ public headers

Inheritance

public LRScheduler

Public Methods

oa::F32 oa::ReduceOnPlateauScheduler::getLr(oa::U64 inStep)

void oa::ReduceOnPlateauScheduler::step(oa::F32 inMetric)

Constructor & Destructor Documentation

oa::ReduceOnPlateauScheduler::ReduceOnPlateauScheduler(
	oa::F32 inInitialLr,
	oa::F32 inFactor = 0.1f,
	oa::U64 inPatience = 10,
	oa::F32 inThreshold = 1e-4f,
	oa::F32 inMinLr = 0.0f,
	PlateauMode inMode = PlateauMode::Min
)

No public source comment is attached to this declaration.

Parameters

inInitialLr

oa::F32

—

inFactor

oa::F32

Default: 0.1f

inPatience

oa::U64

Default: 10

inThreshold

oa::F32

Default: 1e-4f

inMinLr

oa::F32

Default: 0.0f

inMode

PlateauMode

Default: PlateauMode::Min

Public Method Documentation

oa::F32 oa::ReduceOnPlateauScheduler::getLr(
	oa::U64 inStep
)

No public source comment is attached to this declaration.

Parameters

inStep

oa::U64

—

Returns

oa::F32

The declared return value.

void oa::ReduceOnPlateauScheduler::step(
	oa::F32 inMetric
)

No public source comment is attached to this declaration.

Parameters

inMetric

oa::F32

—

Returns

void

The declared return value.