Type Hints for Lightning Core #946

awaelchli · 2020-02-25T22:07:53Z

Before submitting

Was this discussed/approved via a Github issue? (no need for typos, doc improvements)
Did you read the contributor guideline?
Did you make sure to update the docs?
Did you write any new necessary tests?
If you made a notable change (that affects users), did you update the CHANGELOG?

What does this PR do?

Follow up on #912 and discussed in #887.
Not high priority.

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

Borda

LGTH, nice addition! just when you update docs, pls use napoleon

pytorch_lightning/core/hooks.py

pytorch_lightning/core/lightning.py

pytorch_lightning/core/memory.py

pytorch_lightning/core/saving.py

awaelchli · 2020-02-26T08:18:13Z

Let's wait until #833 is merged because I did minor documentation changes and would like to check if there are new warnings.

pep8speaks · 2020-02-27T21:52:11Z

Hello @awaelchli! Thanks for updating this PR.

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

Comment last updated at 2020-03-12 16:47:21 UTC

awaelchli · 2020-02-27T22:19:16Z

@hanbyul-kim @Borda
I get many warnings when compiling the docs. Funny thing, the number of warnings changes everytime I run make clean and make html (inside the docs folder).

Most of them are import problems. I tried changing my path variable, didn't help.

WARNING: autodoc: failed to import module 'trainer.training_loop' from module 'pytorch_lightning'; the following exception was raised:
cannot import name 'LightningModule' from 'pytorch_lightning' (/home/adrian/repositories/pytorch-lightning/pytorch_lightning/__init__.py)

It is also happening on master. Should I open an issue or do you know a quick fix?

Borda · 2020-02-27T22:38:15Z

I get many warnings when compiling the docs. Funny thing, the number of warnings changes everytime I run make clean and make html (inside the docs folder).

if does not compile always everything, it uses a cache so if you clean in between compilations you will have the same number...

Most of them are import problems. I tried changing my path variable, didn't help.

have you rebased on master after #833 there was most of the imports resolved

It is also happening on master. Should I open an issue or do you know a quick fix?

@awaelchli That would be great! 🤖
Just if you go for it, please make this PR as wip so Will does not merge it in meantime lol

pytorch_lightning/core/saving.py

This reverts commit 8555961.

Borda

add it to chnagelog

Borda · 2020-03-11T13:45:13Z

@williamFalcon @hadim @luiscape ^^

luiscape · 2020-03-11T20:35:12Z

It looks rather good; I like it. Maybe an appropriate next step would be to add a type checker such as mypy as as CI step?

Borda · 2020-03-11T20:36:45Z

hey there, we have added GPU CI test, so could we kindly ask to rebase/merge master which will trigger these tests so we do not need to test it manually... Thx for your understanding 🤖

Borda · 2020-03-11T22:11:13Z

It looks rather good; I like it. Maybe an appropriate next step would be to add a type checker such as mypy as as CI step?

good idea, do you want to send a PR? :]

* first pass for LightningModule typehints * fix return types * add missing types * add type annotations to grads.py * add type annotations to hooks.py * add type annotation to memory.py * proper docstring quotation marks * add type annotations to saving.py * fix cyclic import problem * fix cyclic import problem * add missing whitespace * finish type hints for load_from_ methods * docs: prepare_data does not return anything * fix auto types in docs * revert typehint for trainer in hook * remove unnecessary return docs * some fixes for memory docs * revert typing for args kwargs * added all missing None return types * remove unused import * add more details to dict/list return types * fix line too long * optimize imports * linted * Revert "linted" This reverts commit 8555961. * remove whitespace * update * update * update * update * update * changelog Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com> Co-authored-by: William Falcon <waf2107@columbia.edu>

awaelchli changed the title ~~Type Hints for Lightning Core~~ Type Hints for Lightning Core [WIP] Feb 26, 2020

Borda approved these changes Feb 26, 2020

View reviewed changes

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

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

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

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

Borda added docs Documentation related feature Is an improvement or enhancement labels Feb 26, 2020

Borda changed the title ~~Type Hints for Lightning Core [WIP]~~ [blocked by #833] Type Hints for Lightning Core Feb 26, 2020

Borda changed the title ~~[blocked by #833] Type Hints for Lightning Core~~ Type Hints for Lightning Core Feb 27, 2020

Borda added the ready PRs ready to be merged label Feb 27, 2020

awaelchli mentioned this pull request Mar 2, 2020

Merge load functions #995

Merged

5 tasks

Adrian Wälchli and others added 18 commits March 3, 2020 13:12

first pass for LightningModule typehints

661405d

fix return types

9b5e784

add missing types

dc89b90

add type annotations to grads.py

d3460cb

add type annotations to hooks.py

cdfd1d1

add type annotation to memory.py

3526a77

proper docstring quotation marks

614256c

add type annotations to saving.py

e36f42a

fix cyclic import problem

0c86afe

fix cyclic import problem

280a0d0

add missing whitespace

e433490

finish type hints for load_from_ methods

4d24fdf

docs: prepare_data does not return anything

c2e1cec

fix auto types in docs

a878adb

revert typehint for trainer in hook

35eb67c

remove unnecessary return docs

0272309

some fixes for memory docs

34f7c7d

revert typing for args kwargs

2fa525f

Merge branch 'master' into module-typehints

09b8c16

awaelchli commented Mar 5, 2020

View reviewed changes

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

Borda reviewed Mar 5, 2020

View reviewed changes

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

Borda and others added 4 commits March 5, 2020 14:54

linted

8555961

Revert "linted"

7482cb8

This reverts commit 8555961.

remove whitespace

cad32d8

Merge branch 'master' into module-typehints

ced9435

awaelchli changed the title ~~Type Hints for Lightning Core~~ Type Hints for Lightning Core [WIP] Mar 6, 2020

Borda force-pushed the master branch from a07849b to 21ac476 Compare March 6, 2020 20:38

Adrian Wälchli added 6 commits March 7, 2020 22:49

update

b3f0ba5

Merge branch 'master' into module-typehints

aef5138

update

15516de

update

9c026ce

update

2915e6b

update

4bd0437

awaelchli changed the title ~~Type Hints for Lightning Core [WIP]~~ Type Hints for Lightning Core Mar 7, 2020

Borda reviewed Mar 9, 2020

View reviewed changes

Adrian Wälchli added 2 commits March 10, 2020 20:31

Merge branch 'master' into module-typehints

5c4b27f

changelog

4f68fc1

Merge branch 'master' into module-typehints

4a517c3

Merge branch 'master' into module-typehints

1909bad

williamFalcon merged commit 3c2fd56 into Lightning-AI:master Mar 12, 2020

awaelchli deleted the module-typehints branch March 12, 2020 23:04

Borda modified the milestones: v0.7., v0.7.x Apr 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Type Hints for Lightning Core #946

Type Hints for Lightning Core #946

awaelchli commented Feb 25, 2020 •

edited

Loading

Borda left a comment

awaelchli commented Feb 26, 2020 •

edited

Loading

pep8speaks commented Feb 27, 2020 •

edited

Loading

awaelchli commented Feb 27, 2020 •

edited

Loading

Borda commented Feb 27, 2020 •

edited

Loading

Borda left a comment

Borda commented Mar 11, 2020 •

edited

Loading

luiscape commented Mar 11, 2020

Borda commented Mar 11, 2020

Borda commented Mar 11, 2020

Type Hints for Lightning Core #946

Type Hints for Lightning Core #946

Conversation

awaelchli commented Feb 25, 2020 • edited Loading

Before submitting

What does this PR do?

PR review

Did you have fun?

Borda left a comment

Choose a reason for hiding this comment

awaelchli commented Feb 26, 2020 • edited Loading

pep8speaks commented Feb 27, 2020 • edited Loading

Comment last updated at 2020-03-12 16:47:21 UTC

awaelchli commented Feb 27, 2020 • edited Loading

Borda commented Feb 27, 2020 • edited Loading

Borda left a comment

Choose a reason for hiding this comment

Borda commented Mar 11, 2020 • edited Loading

luiscape commented Mar 11, 2020

Borda commented Mar 11, 2020

Borda commented Mar 11, 2020

awaelchli commented Feb 25, 2020 •

edited

Loading

awaelchli commented Feb 26, 2020 •

edited

Loading

pep8speaks commented Feb 27, 2020 •

edited

Loading

awaelchli commented Feb 27, 2020 •

edited

Loading

Borda commented Feb 27, 2020 •

edited

Loading

Borda commented Mar 11, 2020 •

edited

Loading