Refresh concurrency docs for async NIF dispatch - #49
Merged
Conversation
After the Phase 1-3 async-worker migration (#41-#43), NIFs no longer block a scheduler on a sync promise — they enqueue on the worker and the public wrapper awaits a reply via enif_send. Update the README Concurrency model section and the CHANGELOG worker-thread-dispatch bullet so they describe the shipping behaviour.
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
1 participant
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.
Summary
enif_sendtransport instead of the oldrun_syncpromise: NIFs enqueue on the worker and return immediately; no scheduler (regular or dirty) blocks on MLX. TheCommandEncoder-consistency note is split into its own paragraph so the flow of the section stays readable.Emily.Stream,Emily.Compiler, and the notebook moduledocs already describe per-process queues without reference to the sync/async transport, so they read correctly under the new model and were left alone.Triggered by PRs #41 #42 #43 (async-worker migration) where the docs were not updated alongside the code change.
Test plan
mix precommit(docs-only diff, full suite still green)