Skip to content

docs index update #17780

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 6 commits into from
Jun 21, 2023
Merged

docs index update #17780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a6358e4
docs update
edenlightning Jun 7, 2023
1fdbaf5
Update docs/source-pytorch/starter/installation.rst
edenlightning Jun 7, 2023
83dad72
Merge branch 'Lightning-AI:master' into docs-j
edenlightning Jun 15, 2023
a18a29b
notebooks
Borda Jun 16, 2023
47023c8
toctree
Borda Jun 16, 2023
1b8991f
Update docs/source-pytorch/starter/installation.rst
edenlightning Jun 21, 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
14 changes: 3 additions & 11 deletions docs/source-pytorch/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,10 @@ Current Lightning Users
.. toctree::
:maxdepth: 1
:name: start
:caption: Get Started
:caption: Home

starter/introduction
starter/installation
Install <starter/installation>
upgrade/migration_guide


Expand Down Expand Up @@ -179,21 +179,13 @@ Current Lightning Users

api_references

.. toctree::
:maxdepth: 1
:name: Examples
:caption: Examples
:glob:

notebooks/**/*


.. toctree::
:maxdepth: 1
:name: More
:caption: More

Community <community/index>
Examples <tutorials>
Glossary <glossary/index>
How to <common/index>

Expand Down
12 changes: 12 additions & 0 deletions docs/source-pytorch/notebooks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:orphan:

PyTorch Lightning Tutorials
===========================

.. toctree::
:maxdepth: 1
:name: Notebooks
:caption: Notebooks
:glob:

notebooks/**/*
24 changes: 6 additions & 18 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,24 +6,6 @@
Installation
############



*****************************
Apple Silicon (M1/M2/M3) Macs
*****************************
While ML related python packages are updated to work with Apple Silicon, you'll need to set 2 environment variables on install.

.. code-block:: bash

# needed for M1/M2/M3
export GRPC_PYTHON_BUILD_SYSTEM_OPENSSL=1
export GRPC_PYTHON_BUILD_SYSTEM_ZLIB=1

python -m pip install -U lightning


----

****************
Install with pip
****************
Expand Down Expand Up @@ -56,6 +38,12 @@ You can also use `Conda Environments <https://docs.conda.io/projects/conda/en/la

----


In case you face difficulty with pulling the GRPC package, please follow this `thread <https://stackoverflow.com/questions/66640705/how-can-i-install-grpcio-on-an-apple-m1-silicon-laptop>`_


----

*****************
Build from Source
*****************
Expand Down
2 changes: 0 additions & 2 deletions docs/source-pytorch/tutorials.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

PyTorch Lightning Tutorials
===========================

Expand Down