Improve typing coverage (4/n)

[otaj]

🚀 Typing coverage

Let's improve typing coverage of PyTorch Lightning together!

I'm creating a new issue in order to increase visibility. There are three older issues (#7037, #5023, #4698) which became stale over time.

Plan

Currently, there are 55 files which are excluded from mypy checks so that our CI does not fail. These files vastly differ in difficulty in order to make the typing complete. For this reason, we are introducing difficulty estimate for each file so that community members can choose to work on the files appropriate to their skill level.

Please, comment on this issue in order to reserve a particular file to work on. Once you do so, I will edit this top comment to avoid collisions. Once you think your work is finished, please open a PR referencing this issue which:

• removes the corresponding line from pyproject.toml
• and passes mypy checks with the corresponding line removed. You can test it locally by running mypy from root directory

If you are struggling with pushing it over the finish line, open the PR anyway and someone from our team will help you to get it there. 🚀

Please note, that it can happen that you may need to edit more than just one file. This is fine, but please keep in mind, that the goal of your PR will be to make the check passing for the chosen file. Also, please note that the difficulty is just an educated guess.

For those of you who are not familiar with the process of contributing a PR, we have prepared a simple guide that will walk you through the necessary steps. You can do it! 🚀 💪

List of files and guesstimated difficulty

Completed

Difficulty 1 of 3

• pytorch_lightning/core/decorators.py Run mypy with PyTorch 1.12 #14044
• pytorch_lightning/profilers/advanced.py @nninept Fix mypy errors attributed to pytorch_lightning/profilers/advanced.py #13792
  - [ ] pytorch_lightning/profilers/base.py @LeeChanHyuk Fix mypy errors attributed to pytorch_lightning/profilers/base.py #13879
• pytorch_lightning/loggers/base.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.base.py #13494
• pytorch_lightning/__setup__.py @CyprienRicque fix mypy typing errors in pytorch_lightning/__setup__.py #13472
  - [ ] pytorch_lightning/distributed/dist.py @puhuk fix mypy errors for distributed/dist.py #13492
• pytorch_lightning/strategies/single_device.py @CyprienRicque fix mypy typing errors in pytorch_lightning/strategies/single_device.py #13532
• pytorch_lightning/trainer/optimizers.py @gautierdag fix mypy typing errors in lightning/trainer/optimizers.py #13470
• pytorch_lightning/utilities/distributed.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.utilities.distributed #13678
• pytorch_lightning/callbacks/finetuning.py @ar90n Fix type hints of callbacks/finetuning.py #13516
• pytorch_lightning/loggers/mlflow.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.mlflow #13690 Fix mypy errors attributed to pytorch_lightning.loggers.mlflow #13691
• pytorch_lightning/tuner/tuning.py @donlapark fix typing in pl/tuner/tuning.py #13616 Change the return type of tune() in trainer.py to TypedDict #13631
• pytorch_lightning/strategies/single_tpu.py @CyprienRicque Fix mypy typing errors in pytorch_lightning/strategies/single_tpu.py #13534
• pytorch_lightning/strategies/ddp2.py @CyprienRicque fix mypy typing errors in pytorch_lightning/strategies/ddp2.py #13535
• pytorch_lightning/strategies/parallel.py @CyprienRicque fix mypy typing errors in pytorch_lightning/strategies/parallel.py #13556
• pytorch_lightning/loggers/csv_logs.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.csv_logs.py #13538
• pytorch_lightning/tuner/lr_finder.py @donlapark fix mypy typing errors in pytorch_lightning/tuner/lr_finder.py #13513 Remove a bool type assignment in lr_finder.py #13652
• pytorch_lightning/strategies/dp.py @CyprienRicque fix mypy typing errors in pytorch_lightning/strategies/dp.py #13564
• pytorch_lightning/profilers/simple.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.profilers.simple #14103
• pytorch_lightning/strategies/sharded_spawn.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning. strategies.sharded_spawn #14102
• pytorch_lightning/demos/mnist_datamodule.py @alro923 Fix mypy typing errors attributed to pytorch_lightning/demos/mnist_datamodule.py #13929
• pytorch_lightning/demos/boring_classes.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.demos.boring_classes #14201
• pytorch_lightning/tuner/batch_size_scaling.py @ar90n Fix type hints of tuner/batch_size_scaling.py #13518

Difficulty 2 of 3

• pytorch_lightning/loops/epoch/training_epoch_loop.py @himkt Fix mypy errors attributed to pytorch_lightning/loops/epoch/training_epoch_loop.py #13555
• pytorch_lightning/core/mixins/device_dtype_mixin.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.core.mixins.device_dtype_mixin #13704
• pytorch_lightning/loggers/comet.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.comet #13689
• pytorch_lightning/loggers/tensorboard.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.tensorboard.py #13688
• pytorch_lightning/strategies/horovod.py @CyprienRicque fix mypy typing errors in pytorch_lightning/strategies/horovod.py #13570
• pytorch_lightning/callbacks/model_checkpoint.py @BongYang Fix mypy typing errors in pytorch_lightning/callbacks/model_checkpoint.py #13617
• pytorch_lightning/strategies/fully_sharded.py @BongYang Fix mypy typing errors in strategies/fully_sharded.py #13941
• pytorch_lightning/loggers/neptune.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.neptune #13692
• pytorch_lightning/utilities/meta.py @nninept Fix mypy errors attributed to pytorch_lightning/utilities/meta.py #13763 Remove meta device utilities in favor of torchdistx #13868
• pytorch_lightning/strategies/tpu_spawn.py @BongYang Fix mypy typing errors in pytorch_lightning/strategies/tpu_spawn.py #13813
• pytorch_lightning/loggers/logger.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.loggers.logger.py #13541
• pytorch_lightning/loggers/wandb.py @gautierdag fix mypy errors for loggers/wandb.py #13483
• pytorch_lightning/callbacks/stochastic_weight_avg.py @donlapark fixes typing in pytorch_lightning/callbacks/stochastic_weight_avg.py #13685 fixes typing in stochastic_weight_avg.py (follow-up of #13685) #13860
• pytorch_lightning/strategies/strategy.py @CyprienRicque fix mypy typing errors in pytorch_lightning/strategies/strategy.py #13519
• pytorch_lightning/strategies/deepspeed.py @donlapark Fixes various typing errors in pytorch_lightning/strategies/deepspeed.py #13832
• pytorch_lightning/strategies/ddp_spawn.py @donlapark Fix mypy errors in strategies/ddp_spawn.py #13865
• pytorch_lightning/strategies/ipu.py @HalestormAI Fix typing annotations for the ipu strategy #13786
• pytorch_lightning/trainer/connectors/callback_connector.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.trainer.connectors.callback_connector.py #13750
• pytorch_lightning/strategies/ddp.py @lijm1358 Fix mypy errors in pytorch_lightning/strategies/ddp.py #13885
• pytorch_lightning/core/saving.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.core.saving #13932
• pytorch_lightning/callbacks/quantization.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.callbacks.quantization #13782
• pytorch_lightning/strategies/sharded.py @lijm1358 Fix mypy errors in pytorch_lightning/strategies/sharded.py #14184
• pytorch_lightning/core/datamodule.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.core.datamodule #13693

Difficulty 3 of 3

~- [ ] pytorch_lightning/trainer/callback_hook.py @JustinGoheen #13807 ~

• pytorch_lightning/core/module.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.core.module.py #13603
• pytorch_lightning/trainer/connectors/data_connector.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.trainer.connectors.data_connector.py #13806
• pytorch_lightning/utilities/auto_restart.py @donlapark fixes typing errors in auto_restart.py #13904
• pytorch_lightning/trainer/supporters.py @donlapark fixes mypy errors in trainer/supporters.py #14633
• pytorch_lightning/profilers/pytorch.py @krishnakalyan3 Fix mypy errors attributed to pytorch_lightning.profilers.pytorch #14405
• pytorch_lightning/utilities/data.py @nandwalritik fix mypy typing errors in pytorch_lightning.utilities.data.py #13901
• pytorch_lightning/trainer/trainer.py @JustinGoheen Fix mypy errors attributed to pytorch_lightning.trainer.trainer.py #13810 @BongYang Fix mypy typing errors in pytorch_lightning/trainer/trainer.py #14204
• pytorch_lightning/callbacks/progress/rich_progress.py @donlapark fixes typing errors in rich_progress.py #14963

cc @Borda @justusschock @awaelchli @rohitgr7 @Borda @tchaton @aniketmaurya @kingjuno @alat-rights @carmocca @akihironitta @stancld as you were all involved in previous issues

[kingjuno]

@otaj I will start working on these 3 for now.

• pytorch_lightning/core/decorators.py
• pytorch_lightning/profilers/advanced.py
• pytorch_lightning/profilers/base.py

[jxtngx]

@otaj I can take:

• pytorch_lightning/loggers/base.py
• pytorch_lightning/loggers/csv_logs.py
• pytorch_lightning/loggers/logger.py

[carmocca]

A recommendation for contributors: Unless a file requires <10 lines of fixes, I strongly suggest you work on separate PRs per file if possible. Sometimes mypy requires you to update the typing annotations for a different file, but it does not mean you need to completely annotate all modified files.

[otaj]

@JustinGoheen @kingjuno Thank you very much, you were added to the list. However, I have to agree with @carmocca, keep one PR for fixing one file please.

[barufa]

I would like to make my first contribution to lightning. I can take pytorch_lightning/demos/boring_classes.py and pytorch_lightning/demos/mnist_datamodule.py.

[otaj]

@barufa Thank you very much, added you to the list!

[donlapark]

I would like to contribute as well. I can take pytorch_lightning/tuner/lr_finder.py.

[otaj]

@donlapark thank you as well. Added to the list:)

[puhuk]

I will take pytorch_lightning/distributed/dist.py

[otaj]

@puhuk Thank you very much! You were added to the list!

[CyprienRicque]

Hello! I can work on:

• pytorch_lightning/__setup__.py fix mypy typing errors in pytorch_lightning/__setup__.py #13472
• pytorch_lightning/strategies/single_device.py fix mypy typing errors in pytorch_lightning/strategies/single_device.py #13532
• pytorch_lightning/strategies/strategy.py fix mypy typing errors in pytorch_lightning/strategies/strategy.py #13519

[otaj]

@Cyprien-Ricque Awesome, thanks! Added your reservations to the master comment.

[gautierdag]

Hi!
Just did a quick PR for pytorch_lightning/trainer/optimizers.py here: #13470

[ar90n]

Hi! I want to take the followings.

• pytorch_lightning/callbacks/finetuning.py
• pytorch_lightning/tuner/batch_size_scaling.py

[otaj]

@gautierdag , thank you! I saw it was a fairly small PR, so it doesn't matter much, but we would still prefer in the future if you reserve it as to avoid collisions with other people who might already start working on that. But anyway, thank you :)

@ar90n, you were also added to the list, thank you :)

[gautierdag]

@otaj Cheers, I'll try to take on pytorch_lightning/loggers/wandb.py today :)

update: #13483

[otaj]

@gautierdag, perfect, thank you, added to the list!

[jxtngx]

@otaj @carmocca

two errors in loggers/base.py are attributed to None types being set as the return type for deprecation warnings; should these be left alone or set as the return type for the future

[jxtngx]

can I be removed from pytorch_lightning/trainer/supporters.py and pytorch_lightning/trainer/trainer.py please

[HeegonJin]

Can I be released from pytorch_lightning/callbacks/progress/rich_progress.py, if it's available?

[otaj]

@JustinGoheen, @HeegonJin, absolutely, though we're gonna be sad about that

[nninept]

Hi, I can take pytorch_lightning/callbacks/progress/rich_progress.py!

[otaj]

Absolutely, @nninept, thank you! 🎉 You were added to the list ⚡

[otaj]

Hi @nandwalritik, I've unassigned you from pytorch_lightning/profilers/pytorch.py file as there hasn't been any PR opened regarding in the last two weeks. Thank you for your contributions! ⚡

[Jungwon-Lee]

Hi, I would like to take pytorch_lightning/trainer/trainer.py

[otaj]

Hi, @BongYang, thank you very much, you were added to the list! ⚡

[krishnakalyan3]

I would like to take up pytorch_lightning/profilers/pytorch.py

[otaj]

Alright, @krishnakalyan3, assigned this to you! Thanks a lot ⚡

[donlapark]

Hi! I would like to take pytorch_lightning/trainer/supporters.py.

[awaelchli]

@donlapark Appreciated! Feel free to go ahead. It could be a challenging one, let us know if you need help!

[donlapark]

A mypy check has just failed because there are some errors in tuner/lr_finder.py, trainer/connectors/callback_connector.py and trainer/connectors/callback_connector.py (most of them are just Unused "type: ignore"). Maybe we should fix those errors as well?

Edit: Nevermind, the error in tuner/lr_finder.py was caused by my PR on supporters.py—whoops.

[otaj]

Hi @nninept, I've unassigned you from pytorch_lightning/callbacks/progress/rich_progress.py file as there hasn't been any PR opened regarding in the last two weeks. Thank you for your contributions! ⚡

[donlapark]

I would like to take rich_progress.py.

[otaj]

Awesome, @donlapark! Thank you very much, you were added to the list! ⚡

[otaj]

🎉 We did it! 🎉 We just closed last PR resolving typing in PyTorch portion of Lightning 🎉 Thanks to everyone, who contributed, namely @carmocca @nninept @JustinGoheen @CyprienRicque @gautierdag @krishnakalyan3 @ar90n @donlapark @alro923 @himkt @BongYang @HalestormAI @lijm1358 @nandwalritik 🎉

[Borda]

Shall we do the same with lightning Flow and Work... 🦦

[otaj]

I'm all for it! But that's gonna be an entirely different beast, since there's a lot more on the Flow and Work side