Skip to content

[docs] Clear up default logging, showing you don't need to pass a logger #9408

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

Merged
merged 2 commits into from
Sep 10, 2021

Conversation

SeanNaren
Copy link
Contributor

What does this PR do?

Clear up that you do not need to provide a logger to the Trainer, as by default it supports tensorboard.

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?
  • 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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read 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 🙃

@SeanNaren SeanNaren added the docs Documentation related label Sep 9, 2021
@SeanNaren SeanNaren self-assigned this Sep 9, 2021
@SeanNaren SeanNaren added this to the v1.5 milestone Sep 9, 2021
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
careful not to commit the _notebooks changes :)

@SeanNaren
Copy link
Contributor Author

As @awaelchli brought up, this does duplicate information in some of the start guide, however when I googled lightning logging this was the first page that came up!

@SeanNaren SeanNaren marked this pull request as ready for review September 9, 2021 18:17
@mergify mergify bot added the ready PRs ready to be merged label Sep 9, 2021
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

@SeanNaren SeanNaren enabled auto-merge (squash) September 10, 2021 12:49
@codecov
Copy link

codecov bot commented Sep 10, 2021

Codecov Report

Merging #9408 (411c3d5) into master (439db22) will increase coverage by 1%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #9408    +/-   ##
=======================================
+ Coverage      92%     93%    +1%     
=======================================
  Files         179     180     +1     
  Lines       14904   14964    +60     
=======================================
+ Hits        13750   13903   +153     
+ Misses       1154    1061    -93     

@SeanNaren SeanNaren merged commit 81687aa into master Sep 10, 2021
@SeanNaren SeanNaren deleted the docs/logging branch September 10, 2021 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants