Skip to content

Rename PL installation to pip install lightning #17074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 14, 2023
Merged

Rename PL installation to pip install lightning #17074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe0f810
rename PL installation
aniketmaurya Mar 14, 2023
b2217f6
update
aniketmaurya Mar 14, 2023
69b9e3a
Apply suggestions from code review
Borda Mar 14, 2023
c19078f
Update docs/source-pytorch/starter/installation.rst
awaelchli Mar 14, 2023
9d0443b
Update docs/source-pytorch/starter/installation.rst
awaelchli Mar 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ ______________________________________________________________________
Simple installation from PyPI

```bash
pip install pytorch-lightning
pip install lightning
```

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

```bash
pip install pytorch-lightning['extra']
pip install lightning['extra']
```

#### Conda
Expand Down
2 changes: 1 addition & 1 deletion docs/source-pytorch/accelerators/gpu_intermediate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(),
)

Expand Down
2 changes: 1 addition & 1 deletion docs/source-pytorch/accelerators/tpu_basic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/source-pytorch/extensions/entry_points.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/source-pytorch/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Pip users

.. code-block:: bash

pip install pytorch-lightning
pip install 'lightning'

.. raw:: html

Expand Down
4 changes: 1 addition & 3 deletions docs/source-pytorch/starter/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source-pytorch/starter/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ For `pip <https://pypi.org/project/pytorch-lightning/>`_ users

.. code-block:: bash

pip install pytorch-lightning
pip install lightning

.. raw:: html

Expand Down