Validate `Fabric.launched()` was called in `Fabric.init_module()` #18418

awaelchli · 2023-08-28T14:57:43Z

What does this PR do?

Adds a check to init_module that .launch() was called, done similarly for other Fabric methods.
Addresses #18416 (comment)

This change doesn't require a changelog entry since init_module() is new in 2.1.

cc @Borda @carmocca @justusschock @awaelchli

for more information, see https://pre-commit.ci

github-actions · 2023-08-28T16:13:32Z

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow

Check ID	Status
pl-cpu (macOS-11, lightning, 3.8, 1.11)	success	✅
pl-cpu (macOS-11, lightning, 3.9, 1.12)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 2.0)	success	✅
pl-cpu (macOS-11, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 1.12)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.0)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (windows-2022, lightning, 3.8, 1.11)	success	✅
pl-cpu (windows-2022, lightning, 3.9, 1.12)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 2.0)	success	✅
pl-cpu (windows-2022, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (macOS-11, pytorch, 3.8, 1.13)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.13)	success	✅
pl-cpu (windows-2022, pytorch, 3.8, 1.13)	success	✅
pl-cpu (macOS-12, pytorch, 3.11, 2.0)	success	✅
pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.0)	success	✅
pl-cpu (windows-2022, pytorch, 3.11, 2.0)	success	✅

These checks are required after the changes to src/lightning/fabric/fabric.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
[pytorch-lightning (GPUs) (testing Lightning	latest)](https://dev.azure.com/Lightning-AI/72ab7ed8-b00f-4b6e-b131-3388f7ffafa7/_build/results?buildId=172045&view=logs&jobId=47e66f3c-897a-5428-da11-bf5c7745762e)	success
[pytorch-lightning (GPUs) (testing PyTorch	latest)](https://dev.azure.com/Lightning-AI/72ab7ed8-b00f-4b6e-b131-3388f7ffafa7/_build/results?buildId=172045&view=logs&jobId=3f274fac-2e11-54ca-487e-194c91f3ae9f)	success

These checks are required after the changes to src/lightning/fabric/fabric.py.

🟢 pytorch_lightning: Benchmarks

Check ID	Status
lightning.Benchmarks	success	✅

These checks are required after the changes to src/lightning/fabric/fabric.py.

🟢 fabric: Docs

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

These checks are required after the changes to src/lightning/fabric/fabric.py.

🟢 lightning_fabric: CPU workflow

Check ID	Status
fabric-cpu (macOS-11, lightning, 3.8, 1.11)	success	✅
fabric-cpu (macOS-11, lightning, 3.9, 1.12)	success	✅
fabric-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
fabric-cpu (macOS-11, lightning, 3.10, 2.0)	success	✅
fabric-cpu (macOS-11, lightning, 3.8, 1.11, oldest)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.8, 1.11)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.9, 1.12)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.10, 2.0)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest)	success	✅
fabric-cpu (windows-2022, lightning, 3.8, 1.11)	success	✅
fabric-cpu (windows-2022, lightning, 3.9, 1.12)	success	✅
fabric-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
fabric-cpu (windows-2022, lightning, 3.10, 2.0)	success	✅
fabric-cpu (windows-2022, lightning, 3.8, 1.11, oldest)	success	✅
fabric-cpu (macOS-11, fabric, 3.8, 1.13)	success	✅
fabric-cpu (ubuntu-20.04, fabric, 3.8, 1.13)	success	✅
fabric-cpu (windows-2022, fabric, 3.8, 1.13)	success	✅
fabric-cpu (macOS-12, fabric, 3.11, 2.0)	success	✅
fabric-cpu (ubuntu-22.04, fabric, 3.11, 2.0)	success	✅
fabric-cpu (windows-2022, fabric, 3.11, 2.0)	success	✅

These checks are required after the changes to src/lightning/fabric/fabric.py, tests/tests_fabric/test_fabric.py.

🟢 lightning_fabric: Azure GPU

Check ID	Status
[lightning-fabric (GPUs) (testing Fabric	latest)](https://dev.azure.com/Lightning-AI/72ab7ed8-b00f-4b6e-b131-3388f7ffafa7/_build/results?buildId=172047&view=logs&jobId=fe777007-6e77-5e50-6e71-fc5977ab193a)	success
[lightning-fabric (GPUs) (testing Lightning	latest)](https://dev.azure.com/Lightning-AI/72ab7ed8-b00f-4b6e-b131-3388f7ffafa7/_build/results?buildId=172047&view=logs&jobId=47e66f3c-897a-5428-da11-bf5c7745762e)	success

These checks are required after the changes to src/lightning/fabric/fabric.py, tests/tests_fabric/test_fabric.py.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/fabric/fabric.py.

🟢 install

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

These checks are required after the changes to src/lightning/fabric/fabric.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.

for more information, see https://pre-commit.ci

codecov · 2023-08-28T17:15:15Z

Codecov Report

Merging #18418 (5cdb6de) into master (5f5d99e) will decrease coverage by 31%.
The diff coverage is 100%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #18418      +/-   ##
==========================================
- Coverage      85%      54%     -31%     
==========================================
  Files         427      422       -5     
  Lines       33212    33123      -89     
==========================================
- Hits        28245    17992   -10253     
- Misses       4967    15131   +10164

tests/tests_fabric/test_fabric.py

validate launched

aa73158

github-actions bot added the fabric lightning.fabric.Fabric label Aug 28, 2023

awaelchli mentioned this pull request Aug 28, 2023

Add dedicated docs page for init-module #18416

Merged

7 tasks

carmocca approved these changes Aug 28, 2023

View reviewed changes

awaelchli and others added 2 commits August 28, 2023 18:10

add test

ebe06ef

[pre-commit.ci] auto fixes from pre-commit.com hooks

80d8604

for more information, see https://pre-commit.ci

awaelchli marked this pull request as ready for review August 28, 2023 16:12

awaelchli requested a review from justusschock as a code owner August 28, 2023 16:12

Merge branch 'master' into feature/validate-launched-on-init-module

c6f58ca

awaelchli added this to the 2.1 milestone Aug 28, 2023

awaelchli added the feature Is an improvement or enhancement label Aug 28, 2023

awaelchli and others added 2 commits August 28, 2023 19:02

fix test

7ed3f36

[pre-commit.ci] auto fixes from pre-commit.com hooks

5cdb6de

for more information, see https://pre-commit.ci

awaelchli requested a review from Borda August 29, 2023 09:18

Borda approved these changes Aug 29, 2023

View reviewed changes

tests/tests_fabric/test_fabric.py Outdated Show resolved Hide resolved

mergify bot added the ready PRs ready to be merged label Aug 29, 2023

awaelchli added 3 commits August 29, 2023 18:49

chlog fixes

7ecce24

Merge branch 'master' into feature/validate-launched-on-init-module

cf0e75c

add comment

f1e3d15

awaelchli requested a review from williamFalcon as a code owner August 29, 2023 16:50

github-actions bot added the pl Generic label for PyTorch Lightning package label Aug 29, 2023

awaelchli merged commit 3ebcd2d into master Aug 29, 2023

awaelchli deleted the feature/validate-launched-on-init-module branch August 29, 2023 20:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Validate `Fabric.launched()` was called in `Fabric.init_module()` #18418

Validate `Fabric.launched()` was called in `Fabric.init_module()` #18418

Uh oh!

awaelchli commented Aug 28, 2023 •

edited by github-actions bot

Loading

Uh oh!

github-actions bot commented Aug 28, 2023 •

edited

Loading

Uh oh!

codecov bot commented Aug 28, 2023 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Validate Fabric.launched() was called in Fabric.init_module() #18418

Validate Fabric.launched() was called in Fabric.init_module() #18418

Uh oh!

Conversation

awaelchli commented Aug 28, 2023 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Uh oh!

github-actions bot commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚡ Required checks status: All passing 🟢

Groups summary

Uh oh!

codecov bot commented Aug 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Validate `Fabric.launched()` was called in `Fabric.init_module()` #18418

Validate `Fabric.launched()` was called in `Fabric.init_module()` #18418

awaelchli commented Aug 28, 2023 •

edited by github-actions bot

Loading

github-actions bot commented Aug 28, 2023 •

edited

Loading

codecov bot commented Aug 28, 2023 •

edited

Loading