Repository navigation
[Docs] Make "this is a single-user number" part of the claim, not a footnote - #13
Merged
Merged
Conversation
…otnote The 22 % reads as a property of the fork. It is a property of the fork serving one user: add concurrent clients and it falls to 17 %, then 11 %, then nothing at eight, because every arm ran one request at a time. It is now said twice, both above the fold: - a callout directly under the bold claim, before the chart, with the three percentages, the eight-stream tie in milliseconds, the reason (one request at a time) and what to do instead (--batch/--slots); - the chart footer carries it in the image itself, since the chart is what gets screenshotted and reposted: "Single-user figures: both arms ran one request at a time, so the advantage falls to zero at eight concurrent clients, where the two servers are queueing." The eight-stream bullet in the "which row are you" list is shortened so it points at the callout instead of repeating it, and the report's "does not show" list gains the same scaling in words.
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.
Problem and result
The 22 % first-token figure is a single-user number, and the page let it read as a property of the fork. Someone
deciding whether to put this on a shared box would have found the caveat only in the eight-stream row and the "what it
does not show" list, after the chart.
Related discussion
none — documentation only.
Approach
concurrent clients, is gone at eight (9,641 vs 9,659 ms), the reason (the engine serves one request at a time), and
what to do instead (
--batch/--slots, linked todocs/BATCHING.md), with 22 % described as the one-user figure.advantage falls to zero at eight concurrent clients, where the two servers are queueing." The image is what gets
screenshotted, so the qualifier travels with it.
scripts/make-chart.pyregeneratedchart.svg; the three smallsections were checked for clipping and overlap.
the point is made once at full strength.
Validation
Passed:
guidellm/*.json(22.1 / 17.1 / 10.8 / 0.2 %; 9,641 vs9,659 ms at eight).
--batch 0) anddocs/BATCHING.md("By default Strata serves one request ata time").
scripts/make-chart.py; rendered at 1843×1612 and reviewed — threefooter lines inside the canvas, no overlap with the throughput bars, and the eight-stream pair visibly equal.
docs/BATCHING.mdresolves; GitHub's Markdown API renders the callout as a blockquote andthe page keeps 8 tables / 2 images.
Failed:
none observed.
Not run:
Limits
--batch2–8 the shapewould differ and is not claimed.