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

New speed documentation #7665

Merged
merged 45 commits into from
Jun 16, 2021
Merged

New speed documentation #7665

merged 45 commits into from
Jun 16, 2021

Conversation

edenlightning
Copy link
Contributor

@edenlightning edenlightning commented May 23, 2021

1/N docs restructure #7666.

Includes a guide to speed up model training:

  • GPU/TPU training
  • Mixed precision (16-bit) training
  • Control Training Epochs
  • Control Validation Frequency
  • Limit Dataset Size
  • Preload Data Into RAM
  • Model Toggling
  • Set Grads to None
  • Things to avoid

@codecov
Copy link

codecov bot commented May 23, 2021

Codecov Report

Merging #7665 (7cf96ea) into master (55494e8) will decrease coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #7665   +/-   ##
======================================
- Coverage      92%     91%   -0%     
======================================
  Files         207     207           
  Lines       13374   13374           
======================================
- Hits        12246   12208   -38     
- Misses       1128    1166   +38     

@edenlightning edenlightning changed the title Docs/new speed New speed documentation May 23, 2021
@edenlightning edenlightning marked this pull request as draft May 23, 2021 14:45
docs/source/guides/speed.rst Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
@kaushikb11
Copy link
Contributor

Could we rename it to performance instead?

@edenlightning
Copy link
Contributor Author

edenlightning commented Jun 10, 2021

Thanks for the review @kaushikb11 ! You mean rename the guide? What would you call it? The idea is to make these guides actionable... like how to do X

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 really love all the "use when" additions! Great idea <3

docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Show resolved Hide resolved
docs/source/guides/speed.rst Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
Copy link
Member

@ethanwharris ethanwharris left a comment

Choose a reason for hiding this comment

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

LGTM, minor suggestions 😃

docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Show resolved Hide resolved
@justusschock
Copy link
Member

One general question: Similar to those .. note:: or .. warning:: boxes, do you think it makes sense to add boxes (maybe in lightning-lila) for .. use-when:: as well? So that the use cases are even more highlighted? (Not necessarily for this PR, but in general/long-term)

@edenlightning
Copy link
Contributor Author

@justusschock great suggestion!! Any idea how to do that?

@justusschock
Copy link
Member

justusschock commented Jun 15, 2021

@edenlightning From what I just read, this should be possible with a combination of this, this and this. Unfortunately I really don't know myself around with CSS and that stuff at all, so I really cannot take this one, sorry!

@aribornstein
Copy link
Contributor

LGTM

Copy link
Contributor

@aribornstein aribornstein left a comment

Choose a reason for hiding this comment

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

LGTM

@edenlightning edenlightning enabled auto-merge (squash) June 16, 2021 17:13
docs/source/common/trainer.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
docs/source/guides/speed.rst Outdated Show resolved Hide resolved
edenlightning and others added 2 commits June 16, 2021 14:08
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
@edenlightning edenlightning merged commit 5647087 into master Jun 16, 2021
@edenlightning edenlightning deleted the docs/new-speed branch June 16, 2021 21:28
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.

9 participants