Skip to content

Commit 5d58736

Browse files
aniketmauryaBordaawaelchliedenlightning
authored
Rename PL installation to pip install lightning (#17074)
* rename PL installation * update * Apply suggestions from code review * Update docs/source-pytorch/starter/installation.rst Co-authored-by: edenlightning <[email protected]> * Update docs/source-pytorch/starter/installation.rst --------- Co-authored-by: Jirka Borovec <[email protected]> Co-authored-by: Adrian Wälchli <[email protected]> Co-authored-by: edenlightning <[email protected]>
1 parent 281efc6 commit 5d58736

File tree

7 files changed

+8
-10
lines changed

7 files changed

+8
-10
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ ______________________________________________________________________
113113
Simple installation from PyPI
114114

115115
```bash
116-
pip install pytorch-lightning
116+
pip install lightning
117117
```
118118

119119
<!-- following section will be skipped from PyPI description -->
@@ -125,7 +125,7 @@ pip install pytorch-lightning
125125
#### Install with optional dependencies
126126

127127
```bash
128-
pip install pytorch-lightning['extra']
128+
pip install lightning['extra']
129129
```
130130

131131
#### Conda

docs/source-pytorch/accelerators/gpu_intermediate.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ We STRONGLY discourage this use because it has limitations (due to Python and Py
120120
author="",
121121
author_email="",
122122
url="https://github.com/YourSeed", # REPLACE WITH YOUR OWN GITHUB PROJECT LINK
123-
install_requires=["pytorch-lightning"],
123+
install_requires=["lightning"],
124124
packages=find_packages(),
125125
)
126126

docs/source-pytorch/accelerators/tpu_basic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ To get a TPU on colab, follow these steps:
8686

8787
.. code-block::
8888
89-
!pip install pytorch-lightning
89+
!pip install lightning
9090
9191
6. Then set up your LightningModule as normal.
9292

docs/source-pytorch/extensions/entry_points.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is a minimal example of the `setup.py` file for the package `my-package`:
2727
setup(
2828
name="my-package",
2929
version="0.0.1",
30-
install_requires=["pytorch-lightning"],
30+
install_requires=["lightning"],
3131
entry_points={
3232
"lightning.pytorch.callbacks_factory": [
3333
# The format here must be [any name]=[module path]:[function name]

docs/source-pytorch/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Pip users
4444

4545
.. code-block:: bash
4646
47-
pip install pytorch-lightning
47+
pip install 'lightning'
4848
4949
.. raw:: html
5050

docs/source-pytorch/starter/installation.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
Installation
77
############
88

9-
.. warning:: pip install pytorch-lightning has been deprecated and will stop being updated June 2023. Use pip install lightning instead.
109

11-
----
1210

1311
*****************************
1412
Apple Silicon (M1/M2/M3) Macs
@@ -84,7 +82,7 @@ If you are deploying models built with Lightning in production and require few d
8482

8583
.. code-block:: bash
8684
87-
pip install pytorch-lightning
85+
pip install lightning
8886
8987
^^^^^^^^^^^^^^^^^^^^^^
9088
Custom PyTorch Version

docs/source-pytorch/starter/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ For `pip <https://pypi.org/project/pytorch-lightning/>`_ users
8181

8282
.. code-block:: bash
8383
84-
pip install pytorch-lightning
84+
pip install lightning
8585
8686
.. raw:: html
8787

0 commit comments

Comments
 (0)