Remove the `*_step_end` hooks #16791

awaelchli · 2023-02-17T00:42:11Z

What does this PR do?

The training_step_end, validation_step_end, and test_step_end are no longer required after the removal of DP in #16748. Since DP does not exist anymore, there won't be a use case anymore to reduce the tensors from training_step. For any other post-training step processing of outputs, the user can override the on_*_batch_end hooks.

Part of the Lightning 2.0 simplification initiative.

cc @justusschock @awaelchli @Borda

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

src/lightning/pytorch/strategies/xla.py

tests/tests_pytorch/loops/test_evaluation_loop_flow.py

tests/tests_pytorch/loops/test_fetchers.py

github-actions · 2023-02-17T11:11:38Z

⚡ 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.8, 1.11, oldest)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.9, 1.11)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.12)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.10, 1.13)	success	✅
pl-cpu (ubuntu-20.04, lightning, 3.8, 1.11, oldest)	success	✅
pl-cpu (windows-2022, lightning, 3.9, 1.11)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.12)	success	✅
pl-cpu (windows-2022, lightning, 3.10, 1.13)	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	✅

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, tests/tests_pytorch/accelerators/test_tpu.py, tests/tests_pytorch/core/test_datamodules.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/deterministic_model.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_fetchers.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_dict.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/models/test_hooks.py, tests/tests_pytorch/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_train_loop_logging.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py, tests/tests_pytorch/tuner/test_lr_finder.py.

🟢 pytorch_lightning: Azure GPU

Check ID	Status
pytorch-lightning (GPUs)	success	✅

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, tests/tests_pytorch/accelerators/test_tpu.py, tests/tests_pytorch/core/test_datamodules.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/deterministic_model.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_fetchers.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_dict.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/models/test_hooks.py, tests/tests_pytorch/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_train_loop_logging.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py, tests/tests_pytorch/tuner/test_lr_finder.py.

🟢 pytorch_lightning: Azure HPU

Check ID	Status
pytorch-lightning (HPUs)	success	✅

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, tests/tests_pytorch/accelerators/test_tpu.py, tests/tests_pytorch/core/test_datamodules.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/deterministic_model.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_fetchers.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_dict.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/models/test_hooks.py, tests/tests_pytorch/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_train_loop_logging.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py, tests/tests_pytorch/tuner/test_lr_finder.py.

🟢 pytorch_lightning: Azure IPU

Check ID	Status
pytorch-lightning (IPUs)	success	✅

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, tests/tests_pytorch/accelerators/test_tpu.py, tests/tests_pytorch/core/test_datamodules.py, tests/tests_pytorch/core/test_lightning_optimizer.py, tests/tests_pytorch/helpers/deterministic_model.py, tests/tests_pytorch/loops/optimization/test_manual_loop.py, tests/tests_pytorch/loops/test_evaluation_loop_flow.py, tests/tests_pytorch/loops/test_fetchers.py, tests/tests_pytorch/loops/test_training_loop.py, tests/tests_pytorch/loops/test_training_loop_flow_dict.py, tests/tests_pytorch/loops/test_training_loop_flow_scalar.py, tests/tests_pytorch/models/test_hooks.py, tests/tests_pytorch/trainer/logging_/test_eval_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_loop_logging.py, tests/tests_pytorch/trainer/logging_/test_train_loop_logging.py, tests/tests_pytorch/trainer/optimization/test_manual_optimization.py, tests/tests_pytorch/tuner/test_lr_finder.py.

🟢 pytorch_lightning: Docs

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

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py, docs/source-pytorch/common/lightning_module.rst, docs/source-pytorch/extensions/logging.rst, docs/source-pytorch/starter/style_guide.rst, docs/source-pytorch/tuning/profiler_basic.rst, docs/source-pytorch/visualize/logging_advanced.rst.

🟢 mypy

Check ID	Status
mypy	success	✅

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py.

🟢 install

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

These checks are required after the changes to src/lightning/pytorch/core/hooks.py, src/lightning/pytorch/core/module.py, src/lightning/pytorch/demos/boring_classes.py, src/lightning/pytorch/loops/evaluation_loop.py, src/lightning/pytorch/loops/optimization/automatic.py, src/lightning/pytorch/loops/optimization/manual.py, src/lightning/pytorch/strategies/hpu_parallel.py, src/lightning/pytorch/strategies/single_hpu.py, src/lightning/pytorch/strategies/strategy.py, src/lightning/pytorch/strategies/xla.py, src/lightning/pytorch/trainer/connectors/logger_connector/fx_validator.py.

🟢 link-check

Check ID	Status
markdown-link-check	success	✅

These checks are required after the changes to src/lightning/pytorch/CHANGELOG.md.

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.

tests/tests_pytorch/loops/test_training_loop_flow_scalar.py

ethanwharris

Approving app bit 😆

codecov · 2023-02-17T12:10:05Z

Codecov Report

Merging #16791 (30c90ca) into master (81b7c30) will decrease coverage by 3%.
The diff coverage is 40%.

❗ Current head 30c90ca differs from pull request most recent head f5c2c1b. Consider uploading reports for the commit f5c2c1b to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##           master   #16791     +/-   ##
=========================================
- Coverage      82%      79%     -3%     
=========================================
  Files         437      417     -20     
  Lines       31581    31338    -243     
=========================================
- Hits        25767    24654   -1113     
- Misses       5814     6684    +870

src/lightning/pytorch/core/hooks.py

src/lightning/pytorch/core/module.py

src/lightning/pytorch/strategies/hpu_parallel.py

src/lightning/pytorch/strategies/xla.py

Co-authored-by: Carlos Mocholí <[email protected]>

awaelchli added 2 commits February 17, 2023 01:36

removal

e22bdfa

removal

e269f48

awaelchli added strategy: dp (removed in pl) DataParallel breaking change Includes a breaking change labels Feb 17, 2023

awaelchli added this to the 2.0 milestone Feb 17, 2023

awaelchli self-assigned this Feb 17, 2023

github-actions bot added app (removed) Generic label for Lightning App package pl Generic label for PyTorch Lightning package labels Feb 17, 2023

pre-commit-ci bot and others added 4 commits February 17, 2023 00:43

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

f00dbd4

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

Merge branch 'master' into removal/step-end

c4e8fc4

update tests

7a66804

add changelog

d7699e3

awaelchli marked this pull request as ready for review February 17, 2023 11:06

awaelchli requested review from tchaton, lantiga, hhsecond, ethanwharris, williamFalcon, carmocca, justusschock, edenlightning and Borda as code owners February 17, 2023 11:06

awaelchli commented Feb 17, 2023

View reviewed changes

src/lightning/pytorch/strategies/xla.py Show resolved Hide resolved

awaelchli commented Feb 17, 2023

View reviewed changes

tests/tests_pytorch/loops/test_evaluation_loop_flow.py Show resolved Hide resolved

awaelchli commented Feb 17, 2023

View reviewed changes

tests/tests_pytorch/loops/test_fetchers.py Show resolved Hide resolved

awaelchli commented Feb 17, 2023

View reviewed changes

tests/tests_pytorch/loops/test_training_loop_flow_scalar.py Show resolved Hide resolved

justusschock approved these changes Feb 17, 2023

View reviewed changes

ethanwharris approved these changes Feb 17, 2023

View reviewed changes

mergify bot added the ready PRs ready to be merged label Feb 17, 2023

awaelchli added 3 commits February 17, 2023 12:37

Justus suggestion

a1e149b

fix test for changed error message

109acbe

update test, assertion was too late

776b421

carmocca approved these changes Feb 17, 2023

View reviewed changes

mergify bot added has conflicts and removed ready PRs ready to be merged labels Feb 17, 2023

awaelchli and others added 3 commits February 17, 2023 10:41

Apply suggestions from code review

5580aec

Co-authored-by: Carlos Mocholí <[email protected]>

remove redundant code block example

38386ee

Merge branch 'master' into removal/step-end

a29b316

mergify bot added ready PRs ready to be merged has conflicts and removed has conflicts ready PRs ready to be merged labels Feb 17, 2023

Borda approved these changes Feb 20, 2023

View reviewed changes

Merge branch 'master' into removal/step-end

30c90ca

mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Feb 20, 2023

awaelchli enabled auto-merge (squash) February 20, 2023 11:04

awaelchli added 2 commits February 20, 2023 13:04

remove app changes because they are blocking merge

0b2f7dc

Merge branch 'master' into removal/step-end

f5c2c1b

github-actions bot removed the app (removed) Generic label for Lightning App package label Feb 20, 2023

awaelchli merged commit 65e6681 into master Feb 20, 2023

awaelchli deleted the removal/step-end branch February 20, 2023 13:04

rohanshad mentioned this pull request Mar 27, 2025

Checkpoint callback fails with manual optimization #20674

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove the `*_step_end` hooks #16791

Remove the `*_step_end` hooks #16791

Uh oh!

awaelchli commented Feb 17, 2023 •

edited by github-actions bot

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 17, 2023 •

edited

Loading

Uh oh!

Uh oh!

ethanwharris left a comment

Uh oh!

codecov bot commented Feb 17, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Remove the *_step_end hooks #16791

Remove the *_step_end hooks #16791

Uh oh!

Conversation

awaelchli commented Feb 17, 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!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 17, 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!

Uh oh!

ethanwharris left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Remove the `*_step_end` hooks #16791

Remove the `*_step_end` hooks #16791

awaelchli commented Feb 17, 2023 •

edited by github-actions bot

Loading

github-actions bot commented Feb 17, 2023 •

edited

Loading

codecov bot commented Feb 17, 2023 •

edited

Loading