ksuit.schedules.base.schedule_base

Classes

ScheduleBase

Base class for schedulers in ksuit

Module Contents

class ksuit.schedules.base.schedule_base.ScheduleBase(overhang_percent=None, overhang_steps=None)

Base class for schedulers in ksuit

Initialize the scheduler.

Parameters:

  • overhang_percent (float | None) – The percentage by which the schedule is artificially prolonged.

  • overhang_steps (int | None) – The number of steps by which the schedule is artificially prolonged.

overhang_percent = None
overhang_steps = None
get_value(step, total_steps)

Get the value of the schedule at a given step.

This function includes the correction for overhangs in percent or steps and then calls the _get_value method. Therefore, it should not be overwritten by subclasses. Instead, the _get_value method should be implemented.

Parameters:

  • step (int) – The step for which to get the scheduler value.

  • total_steps (int) – The total number of steps.

Return type:

float