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

Add LightningLite documentation #10043

Merged
merged 49 commits into from
Oct 22, 2021
Merged

Add LightningLite documentation #10043

merged 49 commits into from
Oct 22, 2021

Conversation

tchaton
Copy link
Contributor

@tchaton tchaton commented Oct 20, 2021

What does this PR do?

This PR adds documentation for LightningLite

Parts of #9987

Fixes #8620

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • 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)
  • 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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
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

Did you have fun?

Make sure you had fun coding 🙃

@tchaton tchaton self-assigned this Oct 20, 2021
@tchaton tchaton changed the base branch from master to lite-poc October 20, 2021 09:51
@github-actions
Copy link
Contributor

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@tchaton tchaton marked this pull request as draft October 20, 2021 09:51
@kaushikb11
Copy link
Contributor

Also, one more thing we could add to docs is How a User could power up their PyTorch Loops with DeepSpeed, Fairscale and XLA without dealing with their APIs.

docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@rohitgr7 rohitgr7 left a comment

Choose a reason for hiding this comment

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

looks awesome 🚀 . just some small comments

docs/source/starter/lightning_lite.rst Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
Comment on lines 256 to 264
def training_step(self, batch, batch_idx):
x = self.forward(batch)
self.log("train_loss", x)
return x

def validation_step(self, batch, batch_idx):
x = self.forward(batch)
self.log("val_loss", x)
return x
Copy link
Contributor

Choose a reason for hiding this comment

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

x isn't loss right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it is.

Copy link
Contributor

Choose a reason for hiding this comment

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

so trainer.predict will return losses? since it just return what forward returns by default.

docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
docs/source/starter/lightning_lite.rst Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Oct 22, 2021
@awaelchli
Copy link
Contributor

Merging this now into POC. We can keep fine tuning it.

@awaelchli awaelchli merged commit 1510661 into lite-poc Oct 22, 2021
@awaelchli awaelchli deleted the lite_doc branch October 22, 2021 11:39
@awaelchli
Copy link
Contributor

Awesome!!!

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.

8 participants