Update core/lightning.py to core/lightning_module.py

[rohitgr7]

Proposed refactoring or deprecation

Update core/lightning.py to core/lightning_module.py
Possibly also update core/datamodule.py to core/lightning_datamodule.py

Motivation

Update it since core/lightning.py only contains LightningModule so the filename doesn't signify what it contains.

Pitch

It's a simple update. We can deprecate the old filename. Need approvals if it looks good.

Additional context

---

If you enjoy Lightning, check out our other projects! ⚡

• Metrics: Machine learning metrics for distributed, scalable PyTorch applications.

• Lite: enables pure PyTorch users to scale their existing code on any kind of device while retaining full control over their own loops and optimization logic.

• Flash: The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, fine-tuning, and solving problems with deep learning.

• Bolts: Pretrained SOTA Deep Learning models, callbacks, and more for research and production with PyTorch Lightning and PyTorch.

• Lightning Transformers: Flexible interface for high-performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.

cc @justusschock @awaelchli @akihironitta @rohitgr7 @carmocca @Borda @ananthsub @ninginthecloud @jjenniferdai

[tchaton]

Hey @rohitgr7,

I am in favour of this. It would make discoverability of the code simpler.

@ananthsub @awaelchli @carmocca Any thoughts ?

[carmocca]

Agree with the renaming.

However, it should be core/lightning.py -> core/module.py

because if we choose core/lighting_module.py, the following should also be changed
core/datamodule.py -> core/lightning_datamodule.py (already pointed out in the top post)
lite/lite.py -> lite/lightning_lite.py
utilities/cli.py -> utilities/lightning_cli.py

[rohitgr7]

@Borda thoughts?

[Borda]

Agree with the renaming.

I would say that the lite/lite.py is not very good as well as trainer/trainer.py

thoughts?

I agree with the name, just has module.py only ay be confusing as the same name is in PT, so could be included somehow that this module is for models or its base? aka core/lightning.py -> core/base_module.py

[carmocca]

I agree with the name, just has module.py only ay be confusing as the same name is in PT, so could be included somehow that this module is for models or its base? aka core/lightning.py -> core/base_module.py

But that's a separate topic, which would be if LightningModule is a good name.
It should only be base_module if LightningModule was renamed to BaseModule.

This issue is just about consistency of the filenames. The current format is class LightningX -> X.py

So either (1):

• lightning.py is adapted to module.py for consistency with the format (:tada: )
• the format is changed to class LightningX -> lightning_X.py (:+1: )

[stale]

This issue has been automatically marked as stale because it hasn't had any recent activity. This issue will be closed in 7 days if no further activity occurs. Thank you for your contributions, Pytorch Lightning Team!

[stale]

This issue has been automatically marked as stale because it hasn't had any recent activity. This issue will be closed in 7 days if no further activity occurs. Thank you for your contributions, Pytorch Lightning Team!

[stale]

This issue has been automatically marked as stale because it hasn't had any recent activity. This issue will be closed in 7 days if no further activity occurs. Thank you for your contributions, Pytorch Lightning Team!

[tanmoyio]

@rohitgr7 I want to work on it,

[akihironitta]

Hi @tanmoyio! That'll be great! Assigned this issue to you :)

[tanmoyio]

@akihironitta so core/lightning.py -> core/module.py ?
won't it affect the tests ?