SKempiak commited on
Commit
b212c31
·
verified ·
1 Parent(s): 396aad0

Document streaming vs non-streaming; point to metadata.csv

Browse files
Files changed (1) hide show
  1. README.md +53 -0
README.md CHANGED
@@ -45,12 +45,65 @@ A directory name encodes four dimensions:
45
  | **Variant** | `diffusiondb_{100,405,2k}` | Sample size drawn from the DiffusionDB dataset. |
46
  | | `gen1` / `gen2` | Repeated capture batches of the same config. |
47
  | | `unblocked` | Run without rate-limiting/throttling. |
 
48
 
49
  **BFCL workloads** come from the Berkeley Function-Calling Leaderboard v4 categories:
50
  `simple_python` (single function call), `parallel` (multiple calls from one prompt),
51
  `live_multiple` (real-world prompt, pick among many tools), and
52
  `live_parallel_multiple` (real-world prompt, multiple parallel calls among many tools).
53
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
54
  ## Datasets
55
 
56
  | Directory | Capture env | Model / Provider | Workload |
 
45
  | **Variant** | `diffusiondb_{100,405,2k}` | Sample size drawn from the DiffusionDB dataset. |
46
  | | `gen1` / `gen2` | Repeated capture batches of the same config. |
47
  | | `unblocked` | Run without rate-limiting/throttling. |
48
+ | | `streamed` / `stream` | Streaming run. Inconsistently applied — see **Streaming vs non-streaming** below; use `metadata.csv`, not the name. |
49
 
50
  **BFCL workloads** come from the Berkeley Function-Calling Leaderboard v4 categories:
51
  `simple_python` (single function call), `parallel` (multiple calls from one prompt),
52
  `live_multiple` (real-world prompt, pick among many tools), and
53
  `live_parallel_multiple` (real-world prompt, multiple parallel calls among many tools).
54
 
55
+ ## Streaming vs non-streaming
56
+
57
+ **Do not infer this from the directory name.** Use `metadata.csv` at the repo root,
58
+ which carries an explicit `streaming` column for all 61 capture directories:
59
+
60
+ ```python
61
+ import pandas as pd
62
+ meta = pd.read_csv("metadata.csv")
63
+ streamed = meta[meta.streaming == "true"].directory
64
+ ```
65
+
66
+ | `streaming` | Dirs | Meaning |
67
+ |-------------|-----:|---------|
68
+ | `true` | 33 | Response was delivered incrementally (SSE / chunked token stream). |
69
+ | `false` | 19 | Whole response body delivered in one shot. |
70
+ | `unknown` | 6 | Provenance lost; the flag used at capture time is not recoverable. |
71
+ | `n/a` | 3 | Non-LLM baseline (video); API streaming does not apply. |
72
+
73
+ Every row also carries `streaming_evidence`, naming the harness and code path the
74
+ label came from, so the classification is auditable rather than asserted.
75
+
76
+ ### Why the directory name is not reliable
77
+
78
+ The name encodes streaming inconsistently, in four spellings and positions
79
+ (`_streamed_`, `_stream_`, `streamingbfcl`, and none at all). Two traps in particular:
80
+
81
+ - **The 16 `openrouter_*` directories are streaming but carry no stream token.**
82
+ `openrouter_testing/benchmark.py` sets `stream=True` unconditionally in
83
+ `run_openrouter_request()`. A name-based filter misses all 16.
84
+ - **`ethernet_baseline_video_stream` is *not* a streaming LLM run.** It is YouTube
85
+ video streaming — a workload, not a delivery mode. A `grep stream` over directory
86
+ names picks it up wrongly.
87
+
88
+ ### Measured columns
89
+
90
+ `measured_median_downlink_gap_ms` and `measured_frac_gaps_over_5ms` are observed from
91
+ the pcaps (median over ~8 mid-size captures per directory): the inter-arrival gap
92
+ between downlink payload packets from the server.
93
+
94
+ These are **supporting evidence, not the definition of the label**. They separate
95
+ token streaming cleanly (a slow model such as `nemotron_3_super_120b` shows ~420 ms
96
+ gaps; non-streamed bulk delivery shows sub-millisecond gaps), but two confounders make
97
+ them unusable as a standalone classifier:
98
+
99
+ - **Image generation.** A streamed `text_to_image` run delivers large partial-image
100
+ chunks at line rate, so it looks like bulk transfer (~0.1 ms gaps) despite streaming.
101
+ - **Link RTT.** Mobile and tethered captures inflate gaps independently of streaming.
102
+
103
+ The column is blank for 16 directories whose captures have fewer than 10 downlink
104
+ payload packets — too small to measure, which is itself consistent with a single
105
+ non-streamed response body.
106
+
107
  ## Datasets
108
 
109
  | Directory | Capture env | Model / Provider | Workload |