Deprecate `auto_select_gpus` #16147

awaelchli · 2022-12-20T23:07:26Z

What does this PR do?

Fixes #13079
Fixes #10535
Alternative to #13356

Before

# Picks the first two available GPUs
Trainer(devices=2, auto_select_gpus=True)

After

# Picks the first two available GPUs
from pytorch_lightning.accelerators import find_usable_cuda_gpus

Trainer(devices=find_usable_cuda_gpus)

Before submitting

Was this discussed/approved 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 update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

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

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

Did you have fun?

I made sure I had fun coding 🙃

cc @tchaton @justusschock @awaelchli @Borda

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

…pus-2' into refactor/deprecate-auto-select-gpus-2

carmocca

Early review

docs/source-pytorch/common/trainer.rst

docs/source-pytorch/accelerators/gpu_basic.rst

src/lightning_lite/accelerators/__init__.py

src/lightning_lite/accelerators/cuda.py

src/pytorch_lightning/trainer/connectors/accelerator_connector.py

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

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

…pus-2' into refactor/deprecate-auto-select-gpus-2

github-actions · 2022-12-21T01:26:08Z

⚡ Required checks status: All passing 🟢

Groups summary

🟢 pytorch_lightning: Tests workflow

Check ID	Status
pl-cpu (macOS-11, pytorch, 3.8, 1.11)	success	✅
pl-cpu (macOS-11, pytorch, 3.9, 1.12)	success	✅
pl-cpu (macOS-11, pytorch, 3.10, 1.13)	success	✅
pl-cpu (macOS-11, pytorch, 3.8, 1.10, oldest)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.10)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.9, 1.11)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.12)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.13)	success	✅
pl-cpu (ubuntu-20.04, pytorch, 3.7, 1.10, oldest)	success	✅
pl-cpu (windows-2022, pytorch, 3.9, 1.11)	success	✅
pl-cpu (windows-2022, pytorch, 3.10, 1.12)	success	✅
pl-cpu (windows-2022, pytorch, 3.10, 1.13)	success	✅
pl-cpu (windows-2022, pytorch, 3.7, 1.10, oldest)	success	✅
pl-cpu (slow, macOS-11, pytorch, 3.7, 1.11)	success	✅
pl-cpu (slow, ubuntu-20.04, pytorch, 3.7, 1.11)	success	✅
pl-cpu (slow, windows-2022, pytorch, 3.7, 1.11)	success	✅
pl-cpu (macOS-11, lightning, 3.8, 1.13)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.13)	success	✅
pl-cpu (windows-2022, lightning, 3.8, 1.13)	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.py, tests/tests_pytorch/deprecated_api/test_remove_1-10.py, tests/tests_pytorch/trainer/properties/test_auto_gpu_select.py, tests/tests_pytorch/trainer/test_trainer.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs)	success	✅

These checks are required after the changes to src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.py, tests/tests_pytorch/deprecated_api/test_remove_1-10.py, tests/tests_pytorch/trainer/properties/test_auto_gpu_select.py, tests/tests_pytorch/trainer/test_trainer.py, src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py.

🟢 pytorch_lightning: Azure HPU

Check ID	Status
pytorch-lightning (HPUs)	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.py, tests/tests_pytorch/deprecated_api/test_remove_1-10.py, tests/tests_pytorch/trainer/properties/test_auto_gpu_select.py, tests/tests_pytorch/trainer/test_trainer.py.

🟢 pytorch_lightning: Azure IPU

Check ID	Status
pytorch-lightning (IPUs)	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.py, tests/tests_pytorch/deprecated_api/test_remove_1-10.py, tests/tests_pytorch/trainer/properties/test_auto_gpu_select.py, tests/tests_pytorch/trainer/test_trainer.py.

🟢 pytorch_lightning: Docs

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

These checks are required after the changes to src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.py, docs/source-pytorch/accelerators/gpu_basic.rst, docs/source-pytorch/common/trainer.rst.

🟢 lightning_lite: CPU workflow

Check ID	Status
lite-cpu (macOS-11, lite, 3.8, 1.11)	success	✅
lite-cpu (macOS-11, lite, 3.9, 1.12)	success	✅
lite-cpu (macOS-11, lite, 3.10, 1.13)	success	✅
lite-cpu (macOS-11, lite, 3.7, 1.10, oldest)	success	✅
lite-cpu (ubuntu-20.04, lite, 3.8, 1.10)	success	✅
lite-cpu (ubuntu-20.04, lite, 3.9, 1.11)	success	✅
lite-cpu (ubuntu-20.04, lite, 3.10, 1.12)	success	✅
lite-cpu (ubuntu-20.04, lite, 3.10, 1.13)	success	✅
lite-cpu (ubuntu-20.04, lite, 3.7, 1.10, oldest)	success	✅
lite-cpu (windows-2022, lite, 3.9, 1.11)	success	✅
lite-cpu (windows-2022, lite, 3.10, 1.12)	success	✅
lite-cpu (windows-2022, lite, 3.10, 1.13)	success	✅
lite-cpu (windows-2022, lite, 3.7, 1.10, oldest)	success	✅
lite-cpu (macOS-11, lightning, 3.8, 1.13)	success	✅
lite-cpu (ubuntu-20.04, lightning, 3.8, 1.13)	success	✅
lite-cpu (windows-2022, lightning, 3.8, 1.13)	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, tests/tests_lite/accelerators/test_cuda.py.

🟢 lightning_lite: Azure GPU

Check ID	Status
lightning-lite (GPUs)	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, tests/tests_lite/accelerators/test_cuda.py.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.py.

🟢 install

Check ID	Status
install-pkg (ubuntu-22.04, app, 3.7)	success	✅
install-pkg (ubuntu-22.04, app, 3.10)	success	✅
install-pkg (ubuntu-22.04, lite, 3.7)	success	✅
install-pkg (ubuntu-22.04, lite, 3.10)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.7)	success	✅
install-pkg (ubuntu-22.04, pytorch, 3.10)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.7)	success	✅
install-pkg (ubuntu-22.04, lightning, 3.10)	success	✅
install-pkg (ubuntu-22.04, notset, 3.7)	success	✅
install-pkg (ubuntu-22.04, notset, 3.10)	success	✅
install-pkg (macOS-12, app, 3.7)	success	✅
install-pkg (macOS-12, app, 3.10)	success	✅
install-pkg (macOS-12, lite, 3.7)	success	✅
install-pkg (macOS-12, lite, 3.10)	success	✅
install-pkg (macOS-12, pytorch, 3.7)	success	✅
install-pkg (macOS-12, pytorch, 3.10)	success	✅
install-pkg (macOS-12, lightning, 3.7)	success	✅
install-pkg (macOS-12, lightning, 3.10)	success	✅
install-pkg (macOS-12, notset, 3.7)	success	✅
install-pkg (macOS-12, notset, 3.10)	success	✅
install-pkg (windows-2022, app, 3.7)	success	✅
install-pkg (windows-2022, app, 3.10)	success	✅
install-pkg (windows-2022, lite, 3.7)	success	✅
install-pkg (windows-2022, lite, 3.10)	success	✅
install-pkg (windows-2022, pytorch, 3.7)	success	✅
install-pkg (windows-2022, pytorch, 3.10)	success	✅
install-pkg (windows-2022, lightning, 3.7)	success	✅
install-pkg (windows-2022, lightning, 3.10)	success	✅
install-pkg (windows-2022, notset, 3.7)	success	✅
install-pkg (windows-2022, notset, 3.10)	success	✅

These checks are required after the changes to src/lightning_lite/accelerators/__init__.py, src/lightning_lite/accelerators/cuda.py, src/lightning_lite/utilities/device_parser.py, src/pytorch_lightning/accelerators/__init__.py, src/pytorch_lightning/trainer/connectors/accelerator_connector.py, src/pytorch_lightning/trainer/trainer.py, src/pytorch_lightning/tuner/auto_gpu_select.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.

carmocca

A CUDA device is a GPU but a GPU might not be a CUDA device (e.g. MPS)

src/lightning_lite/accelerators/cuda.py

From the context, it should hopefully be clear that we are talking about nvidia cuda gpus update error message update

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

awaelchli added 8 commits December 20, 2022 20:56

edge cases

031584f

docs

5e0c93e

update

db87f29

tests

4d85b14

tests

ad061d6

update

23b945e

tests

8422c9e

test

e56ae1b

github-actions bot added the pl Generic label for PyTorch Lightning package label Dec 20, 2022

awaelchli added deprecation Includes a deprecation accelerator: cuda Compute Unified Device Architecture GPU trainer: argument labels Dec 20, 2022

awaelchli added this to the v1.9 milestone Dec 20, 2022

awaelchli added the fun Staff contributions outside working hours - to differentiate from the "community" label label Dec 20, 2022

awaelchli and others added 6 commits December 21, 2022 00:09

Merge branch 'master' into refactor/deprecate-auto-select-gpus-2

a365adc

changelog

895302c

typo

04fc5c1

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

6326905

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

typo

8bee3a0

Merge remote-tracking branch 'origin/refactor/deprecate-auto-select-g…

b2b1d40

…pus-2' into refactor/deprecate-auto-select-gpus-2

carmocca reviewed Dec 20, 2022

View reviewed changes

awaelchli and others added 5 commits December 20, 2022 20:08

Update src/pytorch_lightning/trainer/connectors/accelerator_connector.py

db561e4

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

gpus -> devices

67dda49

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

a457937

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

fix

ab1200e

Merge remote-tracking branch 'origin/refactor/deprecate-auto-select-g…

0750e87

…pus-2' into refactor/deprecate-auto-select-gpus-2

awaelchli marked this pull request as ready for review December 21, 2022 01:25

awaelchli requested review from justusschock, williamFalcon and tchaton as code owners December 21, 2022 01:25

awaelchli requested review from edenlightning and Borda as code owners December 21, 2022 01:25

awaelchli added 4 commits December 21, 2022 02:41

add missing deprecation ctx manger

e603aad

does mypy not like the double underscore?

48e7c2e

remove docs

e56d14a

gpus -> devices

01d0beb

Borda approved these changes Dec 21, 2022

View reviewed changes

Borda requested a review from carmocca December 21, 2022 09:51

justusschock approved these changes Dec 21, 2022

View reviewed changes

mergify bot added the ready PRs ready to be merged label Dec 21, 2022

guard deprecation warning

81657e0

carmocca reviewed Dec 21, 2022

View reviewed changes

awaelchli added 2 commits December 22, 2022 06:14

fix

38e8cb8

cuda gpu devices clarification

6500156

From the context, it should hopefully be clear that we are talking about nvidia cuda gpus update error message update

awaelchli force-pushed the refactor/deprecate-auto-select-gpus-2 branch from 0210d20 to 6500156 Compare December 22, 2022 05:23

awaelchli requested a review from carmocca December 22, 2022 05:25

carmocca approved these changes Dec 22, 2022

View reviewed changes

carmocca merged commit ca88f81 into master Dec 22, 2022

carmocca deleted the refactor/deprecate-auto-select-gpus-2 branch December 22, 2022 16:44

carmocca added a commit that referenced this pull request Dec 22, 2022

Deprecate auto_select_gpus (#16147)

eea8b36

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

carmocca added a commit that referenced this pull request Dec 22, 2022

Deprecate auto_select_gpus (#16147)

098ca31

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

carmocca added a commit that referenced this pull request Dec 22, 2022

Deprecate auto_select_gpus (#16147)

69633eb

Co-authored-by: Carlos Mocholí <carlossmocholi@gmail.com>

awaelchli mentioned this pull request Dec 22, 2022

Remove deprecated auto_select_gpus Trainer argument #16184

Merged

11 tasks

zhiqiangdon mentioned this pull request Feb 16, 2023

[AutoMM] Fix a lightning warning autogluon/autogluon#2937

Merged

simnyatsanga mentioned this pull request Apr 30, 2023

auto_select_gpus is deprecated in Pytorch Lightning 2.0.2 Mathux/TEMOS#29

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `auto_select_gpus` #16147

Deprecate `auto_select_gpus` #16147

awaelchli commented Dec 20, 2022 •

edited by github-actions bot

carmocca left a comment

github-actions bot commented Dec 21, 2022 •

edited

carmocca left a comment

Deprecate auto_select_gpus #16147

Deprecate auto_select_gpus #16147

Conversation

awaelchli commented Dec 20, 2022 • edited by github-actions bot

What does this PR do?

Before submitting

PR review

Did you have fun?

carmocca left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 21, 2022 • edited

⚡ Required checks status: All passing 🟢

Groups summary

carmocca left a comment

Choose a reason for hiding this comment

Deprecate `auto_select_gpus` #16147

Deprecate `auto_select_gpus` #16147

awaelchli commented Dec 20, 2022 •

edited by github-actions bot

github-actions bot commented Dec 21, 2022 •

edited