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

Sparsity getting started docs #1592

Merged
merged 5 commits into from
Jan 22, 2025
Merged

Sparsity getting started docs #1592

merged 5 commits into from
Jan 22, 2025

Conversation

jainapurva
Copy link
Contributor

@jainapurva jainapurva commented Jan 21, 2025

Sparsity section in getting started

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 21, 2025
Copy link

pytorch-bot bot commented Jan 21, 2025

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/ao/1592

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 227fe3c with merge base 5d1444b (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@jainapurva jainapurva requested a review from jcaip January 21, 2025 20:42
model = model.cuda()
sparsify_(model, block_sparse_weight())

Goal
Copy link
Contributor

Choose a reason for hiding this comment

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

I think everything before this can stay in the README, everything below makes sense for docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. I think we can still add the supported APIs in api ref, even the prototype ones. #1590

@jainapurva jainapurva added the topic: documentation Use this tag if this PR adds or improves documentation label Jan 21, 2025
@jainapurva jainapurva requested a review from andrewor14 January 21, 2025 23:21
@jainapurva jainapurva changed the title Sparsity developer_notes Sparsity contribution guide Jan 21, 2025
@jainapurva jainapurva changed the title Sparsity contribution guide Sparsity getting started docs Jan 21, 2025

contributor_guide
sparsity.rst
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you don't need .rst here

@jainapurva jainapurva marked this pull request as ready for review January 22, 2025 20:01
@jainapurva jainapurva merged commit 166a357 into main Jan 22, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. topic: documentation Use this tag if this PR adds or improves documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants