Fix async example plugin docs to match the actual concurrency and output - #6
Open
MaxFreedomPollard wants to merge 1 commit into
Open
Conversation
…nd usage example The docstring and plugin.yaml said asyncio.gather() runs the forward and back translations concurrently. The code gathers the forward translation and a sentiment classifier; the back-translation runs serially afterward because it needs the forward result as input. Update the docs to match, and update the usage example to the real output (Category line and the via/tokens/time footer).
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.
The async reference plugin documented a concurrency pattern the code does not
use. The docstring and the plugin.yaml description both said asyncio.gather()
runs the forward translation and the back-translation together. The code gathers
the forward translation and a sentiment classifier instead, and the
back-translation runs serially afterward because it takes the forward
translation as its input. A call that depends on the forward result cannot run
in parallel with it, so the old text described something impossible, which is
misleading in a reference plugin.
Changes, docs only:
translation and the sentiment classification, and the back-translation is
described as serial with the reason why.
the "via provider/model, tokens, time" footer.
No behavior change.
Fixes #5