Add new_thread_unsafe_stream to the devices and streams docs - #3968
Open
ayaangazali wants to merge 1 commit into
Open
Add new_thread_unsafe_stream to the devices and streams docs#3968ayaangazali wants to merge 1 commit into
ayaangazali wants to merge 1 commit into
Conversation
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.
Proposed changes
new_thread_unsafe_streamis public and works, and it has a full docstring that cross references :func:new_stream, but it never made it into the API reference. Its two siblingsnew_streamandnew_thread_local_streamare both listed indevices_and_streams.rst, so right now the only way to find this one is to already know it exists.Looks like it was just missed when the API was added in #3578. This adds the one autosummary entry, next to the other two stream constructors.
While I was checking, I also compared every public callable in
mlx.coreagainst the whole ofdocs/srcand this was the only properly bound function absent from the docs. The remaining unlisted names (pow,matrix_norm,cumulative_sum,acosand friends) are plain aliases whose docstrings render under the aliased name, so listing those would show a signature likepower(...)on a page calledpow. I left them alone since that looks deliberate, but happy to revisit if you would rather they were documented too.Checklist
Put an
xin the boxes that apply.pre-commit run --all-filesto format my code / installed pre-commit prior to committing changes(docs only, one line)
for transparency: freshman contributor, i use Claude Code to help me sweep for gaps like this, but i verified the function actually runs, read its docstring, and diffed the full public API against the docs myself before opening. the alias question above is a genuine one, not rhetorical, so tell me if you want those listed as well.