From fe0f8108ee4b654666c1e3b65b81b1ac130e73d1 Mon Sep 17 00:00:00 2001 From: Aniket Maurya Date: Tue, 14 Mar 2023 12:09:10 +0530 Subject: [PATCH 1/5] rename PL installation --- README.md | 4 ++-- docs/source-pytorch/accelerators/tpu_basic.rst | 2 +- docs/source-pytorch/index.rst | 2 +- docs/source-pytorch/starter/installation.rst | 4 ++-- docs/source-pytorch/starter/introduction.rst | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d2f78806cd4b7..2aba091dd8087 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ ______________________________________________________________________ Simple installation from PyPI ```bash -pip install pytorch-lightning +pip install lightning'[pytorch]' ``` @@ -125,7 +125,7 @@ pip install pytorch-lightning #### Install with optional dependencies ```bash -pip install pytorch-lightning['extra'] +pip install lightning['extra'] ``` #### Conda diff --git a/docs/source-pytorch/accelerators/tpu_basic.rst b/docs/source-pytorch/accelerators/tpu_basic.rst index 6552487f444cb..e055b15fde34d 100644 --- a/docs/source-pytorch/accelerators/tpu_basic.rst +++ b/docs/source-pytorch/accelerators/tpu_basic.rst @@ -86,7 +86,7 @@ To get a TPU on colab, follow these steps: .. code-block:: - !pip install pytorch-lightning + !pip install lightning'[pytorch]' 6. Then set up your LightningModule as normal. diff --git a/docs/source-pytorch/index.rst b/docs/source-pytorch/index.rst index 1ebda03407ac0..7f725b51638f9 100644 --- a/docs/source-pytorch/index.rst +++ b/docs/source-pytorch/index.rst @@ -44,7 +44,7 @@ Pip users .. code-block:: bash - pip install pytorch-lightning + pip install 'lightning[pytorch]' .. raw:: html diff --git a/docs/source-pytorch/starter/installation.rst b/docs/source-pytorch/starter/installation.rst index 136fa427d8e3f..cba4765df888d 100644 --- a/docs/source-pytorch/starter/installation.rst +++ b/docs/source-pytorch/starter/installation.rst @@ -6,7 +6,7 @@ Installation ############ -.. warning:: pip install pytorch-lightning has been deprecated and will stop being updated June 2023. Use pip install lightning instead. +.. warning:: pip install pytorch-lightning has been deprecated and will stop being updated June 2023. Use *pip install lightning* instead. ---- @@ -84,7 +84,7 @@ If you are deploying models built with Lightning in production and require few d .. code-block:: bash - pip install pytorch-lightning + pip install lightning"[pytorch]" ^^^^^^^^^^^^^^^^^^^^^^ Custom PyTorch Version diff --git a/docs/source-pytorch/starter/introduction.rst b/docs/source-pytorch/starter/introduction.rst index 57f30a21a9940..f5a1b1d3b3e61 100644 --- a/docs/source-pytorch/starter/introduction.rst +++ b/docs/source-pytorch/starter/introduction.rst @@ -81,7 +81,7 @@ For `pip `_ users .. code-block:: bash - pip install pytorch-lightning + pip install lightning'[pytorch]' .. raw:: html From b2217f61b7d0e775899b8317930ce6ab6e8b6e6e Mon Sep 17 00:00:00 2001 From: Aniket Maurya Date: Tue, 14 Mar 2023 13:39:04 +0530 Subject: [PATCH 2/5] update --- docs/source-pytorch/accelerators/gpu_intermediate.rst | 2 +- docs/source-pytorch/extensions/entry_points.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source-pytorch/accelerators/gpu_intermediate.rst b/docs/source-pytorch/accelerators/gpu_intermediate.rst index e3199d31c57e9..cf270e37101be 100644 --- a/docs/source-pytorch/accelerators/gpu_intermediate.rst +++ b/docs/source-pytorch/accelerators/gpu_intermediate.rst @@ -120,7 +120,7 @@ We STRONGLY discourage this use because it has limitations (due to Python and Py author="", author_email="", url="https://github.com/YourSeed", # REPLACE WITH YOUR OWN GITHUB PROJECT LINK - install_requires=["pytorch-lightning"], + install_requires=["lightning[pytorch]"], packages=find_packages(), ) diff --git a/docs/source-pytorch/extensions/entry_points.rst b/docs/source-pytorch/extensions/entry_points.rst index 1d6234eba0d67..43aedf56eddc5 100644 --- a/docs/source-pytorch/extensions/entry_points.rst +++ b/docs/source-pytorch/extensions/entry_points.rst @@ -27,7 +27,7 @@ Here is a minimal example of the `setup.py` file for the package `my-package`: setup( name="my-package", version="0.0.1", - install_requires=["pytorch-lightning"], + install_requires=["lightning[pytorch]"], entry_points={ "lightning.pytorch.callbacks_factory": [ # The format here must be [any name]=[module path]:[function name] From 69b9e3a6e4d79e0a1b8d29245bbb46abcca663d4 Mon Sep 17 00:00:00 2001 From: Jirka Borovec <6035284+Borda@users.noreply.github.com> Date: Tue, 14 Mar 2023 09:17:24 +0100 Subject: [PATCH 3/5] Apply suggestions from code review --- README.md | 2 +- docs/source-pytorch/accelerators/gpu_intermediate.rst | 2 +- docs/source-pytorch/accelerators/tpu_basic.rst | 2 +- docs/source-pytorch/extensions/entry_points.rst | 2 +- docs/source-pytorch/index.rst | 2 +- docs/source-pytorch/starter/installation.rst | 2 +- docs/source-pytorch/starter/introduction.rst | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2aba091dd8087..38d281afcd5ff 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ ______________________________________________________________________ Simple installation from PyPI ```bash -pip install lightning'[pytorch]' +pip install lightning ``` diff --git a/docs/source-pytorch/accelerators/gpu_intermediate.rst b/docs/source-pytorch/accelerators/gpu_intermediate.rst index cf270e37101be..eb92a78fbea60 100644 --- a/docs/source-pytorch/accelerators/gpu_intermediate.rst +++ b/docs/source-pytorch/accelerators/gpu_intermediate.rst @@ -120,7 +120,7 @@ We STRONGLY discourage this use because it has limitations (due to Python and Py author="", author_email="", url="https://github.com/YourSeed", # REPLACE WITH YOUR OWN GITHUB PROJECT LINK - install_requires=["lightning[pytorch]"], + install_requires=["lightning"], packages=find_packages(), ) diff --git a/docs/source-pytorch/accelerators/tpu_basic.rst b/docs/source-pytorch/accelerators/tpu_basic.rst index e055b15fde34d..4ec373ca87312 100644 --- a/docs/source-pytorch/accelerators/tpu_basic.rst +++ b/docs/source-pytorch/accelerators/tpu_basic.rst @@ -86,7 +86,7 @@ To get a TPU on colab, follow these steps: .. code-block:: - !pip install lightning'[pytorch]' + !pip install lightning 6. Then set up your LightningModule as normal. diff --git a/docs/source-pytorch/extensions/entry_points.rst b/docs/source-pytorch/extensions/entry_points.rst index 43aedf56eddc5..bf1279a8d5c66 100644 --- a/docs/source-pytorch/extensions/entry_points.rst +++ b/docs/source-pytorch/extensions/entry_points.rst @@ -27,7 +27,7 @@ Here is a minimal example of the `setup.py` file for the package `my-package`: setup( name="my-package", version="0.0.1", - install_requires=["lightning[pytorch]"], + install_requires=["lightning"], entry_points={ "lightning.pytorch.callbacks_factory": [ # The format here must be [any name]=[module path]:[function name] diff --git a/docs/source-pytorch/index.rst b/docs/source-pytorch/index.rst index 7f725b51638f9..dac869075c140 100644 --- a/docs/source-pytorch/index.rst +++ b/docs/source-pytorch/index.rst @@ -44,7 +44,7 @@ Pip users .. code-block:: bash - pip install 'lightning[pytorch]' + pip install 'lightning' .. raw:: html diff --git a/docs/source-pytorch/starter/installation.rst b/docs/source-pytorch/starter/installation.rst index cba4765df888d..c1b2155ad0c24 100644 --- a/docs/source-pytorch/starter/installation.rst +++ b/docs/source-pytorch/starter/installation.rst @@ -84,7 +84,7 @@ If you are deploying models built with Lightning in production and require few d .. code-block:: bash - pip install lightning"[pytorch]" + pip install lightning ^^^^^^^^^^^^^^^^^^^^^^ Custom PyTorch Version diff --git a/docs/source-pytorch/starter/introduction.rst b/docs/source-pytorch/starter/introduction.rst index f5a1b1d3b3e61..93cdf046e4343 100644 --- a/docs/source-pytorch/starter/introduction.rst +++ b/docs/source-pytorch/starter/introduction.rst @@ -81,7 +81,7 @@ For `pip `_ users .. code-block:: bash - pip install lightning'[pytorch]' + pip install lightning .. raw:: html From c19078f4b988d47cfd679421697579e7d354fb2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20W=C3=A4lchli?= Date: Tue, 14 Mar 2023 10:21:43 -0400 Subject: [PATCH 4/5] Update docs/source-pytorch/starter/installation.rst Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> --- docs/source-pytorch/starter/installation.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source-pytorch/starter/installation.rst b/docs/source-pytorch/starter/installation.rst index c1b2155ad0c24..b65119e6dabd9 100644 --- a/docs/source-pytorch/starter/installation.rst +++ b/docs/source-pytorch/starter/installation.rst @@ -6,7 +6,6 @@ Installation ############ -.. warning:: pip install pytorch-lightning has been deprecated and will stop being updated June 2023. Use *pip install lightning* instead. ---- From 9d0443b891dcbf8d7864098da175ee84e867e050 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20W=C3=A4lchli?= Date: Tue, 14 Mar 2023 10:23:20 -0400 Subject: [PATCH 5/5] Update docs/source-pytorch/starter/installation.rst --- docs/source-pytorch/starter/installation.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source-pytorch/starter/installation.rst b/docs/source-pytorch/starter/installation.rst index b65119e6dabd9..762fa680732bf 100644 --- a/docs/source-pytorch/starter/installation.rst +++ b/docs/source-pytorch/starter/installation.rst @@ -7,7 +7,6 @@ Installation ############ ----- ***************************** Apple Silicon (M1/M2/M3) Macs