pytorch-lightning icon indicating copy to clipboard operation
pytorch-lightning copied to clipboard

Added note about custom base images

Open Felonious-Spellfire opened this issue 3 years ago • 3 comments

What does this PR do?

Provides a waring for users about custom base images

Fixes #<issue_number>

LAI2-9988

Before submitting

  • [ ] Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • [ ] 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?
  • [X] 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?
  • [ ] Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

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:

  • [X] 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 🙃

cc @borda @rohitgr7 @Felonious-Spellfire

Felonious-Spellfire avatar Aug 09 '22 21:08 Felonious-Spellfire

In https://github.com/Lightning-AI/lightning/issues/14230#issuecomment-1216707414 and on Slack @williamFalcon said he wants us to handle this directly in the code.

So for this case, we should not add it to the docs and instead create an error when a build config is specified on the default cloud compute.

Created an issue here: #14278 I suggest to close the PR

awaelchli avatar Aug 18 '22 10:08 awaelchli

Do we need to close this PR though? Nothing wrong in documenting a warning which is also raised from the code, IMHO

hhsecond avatar Aug 18 '22 10:08 hhsecond

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://pytorch-lightning.readthedocs.io/en/latest/generated/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Slack. Thank you for your contributions.

stale[bot] avatar Sep 20 '22 21:09 stale[bot]

Unassigning for now. If it should be continued, feel free to reassign the new owner for this.

justusschock avatar Nov 09 '22 12:11 justusschock

⚡ Required checks status: All passing 🟢

Groups summary

🟢 lightning_app: Docs
Check ID Status
make-doctest (app) success
make-html (app) success

These checks are required after the changes to docs/source-app/core_api/lightning_work/compute_content.rst, docs/source-app/glossary/build_config/build_config_basic.rst, docs/source-app/glossary/build_config/build_config_intermediate.rst.


Thank you for your contribution! 💜

Note This comment is automatically generated and updates for 60 minutes every 180 seconds. If you have any other questions, contact carmocca for help.

github-actions[bot] avatar Nov 26 '22 21:11 github-actions[bot]