Revert breaking change in configure_optimizers return type

[lantiga]

What does this PR do?

Fixes #20511
Partially fixes #2484

---

📚 Documentation preview 📚: https://pytorch-lightning--20512.org.readthedocs.build/en/20512/

[github-actions]

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow

Check ID	Status
pl-cpu (macOS-14, lightning, 3.9, 2.1, oldest)	success	✅
pl-cpu (macOS-14, lightning, 3.10, 2.1)	success	✅
pl-cpu (macOS-14, lightning, 3.11, 2.2.2)	success	✅
pl-cpu (macOS-14, lightning, 3.11, 2.3)	success	✅
pl-cpu (macOS-14, lightning, 3.12, 2.4.1)	success	✅
pl-cpu (macOS-14, lightning, 3.12, 2.5.1)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 2.1, oldest)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.1)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.11, 2.2.2)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.11, 2.3)	success	✅
pl-cpu (ubuntu-22.04, lightning, 3.12, 2.4.1)	success	✅
pl-cpu (ubuntu-22.04, lightning, 3.12, 2.5.1)	success	✅
pl-cpu (windows-2022, lightning, 3.9, 2.1, oldest)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 2.1)	success	✅
pl-cpu (windows-2022, lightning, 3.11, 2.2.2)	success	✅
pl-cpu (windows-2022, lightning, 3.11, 2.3)	success	✅
pl-cpu (windows-2022, lightning, 3.12, 2.4.1)	success	✅
pl-cpu (windows-2022, lightning, 3.12, 2.5.1)	success	✅
pl-cpu (macOS-14, pytorch, 3.9, 2.1)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.9, 2.1)	success	✅
pl-cpu (windows-2022, pytorch, 3.9, 2.1)	success	✅
pl-cpu (macOS-14, pytorch, 3.12, 2.5.1)	success	✅
pl-cpu (ubuntu-22.04, pytorch, 3.12, 2.5.1)	success	✅
pl-cpu (windows-2022, pytorch, 3.12, 2.5.1)	success	✅

These checks are required after the changes to src/lightning/pytorch/utilities/types.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs) (testing Lightning | latest)	success	✅
pytorch-lightning (GPUs) (testing PyTorch | latest)	success	✅

These checks are required after the changes to src/lightning/pytorch/utilities/types.py.

🟢 pytorch_lightning: Benchmarks

Check ID	Status
lightning.Benchmarks	success	✅

These checks are required after the changes to src/lightning/pytorch/utilities/types.py.

🟢 pytorch_lightning: Docs

Check ID	Status
docs-make (pytorch, doctest)	success	✅
docs-make (pytorch, html)	success	✅

These checks are required after the changes to src/lightning/pytorch/utilities/types.py, docs/source-pytorch/conf.py.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/pytorch/utilities/types.py.

🟢 install

Check ID	Status
install-pkg (ubuntu-22.04, fabric, 3.9)	success	✅
install-pkg (ubuntu-22.04, fabric, 3.11)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.9)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.11)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.9)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.11)	success	✅
install-pkg (ubuntu-22.04, notset, 3.9)	success	✅
install-pkg (ubuntu-22.04, notset, 3.11)	success	✅
install-pkg (macOS-14, fabric, 3.9)	success	✅
install-pkg (macOS-14, fabric, 3.11)	success	✅
install-pkg (macOS-14, pytorch, 3.9)	success	✅
install-pkg (macOS-14, pytorch, 3.11)	success	✅
install-pkg (macOS-14, lightning, 3.9)	success	✅
install-pkg (macOS-14, lightning, 3.11)	success	✅
install-pkg (macOS-14, notset, 3.9)	success	✅
install-pkg (macOS-14, notset, 3.11)	success	✅
install-pkg (windows-2022, fabric, 3.9)	success	✅
install-pkg (windows-2022, fabric, 3.11)	success	✅
install-pkg (windows-2022, pytorch, 3.9)	success	✅
install-pkg (windows-2022, pytorch, 3.11)	success	✅
install-pkg (windows-2022, lightning, 3.9)	success	✅
install-pkg (windows-2022, lightning, 3.11)	success	✅
install-pkg (windows-2022, notset, 3.9)	success	✅
install-pkg (windows-2022, notset, 3.11)	success	✅

These checks are required after the changes to src/lightning/pytorch/utilities/types.py.

---

Thank you for your contribution! 💜

Note
This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79%. Comparing base (c45c3c9) to head (cd406cd).
Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (c45c3c9) and HEAD (cd406cd). Click for more details.

HEAD has 108 uploads less than BASE

Flag	BASE (c45c3c9)	HEAD (cd406cd)
cpu	48	24
lightning	38	18
pytest	28	0
python3.9	12	6
python3.10	6	3
lightning_fabric	8	0
python3.11	12	6
python3.12	18	9
gpu	4	0

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #20512     +/-   ##
=========================================
- Coverage      88%      79%     -9%     
=========================================
  Files         267      264      -3     
  Lines       23386    23331     -55     
=========================================
- Hits        20487    18372   -2115     
- Misses       2899     4959   +2060