docs: remove non-existent request_counts and expired status from async example - #280
Merged
Merged
Conversation
10 tasks
18 tasks
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.
Description
The polling example in
docs/async-batch-submission.mdreferenced a batch field and a status value the server never produces:b.get("request_counts", {})—BatchObject(batchgen/server/io_struct.py:177) has norequest_countsfield (nor any per-request completed/total counts), so the example always printed0/0 okregardless of real progress. Removed the line and the count from the print."expired"status (two terminal-status tuples) —BatchStatus(io_struct.py:154) defines onlyvalidating, in_progress, completed, failed, cancelling, cancelled."expired"never matches. Removed it from both tuples.The example still prints status + elapsed +
output_file_id, all of which are realBatchObjectfields.Motivation
Copy-pasting the example gave silently-wrong progress output. Resolves #279.
close #279
Type of Change
modelkernelcorefixinfradocs— documentation onlyFile changes
docs/async-batch-submission.mdrequest_countsusage +"expired"status from the polling exampleChecklist
PR Merge Policy Contract — pre-merge checklist
git diff --stat origin/mainreviewed; every change traces to the task (§3.1).docs); onlydocs/**touched (§2.5).Co-Authored-By(§4).io_struct.py(BatchObject,BatchStatus).