Skip to content

Add Claude MD file #2311

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Claude MD file #2311

wants to merge 1 commit into from

Conversation

drisspg
Copy link
Contributor

@drisspg drisspg commented Jun 5, 2025

Stacked PRs:


Add Claude MD file

stack-info: PR: #2311, branch: drisspg/stack/66
@drisspg drisspg force-pushed the drisspg/stack/66 branch from ccba838 to 2525ed3 Compare June 5, 2025 13:43
Copy link

pytorch-bot bot commented Jun 5, 2025

🔗 Helpful Links

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

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

✅ No Failures

As of commit 2525ed3 with merge base 9cd5851 (image):
💚 Looks good so far! There are no failures yet. 💚

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

@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 5, 2025
@drisspg drisspg added the topic: documentation Use this tag if this PR adds or improves documentation label Jun 5, 2025
@danielvegamyhre
Copy link
Contributor

Some of this would be nice documentation for humans too I think, particularly architecture overview / core component descriptions, as well as the useful commands for building, linting, testing. Maybe we can include some of it in the contributor guide?

@drisspg
Copy link
Contributor Author

drisspg commented Jun 12, 2025

Humans can read this file if they want 😂

@drisspg drisspg requested a review from kimishpatel June 17, 2025 23:17

## Development Commands

### Installation & Build
Copy link
Contributor

Choose a reason for hiding this comment

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

does this install all the pre-reqs? I found that torch wasnt one of those?

Copy link
Contributor

Choose a reason for hiding this comment

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

stamping but this might be good to fix

- `uintx/floatx/` - Unsigned integer and floating-point quantized tensors

**torchao/float8/** - High-performance float8 training
- Delivers up to 1.5x speedup on 512 GPU clusters
Copy link
Contributor

Choose a reason for hiding this comment

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

Compared to what?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fwiw I just ran CC's /setup command to generate but yeah this likely doens't help the model

**torchao/csrc/** - Custom CUDA/CPU kernels
- CUTLASS-based implementations for maximum performance
- ROCm support for AMD GPUs
- CPU kernels with AVX512 optimizations
Copy link
Contributor

Choose a reason for hiding this comment

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

@metascroy maybe add details on experimental folder including mps kernels.

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.

5 participants