mlr_callback_set.lr_scheduler_one_cycle: OneCycle Learning Rate Scheduling Callback

In mlr3torch: Deep Learning with 'mlr3'

OneCycle Learning Rate Scheduling Callback

Description

Changes the learning rate based on the 1cycle learning rate policy.

Wraps torch::lr_one_cycle(), where the default values for epochs and steps_per_epoch are the number of training epochs and the number of batches per epoch.

Super classes

mlr3torch::CallbackSet -> mlr3torch::CallbackSetLRScheduler -> CallbackSetLRSchedulerOneCycle

Methods

Public methods

• CallbackSetLRSchedulerOneCycle$new()

• CallbackSetLRSchedulerOneCycle$on_begin()

• CallbackSetLRSchedulerOneCycle$clone()

Inherited methods

• mlr3torch::CallbackSet$load_state_dict()
• mlr3torch::CallbackSet$print()
• mlr3torch::CallbackSet$state_dict()

---

Method new()

Creates a new instance of this R6 class.

Usage

CallbackSetLRSchedulerOneCycle$new(...)

Arguments

...

(any)
The scheduler-specific initialization arguments.

---

Method on_begin()

Creates the scheduler using the optimizer from the context

Usage

CallbackSetLRSchedulerOneCycle$on_begin()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CallbackSetLRSchedulerOneCycle$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

mlr3torch documentation built on Aug. 26, 2025, 5:09 p.m.