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.

Sign up for GitHub

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

Jump to bottom

Add docs for the Fabric WandbLogger hosted in the wandb SDK #19451

Merged
merged 10 commits into from
Mar 9, 2024
Merged

Add docs for the Fabric WandbLogger hosted in the wandb SDK #19451

merged 10 commits into from
Mar 9, 2024

Conversation

ash0ts
Copy link
Contributor

@ash0ts ash0ts commented Feb 12, 2024 •
edited by github-actions bot
Loading

What does this PR do?

Fixes #<issue_number>

Before submitting
  • Was this discussed/agreed 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 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:

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--19451.org.readthedocs.build/en/19451/

awaelchli and others added 3 commits February 11, 2024 02:00
@github-actions github-actions bot added docs Documentation related fabric lightning.fabric.Fabric labels Feb 12, 2024
@ash0ts
Copy link
Contributor Author

ash0ts commented Feb 12, 2024

@awaelchli I can't directly adjust #19444 so I made this branch and made some adjustments

@ash0ts ash0ts mentioned this pull request Feb 12, 2024
Closed
@awaelchli awaelchli self-assigned this Feb 12, 2024
@awaelchli awaelchli added this to the 2.3 milestone Feb 12, 2024
@awaelchli awaelchli added community This PR is from the community logger: wandb Weights & Biases labels Feb 12, 2024
@awaelchli
Copy link
Contributor

Looks great! Pushed minor fixes for links and added it also to Loggers list under the API section.

@awaelchli awaelchli mentioned this pull request Feb 13, 2024
Closed
7 tasks
@ash0ts ash0ts marked this pull request as ready for review February 14, 2024 18:30
@ash0ts
Copy link
Contributor Author

ash0ts commented Feb 14, 2024

@awaelchli Fixed the wording and all should be good to go 👍

awaelchli
awaelchli reviewed Feb 22, 2024
View reviewed changes
Copy link
Contributor

@awaelchli awaelchli left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks and sorry for the delay. I left a small request below and otherwise good to merge!

docs/source-fabric/guide/loggers/wandb.rst Outdated
Comment on lines 5 to 7
`Weights & Biases (W&B) <https://wandb.ai>`_ is the AI developer platform, with tools for training models, fine-tuning models, and leveraging foundation models.

W&B allows machine learning practitioners to track experiments, visualize data, and share insights with a few lines of.
Copy link
Contributor

Choose a reason for hiding this comment

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

We have a small request here:
Since Lightning AI is also "the AI developer platform with tools for training models etc etc" there is a slight conflict here. Could we maybe keep the focus of the intro on the experiment tracking aspect? The second paragraph is perfect, it's just this sentence here that we would like to adjust.

Maybe just merging it like so would work:

Suggested change
`Weights & Biases (W&B) <https://wandb.ai>`_ is the AI developer platform, with tools for training models, fine-tuning models, and leveraging foundation models.
W&B allows machine learning practitioners to track experiments, visualize data, and share insights with a few lines of.
`Weights & Biases (W&B) <https://wandb.ai>`_ allows machine learning practitioners to track experiments, visualize data, and share insights with a few lines of code.

Otherwise awesome docs!

@awaelchli awaelchli requested a review from carmocca March 8, 2024 01:13
Borda
Borda approved these changes Mar 8, 2024
View reviewed changes
docs/source-fabric/guide/loggers/wandb.rst
.. displayitem::
:header: Fabric WandbLogger Example
:description: Official example of how to use the WandbLogger with Fabric
:button_link: https://colab.research.google.com/github/wandb/examples/blob/master/colabs/pytorch-lightning/Track_PyTorch_Lightning_with_Fabric_and_Wandb.ipynb
Copy link
Member

Choose a reason for hiding this comment

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

Could it be rather a release branch?

Copy link
Contributor

Choose a reason for hiding this comment

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

This should be fine as a starting point.
I lost contact with @ash0ts so I'm not sure if he's going to see this. But I'll merge it for now and hope the link won't get oudated too quickly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello! I just returned PTO with no access to proper internet. What do you mean by release branch in this context?

@mergify mergify bot added the ready PRs ready to be merged label Mar 8, 2024
@awaelchli awaelchli merged commit 096b063 into Lightning-AI:master Mar 9, 2024
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@awaelchli awaelchli awaelchli approved these changes

@Borda Borda Borda approved these changes

@lantiga lantiga Awaiting requested review from lantiga lantiga is a code owner

@carmocca carmocca Awaiting requested review from carmocca

Assignees

@awaelchli awaelchli

Labels
community This PR is from the community docs Documentation related fabric lightning.fabric.Fabric logger: wandb Weights & Biases ready PRs ready to be merged
Projects
None yet
Milestone
2.3
Development

Successfully merging this pull request may close these issues.
3 participants
@ash0ts @awaelchli @Borda