Skip to content

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

Merged
merged 4 commits into from
Oct 3, 2020
Merged

Some docs update #3794

merged 4 commits into from
Oct 3, 2020

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Oct 2, 2020

What does this PR do?

  • some docs update
  • uses tip block
  • updates new-project, introduction_guide, converting, performance

Related: #3756

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • 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? Otherwise, we ask you to create a separate PR for every change.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

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 🙃

@mergify mergify bot requested a review from a team October 2, 2020 13:16
@ydcjeff ydcjeff changed the title Some docs update Some docs update [CI SKIP] Oct 2, 2020
@codecov
Copy link

codecov bot commented Oct 2, 2020

Codecov Report

Merging #3794 into master will increase coverage by 1%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #3794    +/-   ##
=======================================
+ Coverage      85%     86%    +1%     
=======================================
  Files         110     112     +2     
  Lines        8537    9067   +530     
=======================================
+ Hits         7293    7829   +536     
+ Misses       1244    1238     -6     

@Borda Borda added the docs Documentation related label Oct 2, 2020
@Borda
Copy link
Member

Borda commented Oct 2, 2020

@ydcjeff does the "[CI SKIP]" do something?

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Oct 2, 2020

@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.
But if we want to test in Drone, feel free to edit.

@Borda
Copy link
Member

Borda commented Oct 2, 2020

@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.
But if we want to test in Drone, feel free to edit.

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

Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

lgtm

@mergify mergify bot requested a review from a team October 2, 2020 14:01
@ydcjeff
Copy link
Contributor Author

ydcjeff commented Oct 2, 2020

@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.
But if we want to test in Drone, feel free to edit.

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

Alright, I will be careful next time.

@mergify mergify bot requested a review from a team October 2, 2020 14:11
@Borda Borda changed the title Some docs update [CI SKIP] Some docs update Oct 2, 2020
@Borda Borda requested a review from SkafteNicki October 2, 2020 17:33
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.

I have to admit I am quite perplexed by some of these docs.
Thanks for proof reading them @ydcjeff

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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?

Copy link
Contributor Author

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?

@mergify mergify bot requested a review from a team October 2, 2020 23:18
@mergify mergify bot requested a review from a team October 3, 2020 12:14
@williamFalcon williamFalcon merged commit 6232063 into Lightning-AI:master Oct 3, 2020
@ydcjeff ydcjeff deleted the docs/new_project branch October 3, 2020 13:29
@Borda Borda added this to the 0.10.0 milestone Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants