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

wandb: Fix example rendering for docs #5905

Merged
merged 40 commits into from
Feb 16, 2021

Conversation

EricCousineau-TRI
Copy link
Contributor

@EricCousineau-TRI EricCousineau-TRI commented Feb 10, 2021

What does this PR do?

Fixes doc rendering bug.

Before:
https://pytorch-lightning.readthedocs.io/en/stable/generated/pytorch_lightning.loggers.WandbLogger.html#pytorch_lightning.loggers.WandbLogger

image

After (local rendering, no style):

image

Before submitting

  • (N/A) 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)
  • (N/A) Did you write any new necessary tests? (not for typos and docs)
  • (N/A) Did you verify new and existing tests pass locally with your changes?
  • (N/A) Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
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
  • Check that target branch and milestone match!

Did you have fun?

Lol, more or less. Was investigating stuff like #981 tho :(

@codecov
Copy link

codecov bot commented Feb 10, 2021

Codecov Report

Merging #5905 (a3ecf97) into master (fcfa7fa) will decrease coverage by 3%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #5905    +/-   ##
=======================================
- Coverage      90%     88%    -3%     
=======================================
  Files         170     170            
  Lines       11784   11784            
=======================================
- Hits        10664   10362   -302     
- Misses       1120    1422   +302     

@mergify mergify bot removed the has conflicts label Feb 10, 2021
@carmocca carmocca added ready PRs ready to be merged docs Documentation related labels Feb 10, 2021
Copy link
Contributor

@carmocca carmocca left a comment

Choose a reason for hiding this comment

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

LGTM!

Changed the base branch since we have blocked commits to master until the 1.3 release

pytorch_lightning/loggers/wandb.py Outdated Show resolved Hide resolved
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
@carmocca carmocca enabled auto-merge (squash) February 10, 2021 17:12
Base automatically changed from release/1.2-dev to master February 11, 2021 14:32
auto-merge was automatically disabled February 11, 2021 14:32

Base branch was modified

mergify bot added 29 commits February 13, 2021 07:37
@carmocca carmocca merged commit 4531b1c into Lightning-AI:master Feb 16, 2021
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.

6 participants