Update README.md #731
Merged
Update README.md #731
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
March 14, 2022 01:29
|
|
||
| ## Quickstart | ||
| ## 📣 Quickstart |
There was a problem hiding this comment.
Can we move the quickstart (or at least the installation section) up higher? I think it would be helpful if it is above the fold
| You can use Composer's speedup methods in two ways: | ||
|
|
||
| * Through a standalone **Functional API** (similar to `torch.nn.functional`) that allows you to integrate them into your existing training code. | ||
| * Using Composer's built-in **Trainer**, which is designed to be performant and automatically takes care of many of the low-level details of using speedup methods. | ||
|
|
||
| #### Example: Functional API [](https://colab.research.google.com/github/mosaicml/composer/blob/dev/notebooks/Composer_Functional.ipynb) |
There was a problem hiding this comment.
maybe move the "open in colab" button to a new line, immediately below the header?
| loss = criterion(outputs, labels) | ||
| loss.backward() | ||
| optimizer.step() | ||
| scheduler.step() | ||
| ``` | ||
|
|
||
| See the official [Composer Functional API Colab notebook](https://colab.research.google.com/github/mosaicml/composer/blob/dev/notebooks/Composer_Functional.ipynb) for more. | ||
|
|
||
| #### Example: Trainer [](https://colab.research.google.com/github/mosaicml/composer/blob/dev/notebooks/up_and_running_with_composer.ipynb) |
There was a problem hiding this comment.
same comment re: moving the open in colab button below.
ravi-mosaicml
approved these changes
Mar 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding revised README with Jonathan's feedback, and improved algorithm tables.