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

Add Promoted CLI to API Reference Section #14072

Merged
merged 1 commit into from
Aug 8, 2022

Conversation

speediedan
Copy link
Contributor

@speediedan speediedan commented Aug 6, 2022

What does this PR do?

Fixes #14071

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

This PR fixes the issue by simply adding the new api location (in addition to keeping 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!

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

[n/a] Was this discussed/approved via a GitHub issue? (not for typos and docs)
[n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Aug 6, 2022
@speediedan speediedan marked this pull request as ready for review August 6, 2022 23:17
@akihironitta akihironitta added docs Documentation related lightningcli pl.cli.LightningCLI labels Aug 7, 2022
@akihironitta akihironitta added this to the pl:1.8 milestone Aug 7, 2022
@mergify mergify bot added the ready PRs ready to be merged label Aug 7, 2022
@Borda Borda merged commit 355fda3 into Lightning-AI:master Aug 8, 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 pl Generic label for PyTorch Lightning package ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Promoted CLI Missing From API Reference Section
4 participants