Skip to content

Conversation

lantiga
Copy link
Collaborator

@lantiga lantiga commented Dec 10, 2024

What does this PR do?

Follow-up to #20471

  • adopts Type (vs Dict) as a suffix for TypedDict
  • adds classes to nitpick_ignore in autodoc config

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

@github-actions github-actions bot added docs Documentation related pl Generic label for PyTorch Lightning package labels Dec 10, 2024
Copy link
Contributor

github-actions bot commented Dec 10, 2024

⛈️ Required checks status: Has failure 🔴

Warning
This job will need to be re-run to merge your PR. If you do not have write access to the repository, you can ask Lightning-AI/lai-frameworks to re-run it. If you push a new commit, all of CI will re-trigger.

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) failure
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 failure

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.

@lantiga lantiga merged commit ca59e4e into master Dec 10, 2024
68 of 75 checks passed
@lantiga lantiga deleted the luca/configure-optimizer-return-typing-fix branch December 10, 2024 09:46
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79%. Comparing base (64d0d02) to head (465210a).
Report is 40 commits behind head on master.

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

HEAD has 99 uploads less than BASE
Flag BASE (64d0d02) HEAD (465210a)
cpu 48 24
lightning 36 18
pytest 25 0
python3.9 12 6
lightning_fabric 7 0
python3.10 6 3
python3.11 12 6
python3.12 18 9
gpu 1 0
Additional details and impacted files
@@            Coverage Diff            @@
##           master   #20486     +/-   ##
=========================================
- Coverage      87%      79%     -8%     
=========================================
  Files         267      264      -3     
  Lines       23287    23232     -55     
=========================================
- Hits        20169    18279   -1890     
- Misses       3118     4953   +1835     
🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related pl Generic label for PyTorch Lightning package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant