Skip to content

Add gather_qqmm to the ops docs - #4006

Closed
ayaangazali wants to merge 1 commit into
ml-explore:mainfrom
ayaangazali:docs-add-gather-qqmm
Closed

ayaangazali wants to merge 1 commit into
ml-explore:mainfrom
ayaangazali:docs-add-gather-qqmm

Conversation

@ayaangazali

Copy link
Copy Markdown
Contributor

Proposed changes

gather_qqmm was added in #3757 with a full docstring, but the autosummary entry never went in, so it has no page in the ops reference. Its sibling gather_qmm is listed right above where this goes.

>>> mx.gather_qqmm.__doc__.splitlines()[0]
"gather_qqmm(x: array, w: array, /, scales: Optional[array] = None, ...)"

Adding the entry generates mlx.core.gather_qqmm.rst as expected. The only warnings on the new page are the usual target not found: optional ones that every function with optional arguments produces (524 of them repo wide, 8 on the neighbouring gather_qmm page), so this does not add a new kind of warning.

Checklist

Put an x in the boxes that apply.

  • I have read the CONTRIBUTING document
  • I have run pre-commit run --all-files to format my code / installed pre-commit prior to committing changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the necessary documentation (if needed)

(docs only, one line; verified by building the docs and checking the generated stub)


quick note on how i got here: freshman contributor using Claude Code to help me sweep, but i checked that #3757 touched python/src/ops.cpp without touching docs/src/python/ops.rst, confirmed the docstring has no experimental or internal wording that would explain leaving it out, and built the docs to see the page appear. if it was left out on purpose, happy to close this.

@zcbenz

zcbenz commented Aug 5, 2026

Copy link
Copy Markdown
Member

Thanks for adding this but at the moment the API is still work in progress so we would want to hide it from public APIs for a while.

@zcbenz zcbenz closed this Aug 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants