metaheuristic_designer.parameter_schedules.cosine_schedule module

Schedule that modulates a value with a cosine wave.

class CosineSchedule(amplitude=1, frequency=None, phase=0, offset=0)

Bases: SchedulableParameter

Schedule that models the parameter as a cosine wave in the range [0, 1].

Parameters:

amplitudefloat

Amplitude of the cosine wave.

frequencyfloat

Frequency of the cosine wave.

phasefloat

Phase of the cosine wave.

offsetfloat

Offset of the cosine wave.

Parameters:

• amplitude (float)

• frequency (float)

• phase (float)

• offset (float)

Methods

__call__(progress)	Shorthand for evaluate().
evaluate(progress)	Return the parameter value at the given progress.

evaluate(progress)

Return the parameter value at the given progress.

Return type:

float

Parameters:

progressfloat

Current progress, a number between 0 (start) and 1 (end).

Returns:

Any

The parameter value at this stage of the optimization.

Parameters:

progress (float)

Notes

The return value is not restricted to numbers. You can return: * a float (e.g., a linearly decaying mutation strength), * an int (e.g., a discrete number of mutated components), * a bool (e.g., switching on/off a feature after a threshold), * a string (e.g., switching between strategies), or * any other object that the consuming component expects.

This makes schedules suitable for changing discrete algorithm choices as well as continuous numerical parameters.