From 5d58736f08778de15796d2652b41431f751839db Mon Sep 17 00:00:00 2001 From: Aniket Maurya Date: Wed, 15 Mar 2023 00:17:56 +0530 Subject: [PATCH] Rename PL installation to `pip install lightning` (#17074) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * rename PL installation * update * Apply suggestions from code review * Update docs/source-pytorch/starter/installation.rst Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> * Update docs/source-pytorch/starter/installation.rst --------- Co-authored-by: Jirka Borovec <6035284+Borda@users.noreply.github.com> Co-authored-by: Adrian Wälchli Co-authored-by: edenlightning <66261195+edenlightning@users.noreply.github.com> --- README.md | 4 ++-- 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 | 4 +--- docs/source-pytorch/starter/introduction.rst | 2 +- 7 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d2f78806cd4b7..38d281afcd5ff 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ ______________________________________________________________________ Simple installation from PyPI ```bash -pip install pytorch-lightning +pip install lightning ``` @@ -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/gpu_intermediate.rst b/docs/source-pytorch/accelerators/gpu_intermediate.rst index e3199d31c57e9..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=["pytorch-lightning"], + 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 6552487f444cb..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 pytorch-lightning + !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 1d6234eba0d67..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=["pytorch-lightning"], + 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 a950b05cd4ef1..8c1b1e0872bab 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' .. raw:: html diff --git a/docs/source-pytorch/starter/installation.rst b/docs/source-pytorch/starter/installation.rst index 136fa427d8e3f..762fa680732bf 100644 --- a/docs/source-pytorch/starter/installation.rst +++ b/docs/source-pytorch/starter/installation.rst @@ -6,9 +6,7 @@ Installation ############ -.. warning:: pip install pytorch-lightning has been deprecated and will stop being updated June 2023. Use pip install lightning instead. ----- ***************************** Apple Silicon (M1/M2/M3) Macs @@ -84,7 +82,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 ^^^^^^^^^^^^^^^^^^^^^^ Custom PyTorch Version diff --git a/docs/source-pytorch/starter/introduction.rst b/docs/source-pytorch/starter/introduction.rst index 57f30a21a9940..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 pytorch-lightning + pip install lightning .. raw:: html