ChainedScheduler

class tensorplay.optim.lr_scheduler.ChainedScheduler(schedulers: Sequence[LRScheduler], optimizer: Optimizer | None = None)[source]

Chains a list of learning rate schedulers.

Takes in a sequence of chainable learning rate schedulers and calls their step() functions consecutively in just one call to step().

Parameters:

• schedulers (sequence) – sequence of chained schedulers.

• optimizer (Optimizer, optional) – Wrapped optimizer. Default: None.

Example

>>> # xdoctest: +SKIP
>>> # Assuming optimizer uses lr = 0.05 for all groups
>>> # lr = 0.005      if epoch == 0
>>> # lr = 0.00450    if epoch == 1
>>> # lr = 0.00405    if epoch == 2
>>> # ...
>>> # lr = 0.000675   if epoch == 19
>>> # lr = 0.006078   if epoch == 20
>>> # lr = 0.005470   if epoch == 21
>>> scheduler1 = ConstantLR(optimizer, factor=0.1, total_iters=20)
>>> scheduler2 = ExponentialLR(optimizer, gamma=0.9)
>>> scheduler = ChainedScheduler([scheduler1, scheduler2], optimizer=optimizer)
>>> for epoch in range(100):
>>>     train(...)
>>>     validate(...)
>>>     scheduler.step()

get_last_lr() → list[float | TensorBase]

Get the most recent learning rates computed by this scheduler.

Returns:

A list of learning rates with entries for each of the optimizer’s param_groups, with the same types as their group["lr"]s.

Return type:

list[float | Tensor]

Note

The returned Tensors are copies, and never alias the optimizer’s group["lr"]s.

get_lr() → list[float | TensorBase]

Compute the next learning rate for each of the optimizer’s param_groups.

Returns:

A list of learning rates for each of the optimizer’s param_groups with the same types as their current group["lr"]s.

Return type:

list[float | Tensor]

Note

If you’re trying to inspect the most recent learning rate, use get_last_lr() instead.

Note

The returned Tensors are copies, and never alias the optimizer’s group["lr"]s.

load_state_dict(state_dict: dict[str, Any]) → None[source]

Load the scheduler’s state.

Parameters:

state_dict (dict) – scheduler state. Should be an object returned from a call to state_dict().

state_dict() → dict[str, Any][source]

Return the state of the scheduler as a dict.

It contains an entry for every variable in self.__dict__ which is not the optimizer. The wrapped scheduler states will also be saved.

step() → None[source]

Perform a step.