What's wrong with the pytorch lighting doc

LightningModule
1

image
image1571×838 69.7 KB

I can’t see any details of each option in the navigation menu. It’s hard to learn from this document without navigation buttons like on_train_start, on_save_checkpoint, etc

2

@Mo-Junyang
Do the links not work for you? The mentions in the page about hooks like on_train_start etc. should probably link to the API reference, is this what you are saying?

4

Thanks for your reply. I mean, it used to have some hook names which link to the API detail page. But now, I can’t see any hook names on the right side of the web page under the Lightningmodule API
It should look like this

Training
Training Loop
......
…
…
Lightningmodule API
Methods
Properties
Hooks

It seems that I can’t see the sub menu below the Lightningmodule API thing.

5

You are right, I think this is a configuration setting somewhere in the docs build tool. I took a quick look but couldn’t find the proper option to enable a deeper nesting for the menu.
We will find a way to fix it, thanks for reporting.

1 Like
6

@Mo-Junyang This is now fixed in the latest docs version.
https://lightning.ai/docs/pytorch/latest/common/lightning_module.html

image
image848×1876 97.3 KB

Thank you for notifying us!