Skip to content

Commit dad1729

Browse files
committed
fix(model): set step interval on learning rate schedulers
- Wrap step-based learning rate schedulers with interval="step" across EfficientAd, Dinomaly, InpFormer, Uflow, and UniNet so schedulers decay per batch step instead of per epoch. - Auto-attach LearningRateMonitor in Engine when a logger is configured. - Add unit test for engine callback setup. - Update CHANGELOG.md under Unreleased. Signed-off-by: Joaquin Rus Bono <jrusbo@gmail.com>
1 parent 0e21c0a commit dad1729

8 files changed

Lines changed: 77 additions & 24 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
88

99
### Added
1010

11+
- 🚀 **engine**: Automatically attach `LearningRateMonitor` callback when a logger is configured by @jrusbo in https://github.com/open-edge-platform/anomalib/pull/3879
12+
1113
### Removed
1214

1315
### Changed
@@ -20,6 +22,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
2022

2123
- 🐞 **model**: Keep PatchCore's batch size dynamic when exporting by @varunikarai in https://github.com/open-edge-platform/anomalib/pull/3853
2224
- 📚 **docs**: Align custom-data, export, benchmark, and Lightning examples with current APIs
25+
- 🐞 **model**: Set step interval on learning rate schedulers for EfficientAd, Dinomaly, InpFormer, Uflow, and UniNet by @jrusbo in https://github.com/open-edge-platform/anomalib/pull/3879
2326

2427
## [v2.7.0] - 2026-10-06
2528

‎src/anomalib/engine/engine.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
from typing import Any
3333

3434
from lightning.fabric.plugins.io.checkpoint_io import CheckpointIO
35-
from lightning.pytorch.callbacks import Callback
35+
from lightning.pytorch.callbacks import Callback, LearningRateMonitor
3636
from lightning.pytorch.loggers import Logger
3737
from lightning.pytorch.trainer import Trainer
3838
from lightning.pytorch.utilities.types import _EVALUATE_OUTPUT, _PREDICT_OUTPUT, EVAL_DATALOADERS, TRAIN_DATALOADERS
@@ -386,6 +386,12 @@ def _setup_anomalib_callbacks(self) -> None:
386386
callbacks.append(TimerCallback())
387387
callbacks.append(MaxStepsProgressCallback())
388388

389+
# Add LearningRateMonitor if a logger is configured and barebones is not enabled.
390+
if self._cache.args.get("logger") and not is_barebones:
391+
has_lr_monitor = any(isinstance(c, LearningRateMonitor) for c in self._cache.args["callbacks"])
392+
if not has_lr_monitor:
393+
callbacks.append(LearningRateMonitor(logging_interval="step"))
394+
389395
# Combine the callbacks, and update the trainer callbacks.
390396
self._cache.args["callbacks"] = callbacks + self._cache.args["callbacks"]
391397

‎src/anomalib/models/image/dinomaly/lightning_model.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ def configure_optimizers(self) -> OptimizerLRScheduler:
327327
configuration, supporting both max_steps and max_epochs settings.
328328
329329
Returns:
330-
OptimizerLRScheduler: Tuple containing optimizer and scheduler configurations.
330+
OptimizerLRScheduler: Dictionary containing optimizer and scheduler configurations.
331331
332332
Raises:
333333
ValueError: If neither max_epochs nor max_steps is defined.
@@ -375,7 +375,13 @@ def configure_optimizers(self) -> OptimizerLRScheduler:
375375

376376
lr_scheduler = WarmCosineScheduler(optimizer, **scheduler_config)
377377

378-
return [optimizer], [lr_scheduler]
378+
return {
379+
"optimizer": optimizer,
380+
"lr_scheduler": {
381+
"scheduler": lr_scheduler,
382+
"interval": "step",
383+
},
384+
}
379385

380386
@property
381387
def learning_type(self) -> LearningType:

‎src/anomalib/models/image/efficient_ad/lightning_model.py‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
import torch
4545
import tqdm
46-
from lightning.pytorch.utilities.types import STEP_OUTPUT
46+
from lightning.pytorch.utilities.types import STEP_OUTPUT, OptimizerLRScheduler
4747
from torch.utils.data import DataLoader
4848
from torchvision.datasets import ImageFolder
4949
from torchvision.transforms.v2 import CenterCrop, Compose, Normalize, RandomGrayscale, Resize, ToTensor
@@ -317,14 +317,14 @@ def configure_pre_processor(cls, image_size: tuple[int, int] | None = None) -> P
317317
transform = Compose([Resize(image_size, antialias=True)])
318318
return PreProcessor(transform=transform)
319319

320-
def configure_optimizers(self) -> torch.optim.Optimizer:
320+
def configure_optimizers(self) -> OptimizerLRScheduler:
321321
"""Configure optimizers for training.
322322
323323
Sets up Adam optimizer with learning rate scheduler that decays LR by 0.1
324324
at 95% of training.
325325
326326
Returns:
327-
dict: Dictionary containing:
327+
OptimizerLRScheduler: Dictionary containing:
328328
- ``optimizer``: Adam optimizer
329329
- ``lr_scheduler``: StepLR scheduler
330330
@@ -356,7 +356,13 @@ def configure_optimizers(self) -> torch.optim.Optimizer:
356356
)
357357

358358
scheduler = torch.optim.lr_scheduler.StepLR(optimizer, step_size=int(0.95 * num_steps), gamma=0.1)
359-
return {"optimizer": optimizer, "lr_scheduler": scheduler}
359+
return {
360+
"optimizer": optimizer,
361+
"lr_scheduler": {
362+
"scheduler": scheduler,
363+
"interval": "step",
364+
},
365+
}
360366

361367
def on_train_start(self) -> None:
362368
"""Set up model before training begins.

‎src/anomalib/models/image/inp_former/lightning_model.py‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ def configure_optimizers(self) -> OptimizerLRScheduler:
327327
configuration, supporting both max_steps and max_epochs settings.
328328
329329
Returns:
330-
OptimizerLRScheduler: Tuple containing optimizer and scheduler configurations.
330+
OptimizerLRScheduler: Dictionary containing optimizer and scheduler configurations.
331331
332332
Raises:
333333
ValueError: If neither max_epochs nor max_steps is defined.
@@ -368,7 +368,13 @@ def configure_optimizers(self) -> OptimizerLRScheduler:
368368

369369
lr_scheduler = WarmCosineScheduler(optimizer, **scheduler_config)
370370

371-
return [optimizer], [lr_scheduler]
371+
return {
372+
"optimizer": optimizer,
373+
"lr_scheduler": {
374+
"scheduler": lr_scheduler,
375+
"interval": "step",
376+
},
377+
}
372378

373379
@property
374380
def learning_type(self) -> LearningType:

‎src/anomalib/models/image/uflow/lightning_model.py‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2023-2024 Intel Corporation
1+
# Copyright (C) 2023-2026 Intel Corporation
22
# SPDX-License-Identifier: Apache-2.0
33

44
"""U-Flow: A U-shaped Normalizing Flow for Anomaly Detection with Unsupervised Threshold.
@@ -32,9 +32,7 @@
3232
from typing import Any
3333

3434
import torch
35-
from lightning.pytorch.core.optimizer import LightningOptimizer
36-
from lightning.pytorch.utilities.types import STEP_OUTPUT
37-
from torch.optim.lr_scheduler import LRScheduler
35+
from lightning.pytorch.utilities.types import STEP_OUTPUT, OptimizerLRScheduler
3836
from torchvision.transforms.v2 import Compose, Normalize, Resize
3937

4038
from anomalib import LearningType
@@ -196,13 +194,13 @@ def configure_pre_processor(cls, image_size: tuple[int, int] | None = None) -> P
196194
])
197195
return PreProcessor(transform=transform)
198196

199-
def configure_optimizers(self) -> tuple[list[LightningOptimizer], list[LRScheduler]]:
197+
def configure_optimizers(self) -> OptimizerLRScheduler:
200198
"""Configure optimizers and learning rate schedulers.
201199
202200
Returns:
203-
tuple[list[LightningOptimizer], list[LRScheduler]]: Tuple containing:
204-
- List of optimizers (Adam with initial lr=1e-3)
205-
- List of schedulers (LinearLR reducing to 0.4 over 25000 steps)
201+
OptimizerLRScheduler: Dictionary containing:
202+
- ``optimizer``: Adam with initial lr=1e-3
203+
- ``lr_scheduler``: LinearLR reducing to 0.4 over 25000 steps
206204
"""
207205
# Optimizer
208206
# values used in paper: bottle: 0.0001128999, cable: 0.0016160391, capsule: 0.0012118892, carpet: 0.0012118892,
@@ -218,7 +216,13 @@ def configure_optimizers(self) -> tuple[list[LightningOptimizer], list[LRSchedul
218216
end_factor=0.4,
219217
total_iters=25000,
220218
)
221-
return [optimizer], [scheduler]
219+
return {
220+
"optimizer": optimizer,
221+
"lr_scheduler": {
222+
"scheduler": scheduler,
223+
"interval": "step",
224+
},
225+
}
222226

223227
def training_step(self, batch: Batch, *args, **kwargs) -> STEP_OUTPUT: # noqa: ARG002 | unused arguments
224228
"""Perform a training step.

‎src/anomalib/models/image/uninet/lightning_model.py‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
"""Lightning model for UniNet."""
22

3-
# Copyright (C) 2025 Intel Corporation
3+
# Copyright (C) 2025-2026 Intel Corporation
44
# SPDX-License-Identifier: Apache-2.0
55

66
from typing import Any
77

88
import torch
9-
from lightning.pytorch.utilities.types import STEP_OUTPUT
9+
from lightning.pytorch.utilities.types import STEP_OUTPUT, OptimizerLRScheduler
1010
from torch.optim.lr_scheduler import MultiStepLR
1111

1212
from anomalib import LearningType
@@ -73,11 +73,11 @@ def validation_step(self, batch: Batch, *args, **kwargs) -> STEP_OUTPUT:
7373
predictions = self.model(batch.image)
7474
return batch.update(**predictions._asdict())
7575

76-
def configure_optimizers(self) -> tuple[torch.optim.Optimizer, torch.optim.Optimizer]:
76+
def configure_optimizers(self) -> OptimizerLRScheduler:
7777
"""Configure optimizers for training.
7878
7979
Returns:
80-
tuple[torch.optim.Optimizer, torch.optim.Optimizer]: Optimizers for student and target teacher.
80+
OptimizerLRScheduler: Dictionary containing optimizer for student and target teacher.
8181
"""
8282
optimizer = torch.optim.AdamW(
8383
[
@@ -92,11 +92,19 @@ def configure_optimizers(self) -> tuple[torch.optim.Optimizer, torch.optim.Optim
9292
eps=1e-10,
9393
amsgrad=True,
9494
)
95+
is_step_based = self.trainer.max_steps is not None and self.trainer.max_steps > 0
9596
milestones = [
96-
int(self.trainer.max_steps * 0.8) if self.trainer.max_steps != -1 else (self.trainer.max_epochs * 0.8),
97+
int(self.trainer.max_steps * 0.8) if is_step_based else int(self.trainer.max_epochs * 0.8),
9798
]
9899
scheduler = MultiStepLR(optimizer, milestones=milestones, gamma=0.2)
99-
return [optimizer], [scheduler]
100+
interval = "step" if is_step_based else "epoch"
101+
return {
102+
"optimizer": optimizer,
103+
"lr_scheduler": {
104+
"scheduler": scheduler,
105+
"interval": interval,
106+
},
107+
}
100108

101109
@property
102110
def trainer_arguments(self) -> dict[str, Any]:

‎tests/unit/engine/test_engine.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
import pytest
99
import yaml
10+
from lightning.pytorch.callbacks import LearningRateMonitor
11+
from lightning.pytorch.loggers import CSVLogger
1012

1113
from anomalib.data import MVTecAD
1214
from anomalib.engine import Engine
@@ -115,3 +117,15 @@ def test_from_config(fxt_full_config_path: Path) -> None:
115117
_, _, datamodule = Engine.from_config(config_path=fxt_full_config_path, **override_kwargs)
116118
assert datamodule.train_batch_size == 1
117119
assert datamodule.num_workers == 1
120+
121+
@staticmethod
122+
def test_learning_rate_monitor_callback(tmp_path: Path) -> None:
123+
"""Test that LearningRateMonitor is automatically added when a logger is configured."""
124+
model = Padim()
125+
engine_no_logger = Engine(logger=False)
126+
engine_no_logger._setup_trainer(model) # noqa: SLF001
127+
assert not any(isinstance(c, LearningRateMonitor) for c in engine_no_logger.trainer.callbacks)
128+
129+
engine_with_logger = Engine(logger=CSVLogger(save_dir=str(tmp_path)))
130+
engine_with_logger._setup_trainer(model) # noqa: SLF001
131+
assert any(isinstance(c, LearningRateMonitor) for c in engine_with_logger.trainer.callbacks)

0 commit comments

Comments
 (0)