From 049f6c576ad32f4878ffadc24d2b03b329dd9b53 Mon Sep 17 00:00:00 2001 From: edenlightning <66261195+edenlightning@users.noreply.github.com> Date: Wed, 21 Jun 2023 12:04:06 -0400 Subject: [PATCH] docs index update (#17780) Co-authored-by: Jirka --- docs/source-pytorch/index.rst | 14 +++--------- docs/source-pytorch/notebooks.rst | 12 ++++++++++ docs/source-pytorch/starter/installation.rst | 24 +++++--------------- docs/source-pytorch/tutorials.rst | 2 -- 4 files changed, 21 insertions(+), 31 deletions(-) create mode 100644 docs/source-pytorch/notebooks.rst diff --git a/docs/source-pytorch/index.rst b/docs/source-pytorch/index.rst index 0bd78b6fb6..0bcbc0f294 100644 --- a/docs/source-pytorch/index.rst +++ b/docs/source-pytorch/index.rst @@ -147,10 +147,10 @@ Current Lightning Users .. toctree:: :maxdepth: 1 :name: start - :caption: Get Started + :caption: Home starter/introduction - starter/installation + Install upgrade/migration_guide @@ -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 + Examples Glossary How to diff --git a/docs/source-pytorch/notebooks.rst b/docs/source-pytorch/notebooks.rst new file mode 100644 index 0000000000..1fcafecd0d --- /dev/null +++ b/docs/source-pytorch/notebooks.rst @@ -0,0 +1,12 @@ +:orphan: + +PyTorch Lightning Tutorials +=========================== + +.. toctree:: + :maxdepth: 1 + :name: Notebooks + :caption: Notebooks + :glob: + + notebooks/**/* diff --git a/docs/source-pytorch/starter/installation.rst b/docs/source-pytorch/starter/installation.rst index d1acd1fd3b..4c7786c240 100644 --- a/docs/source-pytorch/starter/installation.rst +++ b/docs/source-pytorch/starter/installation.rst @@ -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 **************** @@ -56,6 +38,12 @@ You can also use `Conda Environments `_ + + +---- + ***************** Build from Source ***************** diff --git a/docs/source-pytorch/tutorials.rst b/docs/source-pytorch/tutorials.rst index 67b1abbf05..1d69b073bf 100644 --- a/docs/source-pytorch/tutorials.rst +++ b/docs/source-pytorch/tutorials.rst @@ -1,5 +1,3 @@ -:orphan: - PyTorch Lightning Tutorials ===========================