Deprecate `LightningModule.summarize()` in favor of `pl.utilities.model_summary.summarize()` #8513

samlurye · 2021-07-21T19:53:37Z

Deprecate the method LightningModule.summarize and move it to its own function in pytorch_lightning/utilities/model_summary.py. Additionally, move LayerSummary and ModelSummary, along with all of their supporting functions, from pytorch_lightning/core/memory.py into the same model_summary.py file.

Fixes #8478

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 🙃

Deprecate the method `LightningModule.summarize` and move it to its own function in `pytorch_lightning/utilities/model_summary.py`. Additionally, move `LayerSummary` and `ModelSummary`, along with all of their supporting functions, from `pytorch_lightning/core/memory.py` into the same `model_summary.py` file.

…lightning into PyTorchLightning-master

Py torch lightning master

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

codecov · 2021-07-21T19:56:28Z

Codecov Report

Merging #8513 (2dbffab) into master (16392a7) will increase coverage by 0%.
The diff coverage is 95%.

@@           Coverage Diff           @@
##           master   #8513    +/-   ##
=======================================
  Coverage      88%     89%            
=======================================
  Files         168     168            
  Lines       13975   14045    +70     
=======================================
+ Hits        12344   12462   +118     
+ Misses       1631    1583    -48

Fix some code check and testing issues

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

ananthsub

thanks for working on this @samlurye! I left a few small comments inline

pytorch_lightning/core/memory.py

tests/utilities/test_model_summary.py

pytorch_lightning/utilities/model_summary.py

pytorch_lightning/core/lightning.py

Co-authored-by: Adrian Wälchli <[email protected]>

pep8speaks · 2021-07-21T22:32:13Z

Hello @samlurye! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-08-03 21:28:36 UTC

pytorch_lightning/core/lightning.py

pytorch_lightning/utilities/model_summary.py

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

pytorch_lightning/core/lightning.py

pytorch_lightning/trainer/trainer.py

pytorch_lightning/core/memory.py

pytorch_lightning/trainer/trainer.py

pytorch_lightning/utilities/memory.py

pytorch_lightning/utilities/model_summary.py

Co-authored-by: Jirka Borovec <[email protected]>

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

tchaton · 2021-08-02T18:04:59Z

Dear @samlurye,

The tests seems to be failing. Mind looking into that ?

Best,
T.C

tests/deprecated_api/test_remove_1-7.py

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

samlurye and others added 4 commits July 21, 2021 14:55

Update CHANGELOG.md with changes from e11c16d

2d1ce57

Merge branch 'master' of https://github.com/PyTorchLightning/pytorch-…

0fb5753

…lightning into PyTorchLightning-master

Merge pull request #2 from samlurye/PyTorchLightning-master

c695078

Py torch lightning master

samlurye requested review from awaelchli, Borda, carmocca, justusschock, kaushikb11, SeanNaren, tchaton and williamFalcon as code owners July 21, 2021 19:53

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

e43daac

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

samlurye and others added 3 commits July 21, 2021 17:01

Fix some code check and testing issues

1befd4a

Merge pull request #3 from samlurye/PyTorchLightning-master

26588df

Fix some code check and testing issues

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

3686b05

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

ananthsub reviewed Jul 21, 2021

View reviewed changes

pytorch_lightning/core/memory.py Outdated Show resolved Hide resolved

awaelchli approved these changes Jul 21, 2021

View reviewed changes

samlurye and others added 3 commits July 21, 2021 18:31

Update tests/utilities/test_model_summary.py

0d8ea7d

Co-authored-by: Adrian Wälchli <[email protected]>

Update tests/utilities/test_model_summary.py

da8cd59

Co-authored-by: Adrian Wälchli <[email protected]>

Update pytorch_lightning/core/lightning.py

4194ca9

Co-authored-by: Adrian Wälchli <[email protected]>

awaelchli added feature Is an improvement or enhancement refactor design Includes a design discussion and removed feature Is an improvement or enhancement labels Jul 21, 2021

ananthsub reviewed Jul 21, 2021

View reviewed changes

pytorch_lightning/core/lightning.py Show resolved Hide resolved

ananthsub reviewed Jul 21, 2021

View reviewed changes

pytorch_lightning/utilities/model_summary.py Outdated Show resolved Hide resolved

ananthsub reviewed Jul 21, 2021

View reviewed changes

pytorch_lightning/utilities/model_summary.py Show resolved Hide resolved

samlurye requested a review from SkafteNicki as a code owner July 27, 2021 21:16

mergify bot removed the has conflicts label Jul 27, 2021

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

5a0c407

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

awaelchli reviewed Jul 27, 2021

View reviewed changes

pytorch_lightning/core/lightning.py Show resolved Hide resolved

pytorch_lightning/trainer/trainer.py Show resolved Hide resolved

awaelchli added 2 commits July 27, 2021 23:28

add import for the typehint in summarize()

9e5b8b9

fix unused imports

783072c

Borda changed the title ~~Deprecate LightningModule.summarize() in favor of pytorch_lightning.utilities.model_summary.summarize()~~ Deprecate LightningModule.summarize() in favor of pl.utilities.model_summary.summarize() Jul 28, 2021

Borda reviewed Jul 28, 2021

View reviewed changes

Merge branch 'PyTorchLightning:master' into master

c4ecf54

ananthsub approved these changes Jul 29, 2021

View reviewed changes

mergify bot added the ready PRs ready to be merged label Jul 29, 2021

samlurye added 2 commits July 30, 2021 09:40

Fix typo in test_ddp_spawn.py

0c3cdc8

Merge branch 'master' of https://github.com/samlurye/pytorch-lightning

dd34e73

mergify bot added the has conflicts label Jul 30, 2021

samlurye and others added 4 commits July 30, 2021 11:34

Add back log.info call

85870d6

Update pytorch_lightning/core/memory.py

ea27e98

Co-authored-by: Jirka Borovec <[email protected]>

Update pytorch_lightning/core/memory.py

432c6e1

Co-authored-by: Jirka Borovec <[email protected]>

Merge branch 'master' into master

c1b55a8

mergify bot removed the has conflicts label Jul 30, 2021

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

b7f47b8

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

carmocca approved these changes Jul 30, 2021

View reviewed changes

Borda approved these changes Aug 3, 2021

View reviewed changes

awaelchli reviewed Aug 3, 2021

View reviewed changes

tests/deprecated_api/test_remove_1-7.py Outdated Show resolved Hide resolved

tests/deprecated_api/test_remove_1-7.py Outdated Show resolved Hide resolved

awaelchli and others added 2 commits August 3, 2021 23:28

fix ticks in warning message test

9dc913a

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

2dbffab

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

awaelchli enabled auto-merge (squash) August 3, 2021 21:30

awaelchli merged commit f90849c into Lightning-AI:master Aug 3, 2021

Borda changed the title ~~Deprecate LightningModule.summarize() in favor of pl.utilities.model_summary.summarize()~~ Deprecate LightningModule.summarize() in favor of pl.utilities.model_summary.summarize() Mar 10, 2023

Borda mentioned this pull request Mar 10, 2023

remove LightningModule.summarize #12559

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `LightningModule.summarize()` in favor of `pl.utilities.model_summary.summarize()` #8513

Deprecate `LightningModule.summarize()` in favor of `pl.utilities.model_summary.summarize()` #8513

samlurye commented Jul 21, 2021 •

edited by awaelchli

Loading

codecov bot commented Jul 21, 2021 •

edited

Loading

ananthsub left a comment

pep8speaks commented Jul 21, 2021 •

edited

Loading

tchaton commented Aug 2, 2021

Deprecate LightningModule.summarize() in favor of pl.utilities.model_summary.summarize() #8513

Deprecate LightningModule.summarize() in favor of pl.utilities.model_summary.summarize() #8513

Conversation

samlurye commented Jul 21, 2021 • edited by awaelchli Loading

Before submitting

PR review

Did you have fun?

codecov bot commented Jul 21, 2021 • edited Loading

Codecov Report

ananthsub left a comment

Choose a reason for hiding this comment

pep8speaks commented Jul 21, 2021 • edited Loading

Comment last updated at 2021-08-03 21:28:36 UTC

tchaton commented Aug 2, 2021

Deprecate `LightningModule.summarize()` in favor of `pl.utilities.model_summary.summarize()` #8513

Deprecate `LightningModule.summarize()` in favor of `pl.utilities.model_summary.summarize()` #8513

samlurye commented Jul 21, 2021 •

edited by awaelchli

Loading

codecov bot commented Jul 21, 2021 •

edited

Loading

pep8speaks commented Jul 21, 2021 •

edited

Loading