ray.rllib.utils.schedules.scheduler.Scheduler.validate#

static Scheduler.validate(*, fixed_value_or_schedule: float | List[List[int | float]] | List[Tuple[int, int | float]], setting_name: str, description: str) → None[source]#

Performs checking of a certain schedule configuration.

The first entry in value_or_schedule (if it’s not a fixed value) must have a timestep of 0.

Parameters:

  • fixed_value_or_schedule – A fixed, constant value (in case no schedule should be used) or a schedule configuration in the format of [[timestep, value], [timestep, value], …] Intermediary timesteps will be assigned to linerarly interpolated values. A schedule config’s first entry must start with timestep 0, i.e.: [[0, initial_value], […]].

  • setting_name – The property name of the schedule setting (within a config), e.g. lr or entropy_coeff.

  • description – A full text description of the property that’s being scheduled, e.g. learning rate.

Raises:

ValueError – In case, errors are found in the schedule’s format.