Skip to content

feat(analysis): turn-messages viewer with vendored fzstd decompressor #1115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ajcasagrande wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(analysis): turn-messages viewer with vendored fzstd decompressor #1115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion ATTRIBUTIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,10 +192,45 @@ This document provides attribution information for public domain assets used in
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.

## Code Assets

### fzstd (Zstandard decompressor)

**Asset Information:**
- **File(s)**: [`src/aiperf/analysis/fzstd.umd.js`](src/aiperf/analysis/fzstd.umd.js) (vendored UMD build, v0.1.1)
- **Source**: [101arrowz/fzstd](https://github.com/101arrowz/fzstd) (npm: `fzstd`)
- **Author**: Arjun Barrett
- **License**: MIT License
- **Usage**: Inlined into the `aiperf turn-messages` HTML viewer to decompress the embedded zstd payload client-side (no network, no WASM).

**License Text:**

> MIT License
>
> Copyright (c) 2020 Arjun Barrett
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.

## Usage Summary

- **Public domain assets** (ShareGPT conversation data) - no legal restrictions on use
- **MIT-licensed assets** (tiktoken encoding data) - permissive, requires copyright notice retention
- **MIT-licensed assets** (tiktoken encoding data, fzstd zstd decompressor) - permissive, requires copyright notice retention
- **All assets compatible with Apache 2.0** license used by this project
- **No endorsement implied** by original sources

Expand Down
33 changes: 33 additions & 0 deletions docs/cli-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ Assemble per-category SPEED-Bench aiperf results into a matrix report.

Synthesize a dataset workload.

### [`turn-messages`](#aiperf-turn-messages)

Render a collapsible HTML viewer of the per-turn input messages a run sent.

### [`validate`](#aiperf-validate)

Validate a benchmark artifact.
Expand Down Expand Up @@ -3026,6 +3030,35 @@ Maximum output sequence length.

<hr/>

## `aiperf turn-messages`

Render a collapsible HTML viewer of the per-turn input messages a run sent.

#### `--run-dirs`, `--empty-run-dirs` `<list>` _(Required)_

One or more AIPerf run directories.

#### `-o`, `--out` `<str>`

Output HTML path. Only valid when a single run directory is given.

#### `-n`, `--limit-conversations` `<int>`

Max conversations to render (roots first, then by earliest request time).
<br/>_Default: `40`_

#### `--max-turns` `<int>`

Max turns rendered per conversation; the rest are summarized as a hidden count.
<br/>_Default: `60`_

#### `--content-cap` `<int>`

Max characters kept per unique message body; longer bodies are truncated with a remaining-chars note. Raise for full fidelity.
<br/>_Default: `8000`_

<hr/>
Comment on lines +3033 to +3060

@coderabbitai coderabbitai Bot Jul 8, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Keep the heading hierarchy valid. The new section jumps from H2 to H4, which triggers MD001 here. Add an intermediate H3 (or regenerate the section structure) so the docs stay lint-clean.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 3037-3037: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/cli-options.md` around lines 3033 - 3060, The new aiperf turn-messages
docs section skips heading levels and jumps from the H2 title to H4 option
entries, causing the markdown hierarchy to be invalid. Update the section
structure so the option list is nested under an intermediate H3 (or otherwise
regenerate the headings) while preserving the existing content around aiperf
turn-messages, --run-dirs, --out, --limit-conversations, --max-turns, and
--content-cap.

Source: Linters/SAST tools


## `aiperf validate`

Validate a benchmark artifact.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,4 +264,4 @@ filterwarnings = [

[tool.codespell]
skip = "*.pyc,*build*,tests/unit/transports/test_aiohttp_sse.py,tests/integration/assets/canary_reference_inputs.json,src/aiperf/server_metrics/units.py,src/aiperf/api/static/dashboard.html,src/aiperf/config/schema/aiperf-config.schema.json"
ignore-words-list = "timeslice,timeslices,optiona,disjointness,concurency"
ignore-words-list = "timeslice,timeslices,optiona,disjointness,concurency,clen"
31 changes: 31 additions & 0 deletions src/aiperf/analysis/fzstd.umd.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading