-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Some docs update #3794
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
Some docs update #3794
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3794 +/- ##
=======================================
+ Coverage 85% 86% +1%
=======================================
Files 110 112 +2
Lines 8537 9067 +530
=======================================
+ Hits 7293 7829 +536
+ Misses 1244 1238 -6 |
@ydcjeff does the "[CI SKIP]" do something? |
It skips Drone since this is a docs update PR and no doctest in Drone (I think). So, I don't think GPU testing is necessary. |
well then it is tricky since we do not have it in mandatory checks... so it will appear as all green even the GPU and allow merge as the test is skipped... I would not say this much loudly... :D |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Alright, I will be careful next time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have to admit I am quite perplexed by some of these docs.
Thanks for proof reading them @ydcjeff
docs/source/performance.rst
Outdated
@@ -42,7 +42,7 @@ use `distributed_backend=ddp` so you can increase the `num_workers`, however you | |||
|
|||
.item(), .numpy(), .cpu() | |||
------------------------- | |||
Don't call .item() anywhere on your code. Use `.detach()` instead to remove the connected graph calls. Lightning | |||
Don't call ``.item()`` anywhere on your code. Use ``.detach()`` instead to remove the connected graph calls. Lightning |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't call ``.item()`` anywhere on your code. Use ``.detach()`` instead to remove the connected graph calls. Lightning | |
Don't call ``.item()`` anywhere in your code. Use ``.detach()`` instead to remove the connected graph calls. Lightning |
This advice of not calling item ANYWHERE in your code is a bit strange. I think everyone who used PyTorch a little bit knows what .item does and when not to use it. This has nothing todo with Lightning. I think mentioning these things like .detach in this introduction is just confusing, and it has nothing todo with Lightning.
Also, what does "Lightning takes a great deal of care to be optimized for this" mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It maybe wants to say Lightning has already called .item when needed and not called when unneeded, I think?
What does this PR do?
tip
blockRelated: #3756
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃