Remove deprecate method and attirbute in `LRScheduler` #147301

zeshengzong · 2025-02-17T03:21:10Z

Following #99270 suggestion, remove deprecate method LRScheduler.print_lr

BC-breaking note

LRScheduler.print_lr() along with the verbose kwarg to the LRScheduler constructor has been deprecated since release 2.2. Please use LRScheduler.get_last_lr() to access the learning rate instead.

print_lr and verbose were confusing, not properly documented and were little used, as described in #99270, so we deprecated them in 2.2. Now, we complete the deprecation by removing them completely. To access and print the learning rate of a LRScheduler:

In 2.6.0

optim = ...
lrsched = torch.optim.lr_scheduler.ReduceLROnPlateau(optim, verbose=True)
// lrsched will internally call print_lr

In 2.7.0

optim = ...
lrsched = torch.optim.lr_scheduler.ReduceLROnPlateau(optim)
print(lrsched.get_last_lr())

pytorch-bot · 2025-02-17T03:21:14Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/147301

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

Note: Links to docs will display an error until the docs builds have been completed.

✅ You can merge normally! (1 Unrelated Failure)

As of commit b3e60f4 with merge base 3ca1a25 ():

FLAKY - The following job failed but was likely due to flakiness present on trunk:

BC Lint / bc_linter (gh) (suppressed by suppress-bc-linter)
Process completed with exit code 1.

This comment was automatically generated by Dr. CI and updates every 15 minutes.

vadimkantorov · 2025-02-17T10:33:13Z

I wonder if self.verbose field there can also be removed, it's passed quite a long time since its deprecation

janeyx99 · 2025-02-18T19:23:31Z

Thanks for following up on this--yes let's remove everything associated with this deprecation, including the verbose param

zeshengzong · 2025-02-19T03:41:37Z

Should remove epoch in step method as well?

pytorch/torch/optim/lr_scheduler.py

Lines 208 to 255 in bd370c1

    
           def step(self, epoch: Optional[int] = None): 
        
               """Perform a step.""" 
        
               # Raise a warning if old pattern is detected 
        
               # https://github.com/pytorch/pytorch/issues/20124 
        
               if self._step_count == 1: 
        
                   if not hasattr(self.optimizer.step, "_wrapped_by_lr_sched"): 
        
                       warnings.warn( 
        
                           "Seems like `optimizer.step()` has been overridden after learning rate scheduler " 
        
                           "initialization. Please, make sure to call `optimizer.step()` before " 
        
                           "`lr_scheduler.step()`. See more details at " 
        
                           "https://pytorch.org/docs/stable/optim.html#how-to-adjust-learning-rate", 
        
                           UserWarning, 
        
                       ) 
        
                   # Just check if there were two first lr_scheduler.step() calls before optimizer.step() 
        
                   elif not getattr(self.optimizer, "_opt_called", False): 
        
                       warnings.warn( 
        
                           "Detected call of `lr_scheduler.step()` before `optimizer.step()`. " 
        
                           "In PyTorch 1.1.0 and later, you should call them in the opposite order: " 
        
                           "`optimizer.step()` before `lr_scheduler.step()`.  Failure to do this " 
        
                           "will result in PyTorch skipping the first value of the learning rate schedule. " 
        
                           "See more details at " 
        
                           "https://pytorch.org/docs/stable/optim.html#how-to-adjust-learning-rate", 
        
                           UserWarning, 
        
                       ) 
        
               self._step_count += 1 
        
               with _enable_get_lr_call(self): 
        
                   if epoch is None: 
        
                       self.last_epoch += 1 
        
                       values = self.get_lr() 
        
                   else: 
        
                       warnings.warn(EPOCH_DEPRECATION_WARNING, UserWarning) 
        
                       self.last_epoch = epoch 
        
                       if hasattr(self, "_get_closed_form_lr"): 
        
                           values = cast(list[float], self._get_closed_form_lr()) 
        
                       else: 
        
                           values = self.get_lr() 
        
               for param_group, lr in zip(self.optimizer.param_groups, values): 
        
                   if isinstance(param_group["lr"], Tensor): 
        
                       param_group["lr"].fill_(lr) 
        
                   else: 
        
                       param_group["lr"] = lr 
        
               self._last_lr: list[float] = [ 
        
                   group["lr"] for group in self.optimizer.param_groups 
        
               ]

zeshengzong · 2025-03-03T08:02:45Z

@janeyx99 Hi, please check changes when available, thanks!

janeyx99 · 2025-03-03T21:33:31Z

Should remove epoch in step method as well?

no this one is harder to remove

janeyx99

thanks!

janeyx99 · 2025-03-03T21:34:40Z

@pytorchbot merge -r

pytorchmergebot · 2025-03-03T21:36:14Z

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

pytorchmergebot · 2025-03-03T21:36:16Z

Successfully rebased opt/deprecate/LRScheduler onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via git checkout opt/deprecate/LRScheduler && git pull --rebase)

pytorchmergebot · 2025-03-03T21:37:36Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

pytorchmergebot · 2025-03-03T21:37:52Z

Merge failed

Reason: 3 mandatory check(s) failed. The first few are:

Dig deeper by viewing the failures on hud

Details for Dev Infra team

Raised by workflow job

Failing merge rule: Core Maintainers

zeshengzong · 2025-03-04T06:21:18Z

Seems need help skip BC Lint check, thanks! @janeyx99

zeshengzong · 2025-03-05T01:24:54Z

@pytorchbot merge

pytorchmergebot · 2025-03-05T01:26:34Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging

Check the merge workflow status
here

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

The verbose flag was deprecated in torch 2.2 and removed in 2.7. See: pytorch/pytorch#147301

pytorch-bot bot added the release notes: optim label Feb 17, 2025

pytorchbot added the open source label Feb 17, 2025

zeshengzong marked this pull request as ready for review February 17, 2025 06:49

zeshengzong requested review from albanD and janeyx99 as code owners February 17, 2025 06:49

janeyx99 added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Feb 18, 2025

zeshengzong changed the title ~~Remove deprecate method LRScheduler.print_lr~~ Remove deprecate method and attirbute in LRScheduler Feb 19, 2025

janeyx99 approved these changes Mar 3, 2025

View reviewed changes

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Mar 3, 2025

zeshengzong added 2 commits March 3, 2025 21:36

Remove deprecate method LRScheduler.print_lr

f3d8a1a

Remove deprecate attribute LRScheduler.verbose

b3e60f4

pytorchmergebot force-pushed the opt/deprecate/LRScheduler branch from f3a2951 to b3e60f4 Compare March 3, 2025 21:36

pytorch-bot bot removed the ciflow/trunk Trigger trunk jobs on your pull request label Mar 3, 2025

pytorchmergebot added the merging label Mar 3, 2025

pytorchmergebot removed the merging label Mar 3, 2025

janeyx99 added the suppress-bc-linter Suppresses the failures of API backward-compatibility linter (Lint/bc_linter) label Mar 4, 2025

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Mar 5, 2025

pytorchmergebot added the merging label Mar 5, 2025

pytorchmergebot added the Merged label Mar 5, 2025

pytorchmergebot closed this in fb1b7ec Mar 5, 2025

pytorchmergebot removed the merging label Mar 5, 2025

zeshengzong deleted the opt/deprecate/LRScheduler branch March 5, 2025 06:34

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 11, 2025

custom_schedule: Remove verbose arg to super().__init__

eacb7f8

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 11, 2025

custom_schedule: Remove verbose arg to super().__init__

901386c

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 11, 2025

custom_schedule: Remove verbose arg to super().__init__

e0d41d7

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 11, 2025

custom_schedule: Remove verbose arg to super().__init__

b49c42b

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 11, 2025

custom_schedule: Remove verbose arg to super().__init__

c9bd14c

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 11, 2025

custom_schedule: Remove verbose arg to super().__init__

303f3ce

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 12, 2025

custom_schedule: Remove verbose arg to super().__init__

e895c2b

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

clayne added a commit to clayne/SimpleTuner that referenced this pull request May 12, 2025

custom_schedule: Remove verbose arg to super().__init__

d28de87

* PyTorch 2.7 removed the deprecated argument entirely: pytorch/pytorch#147301

Uptimolli mentioned this pull request May 12, 2025

ReduceLROnPlateau unexpected keyword argument sb-ai-lab/LightAutoML#173

Open

AdilZouitine mentioned this pull request May 19, 2025

[Fix] Unpin torch beyond 2.6.0 & torchcodec beyond 0.2.1 huggingface/lerobot#1127

Merged

zeshengzong mentioned this pull request May 30, 2025

Improve lr_scheduler epoch type and description #154706

Closed

aywi mentioned this pull request Jun 7, 2025

Fix tests that failed in Python 3.13 when building the conda-forge package pytorch/audio#3923

Open

rfdougherty added a commit to rfdougherty/k-diffusion that referenced this pull request Jul 21, 2025

Remove verbose from torch LRScheduler init

216fe61

The verbose flag was deprecated in torch 2.2 and removed in 2.7. See: pytorch/pytorch#147301

Remove deprecate method and attirbute in LRScheduler #147301

Remove deprecate method and attirbute in LRScheduler #147301

Uh oh!

Conversation

zeshengzong commented Feb 17, 2025 • edited by janeyx99 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

BC-breaking note

Uh oh!

pytorch-bot bot commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/147301

✅ You can merge normally! (1 Unrelated Failure)

Uh oh!

vadimkantorov commented Feb 17, 2025

Uh oh!

janeyx99 commented Feb 18, 2025

Uh oh!

zeshengzong commented Feb 19, 2025

Uh oh!

zeshengzong commented Mar 3, 2025

Uh oh!

janeyx99 commented Mar 3, 2025

Uh oh!

janeyx99 left a comment

Choose a reason for hiding this comment

Uh oh!

janeyx99 commented Mar 3, 2025

Uh oh!

pytorchmergebot commented Mar 3, 2025

Uh oh!

pytorchmergebot commented Mar 3, 2025

Uh oh!

pytorchmergebot commented Mar 3, 2025

Merge started

Uh oh!

pytorchmergebot commented Mar 3, 2025

Merge failed

Uh oh!

zeshengzong commented Mar 4, 2025

Uh oh!

zeshengzong commented Mar 5, 2025

Uh oh!

pytorchmergebot commented Mar 5, 2025

Merge started

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Remove deprecate method and attirbute in `LRScheduler` #147301

Remove deprecate method and attirbute in `LRScheduler` #147301

zeshengzong commented Feb 17, 2025 •

edited by janeyx99

Loading

pytorch-bot bot commented Feb 17, 2025 •

edited

Loading