move pytorch_lightning >> lightning/pytorch (#16594)

.azure/gpu-tests-pytorch.yml

@@ -26,7 +26,8 @@ pr:
       - "examples/pl_basics/backbone_image_classifier.py"
       - "examples/pl_basics/autoencoder.py"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
       - "requirements/fabric/**"

.azure/hpu-tests.yml

@@ -24,7 +24,8 @@ pr:
       - "src/lightning/fabric/**"
       - "src/lightning_fabric/*"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
     exclude:

.azure/ipu-tests.yml

@@ -21,7 +21,8 @@ pr:
       - "src/lightning/fabric/**"
       - "src/lightning_fabric/*"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
     exclude:

.github/checkgroup.yml

@@ -11,7 +11,8 @@ subprojects:
       - "src/lightning/fabric/**"
       - "src/lightning_fabric/*"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "tests/legacy/**"
       - "pyproject.toml"  # includes pytest config
@@ -49,7 +50,8 @@ subprojects:
       - "examples/pl_basics/backbone_image_classifier.py"
       - "examples/pl_basics/autoencoder.py"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
       - "requirements/fabric/**"
@@ -82,7 +84,8 @@ subprojects:
       - "src/lightning/fabric/**"
       - "src/lightning_fabric/*"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
       - "!requirements/*/docs.txt"
@@ -99,7 +102,8 @@ subprojects:
       - "src/lightning/fabric/**"
       - "src/lightning_fabric/*"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
       - "!requirements/docs.txt"
@@ -130,7 +134,8 @@ subprojects:
 
   - id: "pytorch_lightning: Docs"
     paths:
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "docs/source-pytorch/**"
       - ".actions/**"
       - ".github/workflows/docs-checks.yml"

.github/labeler.yml

@@ -9,7 +9,8 @@ app:
   - 'requirements/app/**'
 
 pl:
-  - 'src/pytorch_lightning/**'
+  - "src/lightning/pytorch/**"
+  - "src/pytorch_lightning/*"
   - 'tests/tests_pytorch/**'
   - 'tests/legacy/**'
   - 'examples/pl_*/**'

.github/workflows/ci-tests-pytorch.yml

@@ -10,7 +10,8 @@ on:
     paths:
       - ".actions/**"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "tests/legacy/**"
       - "pyproject.toml"  # includes pytest config

.github/workflows/tpu-tests.yml

@@ -15,7 +15,8 @@ on:
       - "src/lightning_fabric/*"
       - "tests/tests_fabric/**"
       - "requirements/pytorch/**"
-      - "src/pytorch_lightning/**"
+      - "src/lightning/pytorch/**"
+      - "src/pytorch_lightning/*"
       - "tests/tests_pytorch/**"
       - "pyproject.toml"  # includes pytest config
       - "!requirements/*/docs.txt"

.gitignore

@@ -57,7 +57,10 @@ src/lightning_fabric/
 !src/lightning_fabric/__*__.py
 !src/lightning_fabric/MANIFEST.in
 !src/lightning_fabric/README.md
-src/lightning/pytorch/
+src/pytorch_lightning/
+!src/pytorch_lightning/__*__.py
+!src/pytorch_lightning/MANIFEST.in
+!src/pytorch_lightning/README.md
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.pre-commit-config.yaml

@@ -42,9 +42,8 @@ repos:
                 docs/source-pytorch/_static/images/general/pl_quick_start_full_compressed.gif|
                 docs/source-pytorch/_static/images/general/pl_overview_flat.jpg|
                 docs/source-pytorch/_static/images/general/pl_overview.gif|
-                src/lightning_app/cli/pl-app-template/ui/yarn.lock|
-                src/pytorch_lightning/CHANGELOG.md|
-                src/lightning/fabric/CHANGELOG.md
+                src/lightning/fabric/CHANGELOG.md|
+                src/lightning/pytorch/CHANGELOG.md
             )$
       - id: detect-private-key
 
@@ -100,7 +99,7 @@ repos:
           (?x)^(
               src/lightning/app/CHANGELOG.md|
               src/lightning/fabric/CHANGELOG.md|
-              src/pytorch_lightning/CHANGELOG.md
+              src/lightning/pytorch/CHANGELOG.md
           )$
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit

setup.py

@@ -58,7 +58,7 @@
     "fabric": "lightning_fabric",
 }
 # TODO: drop this reverse list when all packages are moved
-_MIRROR_PACKAGE_REVERSED = ("app", "fabric")
+_MIRROR_PACKAGE_REVERSED = ("app", "fabric", "pytorch")
 # https://packaging.python.org/guides/single-sourcing-package-version/
 # http://blog.ionelmc.ro/2014/05/25/python-packaging/
 _PATH_ROOT = os.path.dirname(__file__)
@@ -142,7 +142,7 @@ def _set_manifest_path(manifest_dir: str, aggregate: bool = False, mapping: Mapp
         package_to_install = _PACKAGE_MAPPING.get(_PACKAGE_NAME, "lightning")
         if package_to_install == "lightning":
             # merge all requirements files
-            assistant._load_aggregate_requirements(_PATH_REQUIRE, _FREEZE_REQUIREMENTS)  # install everything
+            assistant._load_aggregate_requirements(_PATH_REQUIRE, _FREEZE_REQUIREMENTS)
         # replace imports and copy the code
         assistant.create_mirror_package(_PATH_SRC, _PACKAGE_MAPPING, reverse=_MIRROR_PACKAGE_REVERSED)
     else:

src/pytorch_lightning/CHANGELOG.md → src/lightning/pytorch/CHANGELOG.md

@@ -207,6 +207,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 ## [1.9.0] - 2023-01-17
 
 ### Added
+
 - Added support for native logging of `MetricCollection` with enabled compute groups ([#15580](https://github.com/Lightning-AI/lightning/pull/15580))
 - Added support for custom artifact names in `pl.loggers.WandbLogger` ([#16173](https://github.com/Lightning-AI/lightning/pull/16173))
 - Added support for DDP with `LRFinder` ([#15304](https://github.com/Lightning-AI/lightning/pull/15304))
@@ -223,7 +224,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Added info message for Ampere CUDA GPU users to enable tf32 matmul precision ([#16037](https://github.com/Lightning-AI/lightning/pull/16037))
 - Added support for returning optimizer-like classes in `LightningModule.configure_optimizers` ([#16189](https://github.com/Lightning-AI/lightning/pull/16189))
 
-
 ### Changed
 
 - Drop PyTorch 1.9 support ([#15347](https://github.com/Lightning-AI/lightning/pull/15347))

src/pytorch_lightning/__init__.py → src/lightning/pytorch/__init__.py

@@ -1,12 +1,18 @@
 """Root package info."""
 
 import logging
+import os
 from typing import Any
 
-from pytorch_lightning.__about__ import *  # noqa: F401, F403
+from lightning_utilities import module_available
 
+if os.path.isfile(os.path.join(os.path.dirname(__file__), "__about__.py")):
+    from lightning.pytorch.__about__ import *  # noqa: F401, F403
 if "__version__" not in locals():
-    from pytorch_lightning.__version__ import version as __version__  # noqa: F401
+    if os.path.isfile(os.path.join(os.path.dirname(__file__), "__version__.py")):
+        from lightning.pytorch.__version__ import version as __version__
+    elif module_available("lightning"):
+        from lightning import __version__  # noqa: F401
 
 _DETAIL = 15  # between logging.INFO and logging.DEBUG, used for logging in production use cases
 
@@ -30,13 +36,13 @@ def _detail(self: Any, message: str, *args: Any, **kwargs: Any) -> None:
     _logger.addHandler(logging.StreamHandler())
     _logger.propagate = False
 
-from lightning_fabric.utilities.seed import seed_everything  # noqa: E402
-from pytorch_lightning.callbacks import Callback  # noqa: E402
-from pytorch_lightning.core import LightningDataModule, LightningModule  # noqa: E402
-from pytorch_lightning.trainer import Trainer  # noqa: E402
+from lightning.fabric.utilities.seed import seed_everything  # noqa: E402
+from lightning.pytorch.callbacks import Callback  # noqa: E402
+from lightning.pytorch.core import LightningDataModule, LightningModule  # noqa: E402
+from lightning.pytorch.trainer import Trainer  # noqa: E402
 
 # this import needs to go last as it will patch other modules
-import pytorch_lightning._graveyard  # noqa: E402, F401  # isort: skip
+import lightning.pytorch._graveyard  # noqa: E402, F401  # isort: skip
 
 __all__ = ["Trainer", "LightningDataModule", "LightningModule", "Callback", "seed_everything"]
 

src/pytorch_lightning/_graveyard/__init__.py → src/lightning/pytorch/_graveyard/__init__.py

@@ -11,4 +11,4 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-import pytorch_lightning._graveyard.legacy_import_unpickler  # noqa: F401
+import lightning.pytorch._graveyard.legacy_import_unpickler  # noqa: F401

src/pytorch_lightning/_graveyard/legacy_import_unpickler.py → src/lightning/pytorch/_graveyard/legacy_import_unpickler.py

@@ -11,7 +11,7 @@ def _patch_pl_to_mirror_if_necessary(module: str) -> str:
     if module.startswith(pl):
         # for the standalone package this won't do anything,
         # for the unified mirror package it will redirect the imports
-        module = "pytorch_lightning" + module[len(pl) :]
+        module = "lightning.pytorch" + module[len(pl) :]
     return module
 
 
@@ -29,7 +29,7 @@ def compare_version(package: str, op: Callable, version: str, use_base_version:
     return _compare_version(new_package, op, version, use_base_version)
 
 
-# patching is necessary, since up to v.0.7.3 torchmetrics has a hardcoded reference to pytorch_lightning,
+# patching is necessary, since up to v.0.7.3 torchmetrics has a hardcoded reference to lightning.pytorch,
 # which has to be redirected to the unified package:
 # https://github.com/Lightning-AI/metrics/blob/v0.7.3/torchmetrics/metric.py#L96
 try:

src/pytorch_lightning/accelerators/__init__.py → src/lightning/pytorch/accelerators/__init__.py

@@ -10,16 +10,16 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from lightning_fabric.accelerators import find_usable_cuda_devices  # noqa: F401
-from lightning_fabric.accelerators.registry import _AcceleratorRegistry, call_register_accelerators
-from pytorch_lightning.accelerators.accelerator import Accelerator  # noqa: F401
-from pytorch_lightning.accelerators.cpu import CPUAccelerator  # noqa: F401
-from pytorch_lightning.accelerators.cuda import CUDAAccelerator  # noqa: F401
-from pytorch_lightning.accelerators.hpu import HPUAccelerator  # noqa: F401
-from pytorch_lightning.accelerators.ipu import IPUAccelerator  # noqa: F401
-from pytorch_lightning.accelerators.mps import MPSAccelerator  # noqa: F401
-from pytorch_lightning.accelerators.tpu import TPUAccelerator  # noqa: F401
+from lightning.fabric.accelerators import find_usable_cuda_devices  # noqa: F401
+from lightning.fabric.accelerators.registry import _AcceleratorRegistry, call_register_accelerators
+from lightning.pytorch.accelerators.accelerator import Accelerator  # noqa: F401
+from lightning.pytorch.accelerators.cpu import CPUAccelerator  # noqa: F401
+from lightning.pytorch.accelerators.cuda import CUDAAccelerator  # noqa: F401
+from lightning.pytorch.accelerators.hpu import HPUAccelerator  # noqa: F401
+from lightning.pytorch.accelerators.ipu import IPUAccelerator  # noqa: F401
+from lightning.pytorch.accelerators.mps import MPSAccelerator  # noqa: F401
+from lightning.pytorch.accelerators.tpu import TPUAccelerator  # noqa: F401
 
-ACCELERATORS_BASE_MODULE = "pytorch_lightning.accelerators"
+ACCELERATORS_BASE_MODULE = "lightning.pytorch.accelerators"
 AcceleratorRegistry = _AcceleratorRegistry()
 call_register_accelerators(AcceleratorRegistry, ACCELERATORS_BASE_MODULE)

src/pytorch_lightning/accelerators/accelerator.py → src/lightning/pytorch/accelerators/accelerator.py

@@ -14,9 +14,9 @@
 from abc import ABC
 from typing import Any, Dict
 
-import pytorch_lightning as pl
-from lightning_fabric.accelerators.accelerator import Accelerator as _Accelerator
-from lightning_fabric.utilities.types import _DEVICE
+import lightning.pytorch as pl
+from lightning.fabric.accelerators.accelerator import Accelerator as _Accelerator
+from lightning.fabric.utilities.types import _DEVICE
 
 
 class Accelerator(_Accelerator, ABC):

src/pytorch_lightning/accelerators/cpu.py → src/lightning/pytorch/accelerators/cpu.py

@@ -15,11 +15,11 @@
 
 import torch
 
-from lightning_fabric.accelerators.cpu import _parse_cpu_cores
-from lightning_fabric.utilities.types import _DEVICE
-from pytorch_lightning.accelerators.accelerator import Accelerator
-from pytorch_lightning.utilities.exceptions import MisconfigurationException
-from pytorch_lightning.utilities.imports import _PSUTIL_AVAILABLE
+from lightning.fabric.accelerators.cpu import _parse_cpu_cores
+from lightning.fabric.utilities.types import _DEVICE
+from lightning.pytorch.accelerators.accelerator import Accelerator
+from lightning.pytorch.utilities.exceptions import MisconfigurationException
+from lightning.pytorch.utilities.imports import _PSUTIL_AVAILABLE
 
 
 class CPUAccelerator(Accelerator):

src/pytorch_lightning/accelerators/cuda.py → src/lightning/pytorch/accelerators/cuda.py

@@ -19,12 +19,12 @@
 
 import torch
 
-import pytorch_lightning as pl
-from lightning_fabric.accelerators.cuda import _check_cuda_matmul_precision, num_cuda_devices
-from lightning_fabric.utilities.device_parser import _parse_gpu_ids
-from lightning_fabric.utilities.types import _DEVICE
-from pytorch_lightning.accelerators.accelerator import Accelerator
-from pytorch_lightning.utilities.exceptions import MisconfigurationException
+import lightning.pytorch as pl
+from lightning.fabric.accelerators.cuda import _check_cuda_matmul_precision, num_cuda_devices
+from lightning.fabric.utilities.device_parser import _parse_gpu_ids
+from lightning.fabric.utilities.types import _DEVICE
+from lightning.pytorch.accelerators.accelerator import Accelerator
+from lightning.pytorch.utilities.exceptions import MisconfigurationException
 
 _log = logging.getLogger(__name__)
 

src/pytorch_lightning/accelerators/hpu.py → src/lightning/pytorch/accelerators/hpu.py

@@ -16,11 +16,11 @@
 
 import torch
 
-from lightning_fabric.utilities.types import _DEVICE
-from pytorch_lightning.accelerators.accelerator import Accelerator
-from pytorch_lightning.utilities.exceptions import MisconfigurationException
-from pytorch_lightning.utilities.imports import _HPU_AVAILABLE
-from pytorch_lightning.utilities.rank_zero import rank_zero_debug
+from lightning.fabric.utilities.types import _DEVICE
+from lightning.pytorch.accelerators.accelerator import Accelerator
+from lightning.pytorch.utilities.exceptions import MisconfigurationException
+from lightning.pytorch.utilities.imports import _HPU_AVAILABLE
+from lightning.pytorch.utilities.rank_zero import rank_zero_debug
 
 if _HPU_AVAILABLE:
     import habana_frameworks.torch.hpu as torch_hpu
@@ -108,7 +108,7 @@ def register_accelerators(cls, accelerator_registry: Dict) -> None:
 def _parse_hpus(devices: Optional[Union[int, str, List[int]]]) -> Optional[int]:
     """
     Parses the hpus given in the format as accepted by the
-    :class:`~pytorch_lightning.trainer.Trainer` for the `devices` flag.
+    :class:`~lightning.pytorch.trainer.Trainer` for the `devices` flag.
 
     Args:
         devices: An integer that indicates the number of Gaudi devices to be used

src/pytorch_lightning/accelerators/ipu.py → src/lightning/pytorch/accelerators/ipu.py

@@ -15,9 +15,9 @@
 
 import torch
 
-from lightning_fabric.utilities.types import _DEVICE
-from pytorch_lightning.accelerators.accelerator import Accelerator
-from pytorch_lightning.utilities.imports import _IPU_AVAILABLE
+from lightning.fabric.utilities.types import _DEVICE
+from lightning.pytorch.accelerators.accelerator import Accelerator
+from lightning.pytorch.utilities.imports import _IPU_AVAILABLE
 
 
 class IPUAccelerator(Accelerator):

src/pytorch_lightning/accelerators/mps.py → src/lightning/pytorch/accelerators/mps.py

@@ -15,12 +15,12 @@
 
 import torch
 
-from lightning_fabric.accelerators.mps import MPSAccelerator as _MPSAccelerator
-from lightning_fabric.utilities.device_parser import _parse_gpu_ids
-from lightning_fabric.utilities.types import _DEVICE
-from pytorch_lightning.accelerators.accelerator import Accelerator
-from pytorch_lightning.utilities.exceptions import MisconfigurationException
-from pytorch_lightning.utilities.imports import _PSUTIL_AVAILABLE
+from lightning.fabric.accelerators.mps import MPSAccelerator as _MPSAccelerator
+from lightning.fabric.utilities.device_parser import _parse_gpu_ids
+from lightning.fabric.utilities.types import _DEVICE
+from lightning.pytorch.accelerators.accelerator import Accelerator
+from lightning.pytorch.utilities.exceptions import MisconfigurationException
+from lightning.pytorch.utilities.imports import _PSUTIL_AVAILABLE
 
 
 class MPSAccelerator(Accelerator):

src/pytorch_lightning/accelerators/tpu.py → src/lightning/pytorch/accelerators/tpu.py

@@ -15,10 +15,10 @@
 
 import torch
 
-from lightning_fabric.accelerators.tpu import _parse_tpu_devices, _XLA_AVAILABLE
-from lightning_fabric.accelerators.tpu import TPUAccelerator as FabricTPUAccelerator
-from lightning_fabric.utilities.types import _DEVICE
-from pytorch_lightning.accelerators.accelerator import Accelerator
+from lightning.fabric.accelerators.tpu import _parse_tpu_devices, _XLA_AVAILABLE
+from lightning.fabric.accelerators.tpu import TPUAccelerator as FabricTPUAccelerator
+from lightning.fabric.utilities.types import _DEVICE
+from lightning.pytorch.accelerators.accelerator import Accelerator
 
 
 class TPUAccelerator(Accelerator):