2makeitwork commited on
Commit
284f78d
·
verified ·
1 Parent(s): fc45cd5

Data layer at release v1.0.0: frozen-snapshot notice replaces the pre-release notice; CITATION.cff version 1.0.0

Browse files
CITATION.cff CHANGED
@@ -7,7 +7,7 @@ message: >-
7
  bundle, and the commit for the tooling that produced a number. See
8
  the dataset card's Citation section for the citation rules (snapshot not branch; name
9
  the collection round; cite client version plus service, not the model alone).
10
- This is a pre-release (last revised 2026-09-11): cite the snapshot, never a branch.
11
  title: "AI Service QoS: An Independent Outside-In Measurement Methodology, with Case Study 1 (Qwen3.8-Max / Qoder)"
12
  authors:
13
  - name: "2makeitwork"
@@ -15,8 +15,8 @@ authors:
15
  # affiliation is to be added here or in any listing, archive record or citation form
16
  # Do not attempt to resolve the handle to a person.
17
  type: dataset
18
- version: "0.3.0-pre.4" # matches the tag v0.3.0-pre.4, the newest citable snapshot; scripts/preflight.sh --release <tag> refuses if they differ
19
- date-released: "2026-09-11" # last revision of the document set, not a release date
20
  # doi: "" # dataset DOI, then paper-page DOI
21
  repository-code: "https://github.com/2makeitwork/paper_ai_Qos"
22
  repository-artifact: "https://huggingface.co/datasets/2makeitwork/paper_ai_Qos"
@@ -24,7 +24,7 @@ license: >-
24
  CC-BY-4.0 (text, tables, figures and evidence data; see LICENSE-content.md);
25
  MIT (executable tooling under scripts/; see LICENSE-code.md)
26
  # A commit hash cannot be written into the commit it names, so the snapshot to cite is the
27
- # tag: v0.3.0-pre.4. Zenodo's GitHub integration mints the version DOI from the release page.
28
  keywords:
29
  - AI service quality
30
  - large language model service measurement
@@ -43,6 +43,14 @@ preferred-citation:
43
  # url: "https://huggingface.co/papers/..." # paper page once published
44
  institution: "Independent"
45
  versions:
 
 
 
 
 
 
 
 
46
  - date-released: "2026-09-11"
47
  version: "0.3.0-pre.4"
48
  changes: "Pre-release line. Methodology v0.1 with Case Study 1: paper section 1.4 rebuilt as a
 
7
  bundle, and the commit for the tooling that produced a number. See
8
  the dataset card's Citation section for the citation rules (snapshot not branch; name
9
  the collection round; cite client version plus service, not the model alone).
10
+ Released 2026-09-11 as version 1.0.0 (methodology v0.1): cite the tag or the DOI, never a branch.
11
  title: "AI Service QoS: An Independent Outside-In Measurement Methodology, with Case Study 1 (Qwen3.8-Max / Qoder)"
12
  authors:
13
  - name: "2makeitwork"
 
15
  # affiliation is to be added here or in any listing, archive record or citation form
16
  # Do not attempt to resolve the handle to a person.
17
  type: dataset
18
+ version: "1.0.0" # matches the tag v1.0.0, the citable snapshot; scripts/preflight.sh --release <tag> and scripts/analyze.py both refuse if they differ
19
+ date-released: "2026-09-11" # the release date of version 1.0.0
20
  # doi: "" # dataset DOI, then paper-page DOI
21
  repository-code: "https://github.com/2makeitwork/paper_ai_Qos"
22
  repository-artifact: "https://huggingface.co/datasets/2makeitwork/paper_ai_Qos"
 
24
  CC-BY-4.0 (text, tables, figures and evidence data; see LICENSE-content.md);
25
  MIT (executable tooling under scripts/; see LICENSE-code.md)
26
  # A commit hash cannot be written into the commit it names, so the snapshot to cite is the
27
+ # tag: v1.0.0. Zenodo's GitHub integration mints the version DOI from the release page.
28
  keywords:
29
  - AI service quality
30
  - large language model service measurement
 
43
  # url: "https://huggingface.co/papers/..." # paper page once published
44
  institution: "Independent"
45
  versions:
46
+ - date-released: "2026-09-11"
47
+ version: "1.0.0"
48
+ changes: "Formal release of methodology v0.1 with Case Study 1. The contribution is positioned
49
+ as a novelty of perspective rather than of method: the instruments are shared with prior
50
+ external measurement, while the vantage — the paying user's side, published as a stratified
51
+ public aggregate that checks a provider against its own quality-of-service claim without its
52
+ cooperation — is occupied by none of them. Section 7.1 states the institution this serves and
53
+ the two design duties not yet discharged."
54
  - date-released: "2026-09-11"
55
  version: "0.3.0-pre.4"
56
  changes: "Pre-release line. Methodology v0.1 with Case Study 1: paper section 1.4 rebuilt as a
README.md CHANGED
@@ -41,11 +41,14 @@ configs:
41
  path: evidence/logs/timeout_resume_events.csv
42
  ---
43
 
44
- > **Pre-release, last revised 2026-09-11** (methodology v0.1). Definitions, wording and figures
45
- > may still change; cite a snapshot — a release tag or a commit, not a branch — so that a later
46
- > revision cannot move what your citation points at. Every figure quoted in this document set is
47
- > asserted against the shipped evidence by `scripts/analyze.py`, which fails when a number and the
48
- > evidence disagree and warns when a file is edited after the date above.
 
 
 
49
 
50
  **AI Service QoS — Independent Measurement of What Users Actually Receive** — methodology v0.1, and the first data product of an independent, outside-in measurement framework. The system measured here is **Case Study 1**, not the subject: the framework claims provider neutrality and one provider is not proof of it — a second provider measured with *these same definitions and no new ones* is the test (paper section 7, Stage 3).
51
 
@@ -81,7 +84,7 @@ recomputed from these files rather than taken on trust.
81
  The whole published repository was downloaded back into an empty directory and compared file by
82
  file with the tag it was built from — which is exactly what `scripts/check_release_sync.py` does,
83
  so this is re-checkable by a reader rather than autobiographical. Measured 2026-09-11 against tag
84
- `v0.3.0-pre.4`: **every data-layer file agrees byte for byte**, `README.md` included — that file
85
  is this card with its three internal-instruction lines removed, and the source repository's own
86
  `README.md` is a different document, its homepage. The hub holds one file no tag contains: the
87
  `.gitattributes` it created with the repository. The generated table ends with a line carrying a
 
41
  path: evidence/logs/timeout_resume_events.csv
42
  ---
43
 
44
+ > **Released 2026-09-11 as v1.0.0** (methodology v0.1). This snapshot is frozen: later
45
+ > corrections and additions ship as a new version with a new tag, never as an edit to the bytes a
46
+ > citation points at — cite the tag or the Digital Object Identifier, not a branch. Two version
47
+ > numbers mean two different things here: the tag names this public snapshot, while *methodology
48
+ > v0.1* names the definitions, which stay unchanged until a second provider has been measured
49
+ > (section 7). Every figure quoted in this document set is asserted against the shipped evidence by
50
+ > `scripts/analyze.py`, which fails when a number and the evidence disagree and warns when a file
51
+ > is edited after the date above.
52
 
53
  **AI Service QoS — Independent Measurement of What Users Actually Receive** — methodology v0.1, and the first data product of an independent, outside-in measurement framework. The system measured here is **Case Study 1**, not the subject: the framework claims provider neutrality and one provider is not proof of it — a second provider measured with *these same definitions and no new ones* is the test (paper section 7, Stage 3).
54
 
 
84
  The whole published repository was downloaded back into an empty directory and compared file by
85
  file with the tag it was built from — which is exactly what `scripts/check_release_sync.py` does,
86
  so this is re-checkable by a reader rather than autobiographical. Measured 2026-09-11 against tag
87
+ `v1.0.0`: **every data-layer file agrees byte for byte**, `README.md` included — that file
88
  is this card with its three internal-instruction lines removed, and the source repository's own
89
  `README.md` is a different document, its homepage. The hub holds one file no tag contains: the
90
  `.gitattributes` it created with the repository. The generated table ends with a line carrying a
anonymization.md CHANGED
@@ -1,10 +1,13 @@
1
  # Anonymization policy
2
 
3
- > **Pre-release, last revised 2026-09-11** (methodology v0.1). Definitions, wording and figures
4
- > may still change; cite a snapshot — a release tag or a commit, not a branch — so that a later
5
- > revision cannot move what your citation points at. Every figure quoted in this document set is
6
- > asserted against the shipped evidence by `scripts/analyze.py`, which fails when a number and the
7
- > evidence disagree and warns when a file is edited after the date above.
 
 
 
8
 
9
  Everything under `evidence/` is produced by `scripts/anonymize.py`, which
10
  builds a deterministic pseudonym map from the raw dump and refuses to finish
 
1
  # Anonymization policy
2
 
3
+ > **Released 2026-09-11 as v1.0.0** (methodology v0.1). This snapshot is frozen: later
4
+ > corrections and additions ship as a new version with a new tag, never as an edit to the bytes a
5
+ > citation points at — cite the tag or the Digital Object Identifier, not a branch. Two version
6
+ > numbers mean two different things here: the tag names this public snapshot, while *methodology
7
+ > v0.1* names the definitions, which stay unchanged until a second provider has been measured
8
+ > (section 7). Every figure quoted in this document set is asserted against the shipped evidence by
9
+ > `scripts/analyze.py`, which fails when a number and the evidence disagree and warns when a file
10
+ > is edited after the date above.
11
 
12
  Everything under `evidence/` is produced by `scripts/anonymize.py`, which
13
  builds a deterministic pseudonym map from the raw dump and refuses to finish
methodology.md CHANGED
@@ -1,10 +1,13 @@
1
  # Methodology
2
 
3
- > **Pre-release, last revised 2026-09-11** (methodology v0.1). Definitions, wording and figures
4
- > may still change; cite a snapshot — a release tag or a commit, not a branch — so that a later
5
- > revision cannot move what your citation points at. Every figure quoted in this document set is
6
- > asserted against the shipped evidence by `scripts/analyze.py`, which fails when a number and the
7
- > evidence disagree and warns when a file is edited after the date above.
 
 
 
8
 
9
  > **Methodology v0.1** — the concepts below are frozen. The stage ladder to v0.5, a second provider and a continuous observatory is `paper_ai_QoS.md` section 7.
10
 
@@ -28,7 +31,7 @@ and real conversation identifiers):
28
 
29
  | Step | Command | Result of the attempt |
30
  |---|---|---|
31
- | Derived statistics from the published evidence | `python3 scripts/analyze.py` | **reproduces exactly.** 57 assertions pass. The output file ends with a content hash plus a second-precision timestamp, and when the hash is unchanged the file is not rewritten at all — so running the checks cannot dirty the tree, and two copies with the same hash hold the same statistics whatever their stamps say |
32
  | Card against files | `python3 scripts/verify_dataset_card.py` | **reproduces exactly**, eight checks, in either repository |
33
  | Log extracts from the pinned snapshot | `LOGSRC=<snapshot>/logs scripts/collect_evidence.sh` then `scripts/anonymize.py` | **does not reproduce the frozen bundle.** Of 24 published items, 4 matched byte for byte, 11 differed, and 9 were not produced at all (`evidence/screenshots/`, `evidence/user_statements.md`, four extracts, two statistics files, the round-2 directory) |
34
 
 
1
  # Methodology
2
 
3
+ > **Released 2026-09-11 as v1.0.0** (methodology v0.1). This snapshot is frozen: later
4
+ > corrections and additions ship as a new version with a new tag, never as an edit to the bytes a
5
+ > citation points at — cite the tag or the Digital Object Identifier, not a branch. Two version
6
+ > numbers mean two different things here: the tag names this public snapshot, while *methodology
7
+ > v0.1* names the definitions, which stay unchanged until a second provider has been measured
8
+ > (section 7). Every figure quoted in this document set is asserted against the shipped evidence by
9
+ > `scripts/analyze.py`, which fails when a number and the evidence disagree and warns when a file
10
+ > is edited after the date above.
11
 
12
  > **Methodology v0.1** — the concepts below are frozen. The stage ladder to v0.5, a second provider and a continuous observatory is `paper_ai_QoS.md` section 7.
13
 
 
31
 
32
  | Step | Command | Result of the attempt |
33
  |---|---|---|
34
+ | Derived statistics from the published evidence | `python3 scripts/analyze.py` | **reproduces exactly.** 58 assertions pass. The output file ends with a content hash plus a second-precision timestamp, and when the hash is unchanged the file is not rewritten at all — so running the checks cannot dirty the tree, and two copies with the same hash hold the same statistics whatever their stamps say |
35
  | Card against files | `python3 scripts/verify_dataset_card.py` | **reproduces exactly**, eight checks, in either repository |
36
  | Log extracts from the pinned snapshot | `LOGSRC=<snapshot>/logs scripts/collect_evidence.sh` then `scripts/anonymize.py` | **does not reproduce the frozen bundle.** Of 24 published items, 4 matched byte for byte, 11 differed, and 9 were not produced at all (`evidence/screenshots/`, `evidence/user_statements.md`, four extracts, two statistics files, the round-2 directory) |
37
 
scripts/analyze.py CHANGED
@@ -302,24 +302,33 @@ else:
302
  print(" SKIP no drift check: the paper and the case report are not in this "
303
  "checkout (data-layer repository)")
304
 
305
- # ---- pre-release notice: present, and carrying the same revision date, everywhere ----
306
  NOTICE_DATE = "2026-09-11"
 
 
307
  PUB_DOCS = [doc for doc in (EV.parent / n for n in
308
  ("paper_ai_QoS.md", "report_qwenAliServiceQuality.md", "README.md", "abstract.md",
309
  "methodology.md", "anonymization.md", "ask_vendor.md", "DATA_REQUEST.md",
310
  "DATASET_CARD.md", "zenodo/README.md")) if doc.exists()]
311
  notice_problems = [doc.name for doc in PUB_DOCS
312
- if f"**Pre-release, last revised {NOTICE_DATE}**" not in doc.read_text(errors="replace")]
313
  if PUB_DOCS:
314
- check("pre-release notice present and dated " + NOTICE_DATE + " in every published document",
315
  notice_problems, [])
 
 
 
 
 
 
 
316
  late = [doc.name for doc in PUB_DOCS
317
  if datetime.fromtimestamp(doc.stat().st_mtime).date() > datetime.strptime(NOTICE_DATE, "%Y-%m-%d").date()]
318
  if late:
319
- print(" ADVISORY: edited after the stated revision date — bump NOTICE_DATE and the "
320
- "notices together: " + ", ".join(sorted(late)))
321
  else:
322
- print(" SKIP pre-release notice check: no published documents in this checkout (data layer)")
323
 
324
  # ---- authorship: one handle, no institution, anywhere in the public set ----
325
  BYLINE = "independent, unaffiliated"
@@ -342,7 +351,7 @@ if byline_docs:
342
  check("archive metadata carries the pseudonym with an empty affiliation", bad, [])
343
 
344
  # ---- published documents must not send a reader to a file that is not published ----
345
- PRIVATE = ["PUBLICATION.md", "prior-works.md", "reposition.md", "methodology_guidance"]
346
  DISCLOSED = ["not published", "not part of", "deliberately", "private", "ignored",
347
  "working notes", "kept local", "no reading obligation"]
348
  private_problems = []
 
302
  print(" SKIP no drift check: the paper and the case report are not in this "
303
  "checkout (data-layer repository)")
304
 
305
+ # ---- release notice: one text, one version, present everywhere ----
306
  NOTICE_DATE = "2026-09-11"
307
+ RELEASED = "1.0.0" # the released version; CITATION.cff must carry this same string
308
+ NOTICE_MARK = f"**Released {NOTICE_DATE} as v{RELEASED}**"
309
  PUB_DOCS = [doc for doc in (EV.parent / n for n in
310
  ("paper_ai_QoS.md", "report_qwenAliServiceQuality.md", "README.md", "abstract.md",
311
  "methodology.md", "anonymization.md", "ask_vendor.md", "DATA_REQUEST.md",
312
  "DATASET_CARD.md", "zenodo/README.md")) if doc.exists()]
313
  notice_problems = [doc.name for doc in PUB_DOCS
314
+ if NOTICE_MARK not in doc.read_text(errors="replace")]
315
  if PUB_DOCS:
316
+ check(f"release notice {NOTICE_MARK} present in every published document",
317
  notice_problems, [])
318
+ # The version lives in two places, so one is checked against the other: a notice that names a
319
+ # version CITATION.cff does not would send a citation to a snapshot that is not this one.
320
+ cff = EV.parent / "CITATION.cff"
321
+ cff_found = re.search(r'^version: "([^"]+)"', cff.read_text(errors="replace"), re.M) if cff.exists() else None
322
+ if cff.exists():
323
+ check("CITATION.cff and the release notices carry the same version",
324
+ cff_found.group(1) if cff_found else "unreadable", RELEASED)
325
  late = [doc.name for doc in PUB_DOCS
326
  if datetime.fromtimestamp(doc.stat().st_mtime).date() > datetime.strptime(NOTICE_DATE, "%Y-%m-%d").date()]
327
  if late:
328
+ print(" ADVISORY: edited after the release date — a released snapshot is frozen, so "
329
+ "these edits belong in the next version: " + ", ".join(sorted(late)))
330
  else:
331
+ print(" SKIP release notice check: no published documents in this checkout (data layer)")
332
 
333
  # ---- authorship: one handle, no institution, anywhere in the public set ----
334
  BYLINE = "independent, unaffiliated"
 
351
  check("archive metadata carries the pseudonym with an empty affiliation", bad, [])
352
 
353
  # ---- published documents must not send a reader to a file that is not published ----
354
+ PRIVATE = ["PUBLICATION.md", "prior-works.md", "methodology_guidance"]
355
  DISCLOSED = ["not published", "not part of", "deliberately", "private", "ignored",
356
  "working notes", "kept local", "no reading obligation"]
357
  private_problems = []
scripts/check_release_sync.py CHANGED
@@ -64,7 +64,7 @@ STAMP_RE = re.compile(r"sha256:([0-9a-f]{64})")
64
  ALWAYS_BAD = ("Paste this file", "How to publish", "how to publish")
65
  # Names of files that stay on the author's workstation. Naming one is acceptable only on a
66
  # line that says so, which is what the source repository's own document table does.
67
- PRIVATE_NAMES = ("PUBLICATION.md", "prior-works.md", "reposition.md", "methodology_guidance")
68
  DISCLOSED_WORDS = ("not published", "not part of", "deliberately", "private", "ignored",
69
  "working notes", "kept local", "no reading obligation", "local-only")
70
 
 
64
  ALWAYS_BAD = ("Paste this file", "How to publish", "how to publish")
65
  # Names of files that stay on the author's workstation. Naming one is acceptable only on a
66
  # line that says so, which is what the source repository's own document table does.
67
+ PRIVATE_NAMES = ("PUBLICATION.md", "prior-works.md", "methodology_guidance")
68
  DISCLOSED_WORDS = ("not published", "not part of", "deliberately", "private", "ignored",
69
  "working notes", "kept local", "no reading obligation", "local-only")
70
 
scripts/verify_dataset_card.py CHANGED
@@ -129,7 +129,7 @@ def check_licenses(yaml_text: str) -> None:
129
 
130
 
131
  INTERNAL_MARKERS = ("Paste this file", "How to publish", "how to publish",
132
- "PUBLICATION.md", "prior-works.md", "reposition.md", "methodology_guidance")
133
  # A fenced command is an instruction the reader will try. Every script it names must be
134
  # present in whichever repository this card is published into, or the line has to say who it
135
  # belongs to - which is how the tools/ gate and the paste-in note escaped into the open.
 
129
 
130
 
131
  INTERNAL_MARKERS = ("Paste this file", "How to publish", "how to publish",
132
+ "PUBLICATION.md", "prior-works.md", "methodology_guidance")
133
  # A fenced command is an instruction the reader will try. Every script it names must be
134
  # present in whichever repository this card is published into, or the line has to say who it
135
  # belongs to - which is how the tools/ gate and the paste-in note escaped into the open.