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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add usage of Jupyter magic command for loggers #12333

Merged
merged 10 commits into from Mar 29, 2022
Merged

Add usage of Jupyter magic command for loggers #12333

merged 10 commits into from Mar 29, 2022

Conversation

manangoel99
Copy link
Contributor

@manangoel99 manangoel99 commented Mar 15, 2022

What does this PR do?

This PR adds usage of a jupyter magic command for wandb

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

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 馃檭

CHANGELOG.md Outdated Show resolved Hide resolved
@ananthsub ananthsub added docs Documentation related logger: wandb Weights & Biases labels Mar 15, 2022
@mergify mergify bot removed the has conflicts label Mar 15, 2022
@manangoel99
Copy link
Contributor Author

I've made the suggested changes and pulled the commits from master to this branch to get it up-to-date

Copy link
Contributor

@krshrimali krshrimali left a comment

Choose a reason for hiding this comment

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

Hi, @manangoel99 - Thanks for the PR! Left a minor comment, but also curious: from the description of this PR: This PR rearranges the logger documentation and adds usage of jupyter magic command for wandb.

Can you please point me to the change (line of code) which adds usage of jupyter magic command for wandb in this PR? Got it! :)

I'm also concerned about re-arranging, unless and until it was discussed in an issue before or has a reason that everyone agrees with (if it was discussed before, please feel free to point me to the discussion :)). cc: @kaushikb11 @awaelchli @Borda

docs/source/extensions/logging.rst Outdated Show resolved Hide resolved
docs/source/extensions/logging.rst Outdated Show resolved Hide resolved
@manangoel99 manangoel99 reopened this Mar 16, 2022
@manangoel99
Copy link
Contributor Author

I've put everything back in the alphabetical order and added usage of the %%wandb magic command.

docs/source/common/loggers.rst Outdated Show resolved Hide resolved
docs/source/common/loggers.rst Show resolved Hide resolved
docs/source/common/loggers.rst Outdated Show resolved Hide resolved
@krshrimali
Copy link
Contributor

Thanks, @manangoel99 for updating this PR. Appreciate the contribution. Just FYI (apart from @rohitgr7's comments) - I updated the description and title of this PR, feel free to make further edits if any changes required. :)

@krshrimali krshrimali changed the title Rearrange Logger Documentation Add usage of Jupyter magic command for wandb Mar 16, 2022
@krshrimali krshrimali changed the title Add usage of Jupyter magic command for wandb Add usage of Jupyter magic command for wandb (docs) Mar 16, 2022
docs/source/common/loggers.rst Outdated Show resolved Hide resolved
@rohitgr7 rohitgr7 requested a review from ananthsub March 16, 2022 13:56
manangoel99 and others added 2 commits March 16, 2022 19:34
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

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

@manangoel99 Could we document a magic command for tensorboard as well in this PR?

@krshrimali
Copy link
Contributor

@manangoel99 Could we document a magic command for tensorboard as well in this PR?

That would be a good addition, thanks @akihironitta for suggesting this. @manangoel99 - if you feel comfortable doing it in this PR, that would be great, but if you want to do it in another PR, that's totally fine as well. Just let us know :)

@rohitgr7
Copy link
Contributor

lets add it here

@manangoel99
Copy link
Contributor Author

manangoel99 commented Mar 17, 2022

@krshrimali @rohitgr7 Thanks for adding this to the PR. I actually found the Tensorboard instructions elsewhere so I skipped those initially.
https://pytorch-lightning.readthedocs.io/en/latest/extensions/logging.html

Absolutely no issues in adding it to this PR!

@rohitgr7
Copy link
Contributor

yep! I noticed. But we will probably remove tensorboard as default in the future so the existing one will be updated then.

docs/source/common/loggers.rst Outdated Show resolved Hide resolved
docs/source/common/loggers.rst Show resolved Hide resolved
@awaelchli awaelchli added this to the 1.6 milestone Mar 19, 2022
@akihironitta akihironitta changed the title Add usage of Jupyter magic command for wandb (docs) Add usage of Jupyter magic command for loggers Mar 20, 2022
Co-authored-by: Adrian W盲lchli <aedu.waelchli@gmail.com>
Copy link
Contributor

@krshrimali krshrimali left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @manangoel99 for your contribution.

@mergify mergify bot added the ready PRs ready to be merged label Mar 21, 2022
@carmocca
Copy link
Member

@manangoel99 There are some docs failures:

/home/runner/work/pytorch-lightning/pytorch-lightning/docs/source/common/loggers.rst:: ERROR: Anonymous hyperlink mismatch: 1 references but 0 targets.

cc @rohitgr7 (if you know what's the cause)

@carmocca carmocca removed this from the 1.6 milestone Mar 28, 2022
@rohitgr7 rohitgr7 added this to the 1.6 milestone Mar 28, 2022
@carmocca carmocca enabled auto-merge (squash) March 29, 2022 01:40
@carmocca carmocca merged commit c6cb634 into Lightning-AI:master Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related logger: tensorboard logger: wandb Weights & Biases ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants