GenericConstantSchedulerWithQuadraticWarmup

class lightning_ir.schedulers.schedulers.GenericConstantSchedulerWithQuadraticWarmup(num_warmup_steps: int, num_delay_steps: int = 0, *args, **kwargs)

Bases: ConstantSchedulerWithQuadraticWarmup, GenericScheduler

__init__(num_warmup_steps: int, num_delay_steps: int = 0, *args, **kwargs) → None

Base class for schedulers with warmup.

Parameters:

• num_warmup_steps (int) – Number of warmup steps.

• num_delay_steps (int) – Number of steps to delay the scheduler for. Defaults to 0.

Methods

Attributes

on_train_batch_start(trainer: Trainer, pl_module: LightningModule, batch: Any, batch_idx: int) → None

Called when the train batch begins.

on_train_end(trainer: Trainer, pl_module: LightningModule) → None

Called when the train ends.

on_train_start(trainer: Trainer, pl_module: LightningIRModule) → None

Called when the train begins.

value_lambda(current_step: int) → float

Lambda function for no decay with quadratic warmup.

Parameters:

current_step (int) – Current step.

Returns:

Value at the current step.

Return type:

float