docs: update README to match current code#22
Open
heroarmor wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates README.md to reflect the current scmp_kernels package surface and repository structure (SC kernels, quantization, and mixed-precision modules), aligning documentation with the now-migrated mp/ and quant/ packages and the expanded sc_matmul API.
Changes:
- Refreshes package layout and adds install + test commands.
- Documents the current
sc_matmulsignature (including newer kwargs) and additional SC exports (clear_rng_cache,det_kernel_tuning). - Adds new README sections describing
scmp_kernels.quantandscmp_kernels.mp.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| group_b: int = 1, # row-group size on operand b | ||
| rng_levels: int | None = None, # mixed-precision stream lengths | ||
| config: dict | None = None, # Sobol/Owen config; auto-built if None | ||
| halve_bipolar_stoc_len: bool = False, # bipolar: run at stoc_len/2 |
This file contains hidden or 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
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.
Updates the README to match the current code.
mp/andquant/are now real packages (were marked placeholders); onlyqwt/andsensitivity/remain placeholders.sc_matmulsignature: documents the new keyword args (group_a,group_b,rng_levels,halve_bipolar_stoc_len,smooth_scales) and theclear_rng_cache/det_kernel_tuningexports.scmp_kernels.quant(fused / grouped / smoothquant) andscmp_kernels.mp, plus install and apytest tests/line.Docs only — no code changes.
🤖 Generated with Claude Code