Rename Lightning Fabric CLI #19442

justusschock · 2024-02-09T16:52:46Z

What does this PR do?

Renames the lightning fabric CLI (previously part of the lightning app cli) to just fabric for now.
This allows us to start with a fresh studio cli

Fixes #<issue_number>

Before submitting

Was this discussed/agreed via a GitHub issue? (not for typos and docs)
Did you read the contributor guideline, Pull Request section?
Did you make sure your PR does only one thing, instead of bundling different changes together?
Did you make sure to update the documentation with your changes? (if necessary)
Did you write any new necessary tests? (not for typos and docs)
Did you verify new and existing tests pass locally with your changes?
Did you list all the breaking changes introduced by this pull request?
Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist

Is this pull request ready for review? (if not, please submit in draft mode)
Check that all items from Before submitting are resolved
Make sure the title is self-explanatory and the description concisely explains the PR
Add labels and milestones (and optionally projects) to the PR so it can be classified

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

cc @Borda @carmocca @justusschock @awaelchli

github-actions · 2024-02-09T16:54:34Z

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow

Check ID	Status
pl-cpu (macOS-11, lightning, 3.8, 1.13, oldest)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
pl-cpu (macOS-11, lightning, 3.10, 2.1)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.13, oldest)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 2.1)	success	✅
pl-cpu (windows-2022, lightning, 3.8, 1.13, oldest)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 2.1)	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 (macOS-12, pytorch, 3.11, 2.1)	success	✅
pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.0)	success	✅
pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.1)	success	✅
pl-cpu (windows-2022, pytorch, 3.11, 2.0)	success	✅
pl-cpu (windows-2022, pytorch, 3.11, 2.1)	success	✅

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

🟢 pytorch_lightning: Benchmarks

Check ID	Status
lightning.Benchmarks	success	✅

These checks are required after the changes to src/lightning/fabric/cli.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/cli.py, src/lightning_fabric/__setup__.py, docs/source-fabric/fundamentals/launch.rst.

🟢 lightning_data: CPU workflow

Check ID	Status
data-cpu (macOS-11, lightning, 3.10, 2.1)	success	✅
data-cpu (ubuntu-20.04, lightning, 3.10, 2.1)	success	✅
data-cpu (windows-2022, lightning, 3.10, 2.1)	success	✅

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

🟢 lightning_fabric: CPU workflow

Check ID	Status
fabric-cpu (macOS-11, lightning, 3.8, 1.13, oldest)	success	✅
fabric-cpu (macOS-11, lightning, 3.10, 1.13)	success	✅
fabric-cpu (macOS-11, lightning, 3.11, 2.1)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.8, 1.13, oldest)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.1)	success	✅
fabric-cpu (windows-2022, lightning, 3.8, 1.13, oldest)	success	✅
fabric-cpu (windows-2022, lightning, 3.10, 1.13)	success	✅
fabric-cpu (windows-2022, lightning, 3.11, 2.1)	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 (macOS-12, fabric, 3.11, 2.1)	success	✅
fabric-cpu (ubuntu-22.04, fabric, 3.11, 2.0)	success	✅
fabric-cpu (ubuntu-22.04, fabric, 3.11, 2.1)	success	✅
fabric-cpu (windows-2022, fabric, 3.11, 2.0)	success	✅
fabric-cpu (windows-2022, fabric, 3.11, 2.1)	success	✅

These checks are required after the changes to src/lightning/fabric/cli.py, src/lightning_fabric/__setup__.py, tests/tests_fabric/test_cli.py.

🟢 lightning_fabric: Azure GPU

Check ID	Status
lightning-fabric (GPUs) (testing Fabric \| latest)	success	✅
lightning-fabric (GPUs) (testing Lightning \| latest)	success	✅

These checks are required after the changes to src/lightning/__setup__.py, src/lightning/fabric/cli.py, src/lightning_fabric/__setup__.py, tests/tests_fabric/test_cli.py.

🟢 lightning: Store

Check ID	Status
store-cpu (macOS-11, lightning, 3.10, 2.0)	success	✅
store-cpu (ubuntu-20.04, lightning, 3.10, 2.0)	success	✅
store-cpu (windows-2022, lightning, 3.10, 2.0)	success	✅

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

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/__setup__.py, src/lightning/fabric/cli.py, src/lightning_fabric/__setup__.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/__setup__.py, src/lightning/fabric/cli.py, src/lightning_fabric/__setup__.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 · 2024-02-09T17:09:55Z

Codecov Report

Merging #19442 (b8506f0) into master (47c8f4c) will decrease coverage by 16%.
The diff coverage is 47%.

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #19442     +/-   ##
=========================================
- Coverage      82%      66%    -16%     
=========================================
  Files         452      447      -5     
  Lines       38118    38038     -80     
=========================================
- Hits        31258    25183   -6075     
- Misses       6860    12855   +5995

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

lantiga · 2024-02-11T13:54:02Z

~~fabric is an executable Python module already https://www.fabfile.org/~~
~~They are unlikely to clash since their domains are very different but calling that out.~~

No actually I take it back: the cli for that package is fab, my bad.

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

src/lightning/fabric/cli.py

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jirka Borovec <[email protected]> (cherry picked from commit 2ed7282)

update

be1e9d6

justusschock requested review from Borda, carmocca, awaelchli, lantiga and tchaton as code owners February 9, 2024 16:52

github-actions bot added docs Documentation related fabric lightning.fabric.Fabric package labels Feb 9, 2024

update

da2866c

mergify bot added the has conflicts label Feb 9, 2024

Merge branch 'master' into rename_fabric_cli

e7f2c99

mergify bot removed the has conflicts label Feb 9, 2024

pre-commit-ci bot and others added 2 commits February 9, 2024 16:55

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

77b057a

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

changelog

40b757e

Borda approved these changes Feb 9, 2024

View reviewed changes

justusschock and others added 4 commits February 9, 2024 17:13

update

72f2531

update

39bb0b3

update

9bdfe1b

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

e60bb0e

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

awaelchli added this to the 2.3 milestone Feb 9, 2024

typo

00c0ac4

justusschock and others added 5 commits February 12, 2024 08:41

update legacy cli

8905f03

update

fc86cb8

update

884cf20

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

8bc59a8

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

update

9e1179d

update

286509d

justusschock modified the milestones: 2.3, 2.2.x Feb 12, 2024

ethanwharris approved these changes Feb 12, 2024

View reviewed changes

mergify bot added the ready PRs ready to be merged label Feb 12, 2024

Merge branch 'master' into rename_fabric_cli

cb4874b

Borda mentioned this pull request Feb 12, 2024

Minor correction release 2.2.0.post [rebase & merge] #19450

Merged

7 tasks

awaelchli approved these changes Feb 12, 2024

View reviewed changes

src/lightning/fabric/cli.py Outdated Show resolved Hide resolved

src/lightning/fabric/cli.py Outdated Show resolved Hide resolved

src/lightning/fabric/cli.py Outdated Show resolved Hide resolved

justusschock added 2 commits February 12, 2024 11:02

remove subprocess invocation

24594c8

update

1799bb4

awaelchli reviewed Feb 12, 2024

View reviewed changes

src/lightning/fabric/cli.py Show resolved Hide resolved

justusschock added 3 commits February 12, 2024 11:23

update

5fce6ac

update

9efefa9

update

b8506f0

Borda mentioned this pull request Feb 12, 2024

WIP Expected — Waiting for status to be reported wip/app#660

Closed

justusschock merged commit 2ed7282 into master Feb 12, 2024
117 checks passed

justusschock deleted the rename_fabric_cli branch February 12, 2024 16:22

awaelchli mentioned this pull request Feb 25, 2024

Rename fabric run model to fabric run #19527

Merged

awaelchli added the breaking change Includes a breaking change label Feb 25, 2024

awaelchli mentioned this pull request Mar 1, 2024

[Rebase & Merge] Patch release 2.2.1 #19552

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename Lightning Fabric CLI #19442

Rename Lightning Fabric CLI #19442

justusschock commented Feb 9, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Feb 9, 2024 •

edited

Loading

codecov bot commented Feb 9, 2024 •

edited

Loading

lantiga commented Feb 11, 2024 •

edited

Loading

Rename Lightning Fabric CLI #19442

Rename Lightning Fabric CLI #19442

Conversation

justusschock commented Feb 9, 2024 • edited by github-actions bot Loading

What does this PR do?

PR review

github-actions bot commented Feb 9, 2024 • edited Loading

⚡ Required checks status: All passing 🟢

Groups summary

codecov bot commented Feb 9, 2024 • edited Loading

Codecov Report

lantiga commented Feb 11, 2024 • edited Loading

justusschock commented Feb 9, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Feb 9, 2024 •

edited

Loading

codecov bot commented Feb 9, 2024 •

edited

Loading

lantiga commented Feb 11, 2024 •

edited

Loading