Sphinx generated documentation #521

Borda · 2019-11-17T23:31:00Z

Before submitting

Was this discussed/approved via a Github issue? (no need for typos, doc improvements)
Did you read the contributor guideline?
Did you make sure to update the docs?
Did you write any new necessary tests?

What does this PR do?

Fixes #465.

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

The main changes:

create Sphinx documentation
move docs from MD to docstring in particular package/modules
CI: add building documentation
rename root_module.root_module -> base_module.lightning

Watch

cd docs
pip install -r requirements.txt
make clean
make html
make latexpdf

then open pytorch-lightning/docs/build/html/index.html

Borda · 2019-11-19T07:18:35Z

@Ir1d do you have practical experience with customization of pytorch_sphinx_theme?
I was able to add it and build but I have not found an option how to overwrite short links and navigation elements...

Ir1d · 2019-11-20T02:14:10Z

@Borda I didn't modify the theme.. perhaps we need to maintain a fork by modifying pytorch_sphinx_theme itself

Borda · 2019-11-22T21:51:02Z

@williamFalcon @Ir1d @neggert @jeffling could you pls have look and new docs...
you can build it locally or I can issue a public version on ReadTheDocs (but it will be public) :]

Borda · 2019-11-22T21:51:58Z

also @williamFalcon I would like to know what paths shall we use for doc/tutorial/blog/etc.

neggert · 2019-11-22T22:16:49Z

Got everything checked out and building. Lots of warnings, but everything seems to have worked okay.

First off, thanks for tackling this. This is a huge undertaking and it's going to be a great improvement to the package.

A couple notes:

Template needs to be tweaked a little bit to remove or fix dead links in the header.
Need to replace they PyTorch logo with something else (do we have an official logo for Lightning?)
Because a lot of the trainer is split up into mixins, the auto-generated doc tree is a little bit confusing. It might be more effective to do what PyTorch does: Create the high-level structure of the docs manually, but pull in autodoc for individual classes/functions/methods. That way we can organize things in a way that makes more sense for the user.

I don't want the perfect to be the enemy of the good, though. A lot of work has gone into getting this all set up, so maybe we just merge this with the understanding that it needs a bit more tweaking before we set RTD to public.

williamFalcon · 2019-11-22T22:24:43Z

@Borda this looks amazing! i agree with @neggert, let’s merge and fix to get it to a spot to publicly launch.

I do also need to build it over the next day or so.

Borda · 2019-11-22T23:04:29Z

Got everything checked out and building. Lots of warnings, but everything seems to have worked okay.

I saw them too, but I wanted to get a feedback if this is the right way to go before I will invest more time to it...

Template needs to be tweaked a little bit to remove or fix dead links in the header.

Sure, depending on how large changes will we need we may need to fork the theme, but first I would need to know what links to keep and what to drop... @williamFalcon

Need to replace they PyTorch logo with something else (do we have an official logo for Lightning?)

yes, there is but it is the sam eas icon of an epic task in JIRA :)

Because a lot of the trainer is split up into mixins, the auto-generated doc tree is a little bit confusing. It might be more effective to do what PyTorch does: Create the high-level structure of the docs manually, but pull in autodoc for individual classes/functions/methods. That way we can organize things in a way that makes more sense for the user.

I will have a look

I don't want the perfect to be the enemy of the good, though. A lot of work has gone into getting this all set up, so maybe we just merge this with the understanding that it needs a bit more tweaking before we set RTD to the public.

I agree that we (me) shall get to stage that it is publishable, but then we shall merge it or move it to created docs branch so also others can help because this just reveals lost of issues which were simply hidden behind the static pages...

williamFalcon · 2019-11-22T23:06:27Z

the lightning logo is on the readme :)

Borda · 2019-11-22T23:13:11Z

https://bestin-it.com/jira-lesson-08-board-workflow-configuration/

awaelchli · 2019-11-24T12:29:40Z

@Borda I see no problem. Lightning IS epic. ;)

Borda · 2019-11-24T17:05:52Z

@neggert I have forked the PyTorch theme and did some adjustment but somehow the logo is not visible, it is probably something in CSS which I do not understand... Could you have look?

Ir1d · 2019-11-24T17:19:50Z

Have you tried replacing this file directly? https://github.com/Borda/lightning_sphinx_theme/blob/master/images/logo.svg

Borda · 2019-11-24T17:34:32Z

Have you tried replacing this file directly? https://github.com/Borda/lightning_sphinx_theme/blob/master/images/logo.svg

these images are irrelevant, you need to look at these inside the package...
Well, it seems to be fixed now... 8-)

Borda · 2019-11-24T18:48:08Z

@williamFalcon @Ir1d @neggert @jeffling I would go for a merge, so pls could you do a review...

Borda · 2019-11-25T11:52:15Z

Todo: ensure back compatibility...

jeffling

Good stuff, only a few nitpicks. I did not read every single word on the actual docs, but we should do a quick review once this is deployed just for readability

.readthedocs.yml

docs/source/intro.md

pytorch_lightning/callbacks/pt_callbacks.py

tests/test_y_logging.py

williamFalcon · 2019-11-27T06:40:34Z

@Borda rebase?

Borda · 2019-11-27T09:35:49Z

yes, working on it right now, there are couple collisions... 😺
Well, it turns out that I have to do a cherry-picking

williamFalcon · 2019-11-28T17:04:07Z

I'm following your instructions @Borda:

cd docs
pip install -r requirements.txt (this was wrong and was missing -r. i just fixed it in your instructions
make clean

I'm getting these errors:

(pytorch-lightning) ➜  pytorch-lightning git:(master) make clean
make: *** No rule to make target `clean'.  Stop.
(pytorch-lightning) ➜  pytorch-lightning git:(master) cd docs
(pytorch-lightning) ➜  docs git:(master) make clean
make: *** No rule to make target `clean'.  Stop.
(pytorch-lightning) ➜  docs git:(master) make html

make: *** No rule to make target `html'.  Stop.
(pytorch-lightning) ➜  docs git:(master)

Ir1d · 2019-11-28T17:09:39Z

are you in the folder of correct Makefile (this PR)?

seems you are in master branch

Borda · 2019-11-28T17:10:38Z

pip install -r requirements.txt --user
sudo pip install -r docs/requirements.txt
cd docs
make clean
make html

CI builds without any problem https://circleci.com/gh/Borda/pytorch-lightning/298
I have it also tested on RTD, see https://torch-lightning.readthedocs.io/en/docs

formatting move docs from MD to docstring in particular package/modules formatting add Sphinx ext. rename root_module to core drop implicit name "_logger" drop duplicate name "overwrite" fix imports use pytorch theme add sample link mapping try fix RTD build use forked template fix some docs warnings fix paths add deprecation warnings fix flake8 fix paths revert refactor revert MLFlowLogger

williamFalcon · 2019-11-28T17:16:31Z

Yup... still nothing.

(pytorch-lightning) ➜  ~ cd ~/Developer/opensource/pytorch-lightning
(pytorch-lightning) ➜  pytorch-lightning git:(master) pip install -r requirements.txt --user

Requirement already satisfied: scikit-learn>=0.20.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 1)) (0.20.2)
Requirement already satisfied: tqdm>=4.35.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 2)) (4.35.0)
Requirement already satisfied: numpy>=1.16.4 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 3)) (1.16.4)
Requirement already satisfied: torch>=1.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 4)) (1.3.0)
Requirement already satisfied: torchvision>=0.3.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 5)) (0.4.1a0+d94043a)
Requirement already satisfied: pandas>=0.24 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 6)) (0.24.2)
Requirement already satisfied: test-tube>=0.6.9 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r requirements.txt (line 7)) (0.7.3)
Requirement already satisfied: scipy>=0.13.3 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from scikit-learn>=0.20.2->-r requirements.txt (line 1)) (1.3.1)
Requirement already satisfied: six in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from torchvision>=0.3.0->-r requirements.txt (line 5)) (1.12.0)
Requirement already satisfied: pillow>=4.1.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from torchvision>=0.3.0->-r requirements.txt (line 5)) (6.0.0)
Requirement already satisfied: pytz>=2011k in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from pandas>=0.24->-r requirements.txt (line 6)) (2019.1)
Requirement already satisfied: python-dateutil>=2.5.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from pandas>=0.24->-r requirements.txt (line 6)) (2.8.0)
Requirement already satisfied: imageio>=2.3.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from test-tube>=0.6.9->-r requirements.txt (line 7)) (2.5.0)
Requirement already satisfied: tb-nightly==1.15.0a20190708 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from test-tube>=0.6.9->-r requirements.txt (line 7)) (1.15.0a20190708)
Requirement already satisfied: future in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from test-tube>=0.6.9->-r requirements.txt (line 7)) (0.18.1)
Requirement already satisfied: protobuf>=3.6.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (3.8.0)
Requirement already satisfied: absl-py>=0.4 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (0.7.1)
Requirement already satisfied: markdown>=2.6.8 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (3.1.1)
Requirement already satisfied: grpcio>=1.6.3 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (1.21.1)
Requirement already satisfied: wheel>=0.26; python_version >= "3" in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (0.33.4)
Requirement already satisfied: werkzeug>=0.11.15 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (0.15.4)
Requirement already satisfied: setuptools>=41.0.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from tb-nightly==1.15.0a20190708->test-tube>=0.6.9->-r requirements.txt (line 7)) (41.0.1)
(pytorch-lightning) ➜  pytorch-lightning git:(master) pip install -r docs/requirements.txt
Requirement already satisfied: mkdocs-material==4.4.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r docs/requirements.txt (line 1)) (4.4.0)
Requirement already satisfied: mkdocs==1.0.4 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r docs/requirements.txt (line 2)) (1.0.4)
Requirement already satisfied: Pygments>=2.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (2.4.1)
Requirement already satisfied: pymdown-extensions>=4.11 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (6.1)
Requirement already satisfied: mkdocs-minify-plugin>=0.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (0.2.1)
Requirement already satisfied: Jinja2>=2.7.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (2.10.3)
Requirement already satisfied: PyYAML>=3.10 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (5.1.2)
Requirement already satisfied: Markdown>=2.3.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (3.1.1)
Requirement already satisfied: tornado>=5.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (6.0.3)
Requirement already satisfied: click>=3.3 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (7.0)
Requirement already satisfied: livereload>=2.5.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (2.6.1)
Requirement already satisfied: pep562 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from pymdown-extensions>=4.11->mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (1.0)
Requirement already satisfied: htmlmin>=0.1.4 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-minify-plugin>=0.2->mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (0.1.12)
Requirement already satisfied: jsmin>=2.2.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-minify-plugin>=0.2->mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (2.2.2)
Requirement already satisfied: MarkupSafe>=0.23 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from Jinja2>=2.7.1->mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (1.1.1)
Requirement already satisfied: setuptools>=36 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from Markdown>=2.3.1->mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (41.0.1)
Requirement already satisfied: six in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from livereload>=2.5.1->mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (1.12.0)
(pytorch-lightning) ➜  pytorch-lightning git:(master) cd docs

(pytorch-lightning) ➜  docs git:(master) make clean
make: *** No rule to make target `clean'.  Stop.
(pytorch-lightning) ➜  docs git:(master) cd ..
(pytorch-lightning) ➜  pytorch-lightning git:(master) ls
LICENSE                    appveyor.yml               mkdocs.yml                 pytest.log                 setup.cfg                  tox.ini
MANIFEST.in                dist                       pip-wheel-metadata         pytorch_lightning          setup.py                   update.sh
README.md                  docs                       pl_examples                pytorch_lightning.egg-info site
Untitled Folder            lightning_logs             pyproject.toml             requirements.txt           tests
(pytorch-lightning) ➜  pytorch-lightning git:(master) sudo pip install -r docs/requirements.txt
WARNING: The directory '/Users/user/Library/Caches/pip/http' or its parent directory is not owned by the current user and the cache has been disabled. Please check the permissions and owner of that directory. If executing pip with sudo, you may want sudo's -H flag.
WARNING: The directory '/Users/user/Library/Caches/pip' or its parent directory is not owned by the current user and caching wheels has been disabled. check the permissions and owner of that directory. If executing pip with sudo, you may want sudo's -H flag.
Requirement already satisfied: mkdocs-material==4.4.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r docs/requirements.txt (line 1)) (4.4.0)
Requirement already satisfied: mkdocs==1.0.4 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from -r docs/requirements.txt (line 2)) (1.0.4)
Requirement already satisfied: mkdocs-minify-plugin>=0.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (0.2.1)
Requirement already satisfied: pymdown-extensions>=4.11 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (6.1)
Requirement already satisfied: Pygments>=2.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (2.4.1)
Requirement already satisfied: click>=3.3 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (7.0)
Requirement already satisfied: Jinja2>=2.7.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (2.10.3)
Requirement already satisfied: tornado>=5.0 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (6.0.3)
Requirement already satisfied: PyYAML>=3.10 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (5.1.2)
Requirement already satisfied: livereload>=2.5.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (2.6.1)
Requirement already satisfied: Markdown>=2.3.1 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (3.1.1)
Requirement already satisfied: htmlmin>=0.1.4 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-minify-plugin>=0.2->mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (0.1.12)
Requirement already satisfied: jsmin>=2.2.2 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from mkdocs-minify-plugin>=0.2->mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (2.2.2)
Requirement already satisfied: pep562 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from pymdown-extensions>=4.11->mkdocs-material==4.4.0->-r docs/requirements.txt (line 1)) (1.0)
Requirement already satisfied: MarkupSafe>=0.23 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from Jinja2>=2.7.1->mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (1.1.1)
Requirement already satisfied: six in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from livereload>=2.5.1->mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (1.12.0)
Requirement already satisfied: setuptools>=36 in /Users/user/miniconda3/envs/pytorch-lightning/lib/python3.7/site-packages (from Markdown>=2.3.1->mkdocs==1.0.4->-r docs/requirements.txt (line 2)) (41.0.1)
(pytorch-lightning) ➜  pytorch-lightning git:(master) cd docs
(pytorch-lightning) ➜  docs git:(master) make clean
make: *** No rule to make target `clean'.  Stop.
(pytorch-lightning) ➜  docs git:(master)

Ir1d · 2019-11-28T17:17:35Z

hi @williamFalcon are you in master branch or this pr?

williamFalcon · 2019-11-28T17:17:47Z

this pr

williamFalcon · 2019-11-28T17:18:37Z

oh wait, i think it went back to master for some reason. hold on

williamFalcon · 2019-11-28T17:28:05Z

@Borda ok, got it to work.

It looks like a good starting point but we need to work on the navigation since it is not intuitive at all right now nor obvious where to find things.

Can we deploy this behind a dev endpoint to see what it looks like right now?

Things that need to be fixed:

simple, intuitive menu on the left
logo

This is a good start, so I'm just going to highlight a few places we should focus on to get it to a good release point.

I assume the people who look in places like this are people contributing to lightning, but we need to show it in a more user friendly way.

This menu should have a Trainer and LightningModule root folder, then a kind of similar structure to the docs we have right now.

Again, this is an amazing v1, so great job! Let's now move to make this more user friendly before we fully switch over to these docs.

williamFalcon · 2019-11-28T17:29:17Z

@Borda I approve to merge this right now (again phenomenal job!).

@neggert @jeffling @Ir1d you guys good to merge as well? this is a big PR so want to get multiple eyes/approvals.

Ir1d · 2019-11-28T17:35:25Z

Talking about dev endpoint.. I'm suggesting netlify again.
Meanwhile it seems @Borda has built this PR on readthedocs

This menu should have a Trainer and LightningModule root folder, then a kind of similar structure to the docs we have right now.

I remember it involves some advanced usage of sphinx? Similar to what pytorch did..? Maintaining a root structure on our own instead of generating automatically? Not so familiar..

Borda · 2019-11-28T17:38:47Z

Can we deploy this behind a dev endpoint to see what it looks like right now?

Not sure about his, it is a bit bond my experience so far...

Things that need to be fixed:

simple, intuitive menu on the left

logo

What do you mean by logo, size?

This is a good start, so I'm just going to highlight a few places we should focus on to get it to a good release point.

for sure, I just wanted to keep the PR straight forward and draw the backbone so since this PR the work can be simpler divided (parallelize) into smaller PRs
btw, also each rebases after the master change and solving collision is a bit painful...

Borda · 2019-11-28T17:40:42Z

@Ir1d I believe that the actual docs is also powered by RTD according to the config in root

Ir1d · 2019-11-28T17:42:50Z

Oh I didn't notice this config before. @Borda Thx
Netlify is really good at deploy previews for docs, saves a lot of time for cloning and builing. https://www.netlify.com/tags/deploy-previews/

Borda · 2019-11-28T17:48:43Z

@Ir1d RTD allows you to have a separate version for each branch even for each tag/release

williamFalcon · 2019-11-28T17:48:44Z

@Borda for the record we use pl not pt

import pytorch_lightning as pl

Borda · 2019-11-28T17:49:21Z

for the record we use pl not pt

typo 👼 and what about tl as torch lightning 😉

Borda · 2019-11-28T17:56:41Z

FYI, this is the fork we are right now using for docs - https://github.com/Borda/lightning_sphinx_theme

jeffling · 2019-11-29T19:30:17Z

Nice job bringing this in!

This was referenced Nov 20, 2019

Documentation for "Restoring training session" #432

Closed

Fix docs with several small changes #533

Closed

Reuse for PyTorch project pytorch/pytorch_sphinx_theme#61

Closed

Borda changed the title ~~Sphinx generated documentation [WIP]~~ Sphinx generated documentation Nov 22, 2019

Borda mentioned this pull request Nov 23, 2019

Refactoring? #541

Closed

Borda changed the title ~~Sphinx generated documentation~~ Sphinx generated documentation [wip] Nov 25, 2019

Borda changed the title ~~Sphinx generated documentation [wip]~~ Sphinx generated documentation Nov 25, 2019

Borda mentioned this pull request Nov 25, 2019

Fix documentation error #545

Closed

4 tasks

jeffling approved these changes Nov 26, 2019

View reviewed changes

.readthedocs.yml Show resolved Hide resolved

.readthedocs.yml Show resolved Hide resolved

docs/source/intro.md Show resolved Hide resolved

pytorch_lightning/callbacks/pt_callbacks.py Show resolved Hide resolved

tests/test_y_logging.py Outdated Show resolved Hide resolved

This was referenced Nov 26, 2019

Update Checkpointing.md #551

Closed

Refactor: name modules #548

Merged

Borda changed the title ~~Sphinx generated documentation~~ Sphinx generated documentation [wip] Nov 27, 2019

Borda changed the title ~~Sphinx generated documentation [wip]~~ Sphinx generated documentation Nov 27, 2019

Borda added 9 commits November 28, 2019 18:11

upgrade req.

54ef811

move MkDocs

1c586c1

create Sphinx

938db01

init Sphinx

ecda865

move md from MkDocs to Sphinx

5fc149c

CI: build docs

4042768

revert example import

b7ebf9f

update link

520c629

Update lightning_module_template.py

ab2744a

williamFalcon merged commit d71556e into Lightning-AI:master Nov 28, 2019

Borda deleted the docs branch November 28, 2019 17:49

Sphinx generated documentation #521

Sphinx generated documentation #521

Conversation

Borda commented Nov 17, 2019 • edited by williamFalcon Loading

Before submitting

What does this PR do?

PR review

The main changes:

Watch

Borda commented Nov 19, 2019 • edited Loading

Ir1d commented Nov 20, 2019

Borda commented Nov 22, 2019

Borda commented Nov 22, 2019

neggert commented Nov 22, 2019

williamFalcon commented Nov 22, 2019 • edited Loading

Borda commented Nov 22, 2019

williamFalcon commented Nov 22, 2019

Borda commented Nov 22, 2019

awaelchli commented Nov 24, 2019

Borda commented Nov 24, 2019

Ir1d commented Nov 24, 2019

Borda commented Nov 24, 2019 • edited Loading

Borda commented Nov 24, 2019

Borda commented Nov 25, 2019

jeffling left a comment

Choose a reason for hiding this comment

williamFalcon commented Nov 27, 2019

Borda commented Nov 27, 2019 • edited Loading

williamFalcon commented Nov 28, 2019 • edited Loading

Ir1d commented Nov 28, 2019 • edited Loading

Borda commented Nov 28, 2019

williamFalcon commented Nov 28, 2019 • edited Loading

Ir1d commented Nov 28, 2019

williamFalcon commented Nov 28, 2019

williamFalcon commented Nov 28, 2019

williamFalcon commented Nov 28, 2019

williamFalcon commented Nov 28, 2019

Ir1d commented Nov 28, 2019 • edited Loading

Borda commented Nov 28, 2019

Borda commented Nov 28, 2019

Ir1d commented Nov 28, 2019 • edited Loading

Borda commented Nov 28, 2019

williamFalcon commented Nov 28, 2019

Borda commented Nov 28, 2019 • edited Loading

Borda commented Nov 28, 2019

jeffling commented Nov 29, 2019

Borda commented Nov 17, 2019 •

edited by williamFalcon

Loading

Borda commented Nov 19, 2019 •

edited

Loading

williamFalcon commented Nov 22, 2019 •

edited

Loading

Borda commented Nov 24, 2019 •

edited

Loading

Borda commented Nov 27, 2019 •

edited

Loading

williamFalcon commented Nov 28, 2019 •

edited

Loading

Ir1d commented Nov 28, 2019 •

edited

Loading

williamFalcon commented Nov 28, 2019 •

edited

Loading

Ir1d commented Nov 28, 2019 •

edited

Loading

Ir1d commented Nov 28, 2019 •

edited

Loading

Borda commented Nov 28, 2019 •

edited

Loading