Skip to content

Conversation

@jerryzh168
Copy link
Contributor

Summary:
att

Test Plan:
.

Reviewers:

Subscribers:

Tasks:

Tags:

@pytorch-bot
Copy link

pytorch-bot bot commented Jun 14, 2024

🔗 Helpful Links

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

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

✅ No Failures

As of commit 19897b2 with merge base 7a3f5a0 (image):
💚 Looks good so far! There are no failures yet. 💚

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

@jerryzh168 jerryzh168 requested a review from msaroufim June 14, 2024 21:17
@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 Jun 14, 2024
@jerryzh168 jerryzh168 changed the title Add doc page to README.md Add doc page to README.md and add quantize to doc page Jun 14, 2024
@jerryzh168 jerryzh168 changed the title Add doc page to README.md and add quantize to doc page Add quantize to doc page Jun 14, 2024
msaroufim
msaroufim previously approved these changes Jun 14, 2024
@msaroufim
Copy link
Member

So I was going over this https://docs-preview.pytorch.org/pytorch/ao/367/generated/torchao.quantization.quantize.ht
Screenshot 2024-06-14 at 3 00 10 PM
ml#torchao.quantization.quantize

The docstrings aren't particularly clear, the main omissions are

  1. Not showing the various algorithms users can pass in a string or callable
  2. weight settings take up too much real estate when some reasonable defaults might be better
  3. you mention subclasses but i'd suspect most users would have no idea what that is
  4. There isn't an example of a filter_fn

@jerryzh168
Copy link
Contributor Author

updated, but I'm not sure how to resolve 3

@msaroufim
Copy link
Member

I'm guessing we can wait on merging this until the UX issues are finalized

Summary:
att

Test Plan:
.

Reviewers:

Subscribers:

Tasks:

Tags:
@jerryzh168
Copy link
Contributor Author

@msaroufim updated, please take a look again

@msaroufim msaroufim merged commit fd9f95d into pytorch:main Jun 22, 2024
@jerryzh168 jerryzh168 deleted the add-doc branch July 2, 2024 20:31
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants