From cc6869be6034719355566f2591ca5b8da0513715 Mon Sep 17 00:00:00 2001 From: "J. Borovec" Date: Fri, 14 Feb 2020 22:07:50 +0100 Subject: [PATCH 1/6] add sphinx bot --- .github/workflows/docs-check.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/docs-check.yml diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml new file mode 100644 index 0000000000000..59b8250ee0482 --- /dev/null +++ b/.github/workflows/docs-check.yml @@ -0,0 +1,13 @@ +name: "Pull Request Docs Check" +on: +- pull_request + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + repo-token: "${{ secrets.GITHUB_TOKEN }}" From 8168abfc1418ae297b6e5ad5bb2bfcc29801e5a6 Mon Sep 17 00:00:00 2001 From: "J. Borovec" Date: Fri, 14 Feb 2020 22:25:05 +0100 Subject: [PATCH 2/6] source --- .github/workflows/docs-check.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 59b8250ee0482..ab87dc1f64d34 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -1,4 +1,6 @@ -name: "Pull Request Docs Check" +name: "Docs Check" +# https://github.com/marketplace/actions/sphinx-build + on: - pull_request From 4e54da0816defb85f54e1c6ce443566609cceddb Mon Sep 17 00:00:00 2001 From: "J. Borovec" Date: Sat, 15 Feb 2020 11:10:59 +0100 Subject: [PATCH 3/6] typo --- .github/workflows/docs-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index ab87dc1f64d34..9afc327e0b83f 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -1,4 +1,4 @@ -name: "Docs Check" +name: "Docs check" # https://github.com/marketplace/actions/sphinx-build on: From b17d926bd483857d0489d9c956d6347b29afc0ef Mon Sep 17 00:00:00 2001 From: Ammar Askar Date: Wed, 19 Feb 2020 01:40:43 -0500 Subject: [PATCH 4/6] Make a change to the docs (#2) * Make a change to the docs * Introduce an error * Install git before building docs * Apply suggestions from code review Co-authored-by: Jirka Borovec --- .github/workflows/docs-check.yml | 2 ++ docs/source/apex.rst | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml index 9afc327e0b83f..a871d651ec1b2 100644 --- a/.github/workflows/docs-check.yml +++ b/.github/workflows/docs-check.yml @@ -11,5 +11,7 @@ jobs: - uses: actions/checkout@v1 - uses: ammaraskar/sphinx-action@master with: + # git is requried to clone the docs theme + pre-build-command: "apt-get update -y && apt-get install -y git" docs-folder: "docs/" repo-token: "${{ secrets.GITHUB_TOKEN }}" diff --git a/docs/source/apex.rst b/docs/source/apex.rst index d4dbc4cd589f8..bf63c2c69ae3a 100644 --- a/docs/source/apex.rst +++ b/docs/source/apex.rst @@ -2,6 +2,7 @@ ================= Lightning uses NVIDIA apex to handle 16-bit precision training. + To use 16-bit precision, do two things: 1. Install Apex 2. Set the amp trainer flag. @@ -39,4 +40,4 @@ Enable 16-bit trainer = Trainer(amp_level='O1', use_amp=False) If you need to configure the apex init for your particular use case or want to use a different way of doing -16-bit training, override :meth:`pytorch_lightning.core.LightningModule.configure_apex`. \ No newline at end of file +16-bit training, override :meth:`pytorch_lightning.core.LightningModule.configure_apex`. From 88de6a8eed61999ead97e10ab1fcf0ecc54d2889 Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Wed, 19 Feb 2020 07:42:45 +0100 Subject: [PATCH 5/6] Update docs/source/apex.rst --- docs/source/apex.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/apex.rst b/docs/source/apex.rst index 6a3641893e82c..e1c7a1b2c8364 100644 --- a/docs/source/apex.rst +++ b/docs/source/apex.rst @@ -6,7 +6,6 @@ GPU 16-bit ----------- Lightning uses NVIDIA apex to handle 16-bit precision training. - To use 16-bit precision, do two things: 1. Install Apex From 7f8df2075c5707441a7bba91c9867d387e140461 Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Wed, 19 Feb 2020 07:43:22 +0100 Subject: [PATCH 6/6] Update docs/source/apex.rst