Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Promoted CLI Missing From API Reference Section #14071

Closed
speediedan opened this issue Aug 6, 2022 · 0 comments · Fixed by #14072
Closed

Promoted CLI Missing From API Reference Section #14071

speediedan opened this issue Aug 6, 2022 · 0 comments · Fixed by #14072
Labels
docs Documentation related lightningcli pl.cli.LightningCLI

Comments

@speediedan
Copy link
Contributor

speediedan commented Aug 6, 2022

Thanks for your immensely valuable contributions to the ML research community!

I've noticed that since the recent promotion of the cli out of utilities, the new location is missing its reference in the API Reference:

python -msphinx.ext.intersphinx https://pytorch-lightning.readthedocs.io/en/latest/objects.inv | grep "pytorch_lightning.*.cli.LightningCLI "

pytorch_lightning.utilities.cli.LightningCLI api/pytorch_lightning.utilities.cli.html#pytorch_lightning.utilities.cli.LightningCLI

I'm submitting a PR shortly to fix this issue by simply adding the new api location (in addition to the deprecated existing one) so that intersphinx references to the CLI can be updated to the new location and that the new location is properly reflected in the API Reference section:

python -msphinx.ext.intersphinx ../build/html/objects.inv | grep 'pytorch_lightning.*.cli.LightningCLI '

pytorch_lightning.cli.LightningCLI       api/pytorch_lightning.cli.LightningCLI.html#pytorch_lightning.cli.LightningCLI
pytorch_lightning.utilities.cli.LightningCLI api/pytorch_lightning.utilities.cli.html#pytorch_lightning.utilities.cli.LightningCLI
...

Thanks again!

cc @Borda @rohitgr7 @carmocca @mauvilsa

@speediedan speediedan added the needs triage Waiting to be triaged by maintainers label Aug 6, 2022
@speediedan speediedan changed the title Promoted CLI Missing From API References Section Promoted CLI Missing From API Reference Section Aug 6, 2022
@akihironitta akihironitta added docs Documentation related lightningcli pl.cli.LightningCLI and removed needs triage Waiting to be triaged by maintainers labels Aug 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related lightningcli pl.cli.LightningCLI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants