Add quick start guide for first time users #1611
Merged
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
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/ao/1611
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit d20cd0a with merge base e53edaa ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
added
the
CLA Signed
andrewor14
added
the
topic: documentation
andrewor14
force-pushed
the
docs
branch
3 times, most recently
from
3c80fbc to
f4fce97
Compare
drisspg
approved these changes
Jan 24, 2025
supriyar
reviewed
Jan 24, 2025
docs/source/quick_start.rst
Outdated
| torchao. To learn more about the different workflows supported in torchao, | ||
| see our main `README <https://github.com/pytorch/ao/blob/main/README.md>`__. | ||
| For a more detailed overview of quantization in torchao, visit | ||
| `this page <quantization.html>`. |
There was a problem hiding this comment.
looks like this link is broken
supriyar
reviewed
Jan 24, 2025
docs/source/quick_start.rst
Outdated
| `this page <quantization.html>`. | ||
|
|
||
| Finally, if you would like to contribute to torchao, don't forget to check | ||
| out our `contributor guide <contributor_guide.html>`__! |
There was a problem hiding this comment.
also link to issues page for good first issues
Documentation in torchao has been pretty low-level and geared towards developers so far. This commit adds a basic quick start guide for first time users to get familiar with our main quantization flow.
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.
Documentation in torchao has been pretty low-level and geared towards developers so far. This commit adds a basic quick start guide for first time users to get familiar with our main quantization flow.
Preview the docs here: https://docs-preview.pytorch.org/pytorch/ao/1611/index.html