Doc broken / Link broken

[jeremycochoy]

• The readme link "Lightning module" is broken: https://pytorch-lightning.readthedocs.io/en/latest/LightningModule/RequiredTrainerInterface/
• The source link in documentation goes nowhere: https://pytorch-lightning.readthedocs.io/en/latest/logging.html click on source goes to https://github.com/PyTorchLightning/PyTorch-Lightning/blob/pytorch_lightning/logging.py

It is really confusing and worrying for news comer like me who expect a simple and easy to plug api well documented and maintained.

[Borda]

Have you noticed some other broken links?

[neggert]

We just migrated to a new documentation stack, so there are some kinks to work out. Please continue to let us know if you find broken links.

[jeremycochoy]

Thanks for your quick answer.

I am rewriting part of existing code with lightning because I ended up with a similar API (obviously with a restricted set of lightning features) and I think that overall some standardisation of this code everybody always rewrite can be great. So I am mostly going back and forth through the documentation to find the equivalent features.

I find out that "Define a lightning module" and "Fit with a trainer" also seems to be pointing to the previous documentation.

---

I also found a recursive deprecation in your doc. 🙃

min_nb_epochs (int) –
Deprecated since version 0.5.0: Use min_nb_epochs instead. Will remove 0.8.0.

[Borda]

just for the record, I think that the links got broken due to major docs update in #725

[sudarshan85]

Here are few more broken links that I found:

Tutorials:

• START A RESEARCH PROJECT
• 9 KEY LIGHTNING TRICKS

None of the examples have any details in them.

[Borda]

@sudarshan85 do they have text the source code? I do not think so...
but adding blog-post abstract is welcome as a PR... :]

[ChristofHenkel]

broken links are also referenced in https://pypi.org/project/pytorch-lightning/0.2.5/

[Borda]

@ChristofHenkel it is a really old version and me what I say it was not even to possible to build the particular docs anymore... the only thing we can do now is kind of forwarding from https://williamfalcon.github.io/pytorch-lightning/ to the new (organisation) location...
any other idea @PyTorchLightning/core-contributors ?