Skip to content

Commit 19d607a

Browse files
Align README with product page v2
1 parent e819d4b commit 19d607a

2 files changed

Lines changed: 69 additions & 37 deletions

File tree

440 KB
Loading

README.md

Lines changed: 69 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,41 +8,66 @@
88

99
## What This Is
1010

11-
`zpe-music` is a music encoding product for canonical symbolic score data, with a bounded note-local expression refinement carried on the same score note. It targets MusicXML pipelines that need auditable roundtrip recovery of score structure plus note-local `attack`, `release`, and `dynamics`-derived fields.
11+
Canonical symbolic-score codec. MusicXML score structure plus note-local attack, release, and dynamics-derived fields round-trip under the declared proof surface.
1212

1313
It does not do audio understanding. The public surface is canonical symbolic score plus a bounded note-local expression refinement, and the hard boundaries are stated explicitly below.
1414

15+
## Codec Mechanics
16+
17+
<p>
18+
<img src=".github/assets/readme/lane-mechanics/MUSIC.gif" alt="ZPE-Music Codec Mechanics animation" width="100%">
19+
</p>
20+
1521
| Field | Value |
16-
|-------|-------|
22+
| ------- | ------- |
1723
| Architecture | MUSIC_STREAM |
1824
| Encoding | MUSIC_SYMBOLIC_V1 |
25+
| Mechanics Asset | `.github/assets/readme/lane-mechanics/MUSIC.gif` |
1926

2027
## Key Metrics
2128

2229
| Metric | Value | Baseline |
23-
|--------|-------|----------|
24-
| SCORE_EVENT_EXACT (`score_event_exact_rate_mean`) | 1.0 ||
25-
| PART_EXACT (`part_exact_rate_mean`) | 1.0 ||
26-
| ARTICULATION_EXACT (`articulation_exact_rate_mean`) | 1.0 ||
27-
| EXPRESSION_EVENT_EXACT (`expression_event_exact_rate_mean`) | 1.0 ||
30+
| -------- | ------- | ---------- |
31+
| SCORE_EVENT_EXACT (score_event_exact_rate_mean) | 1.0 ||
32+
| PART_EXACT (part_exact_rate_mean) | 1.0 ||
33+
| ARTICULATION_EXACT (articulation_exact_rate_mean) | 1.0 ||
34+
| EXPRESSION_EVENT_EXACT (expression_event_exact_rate_mean) | 1.0 ||
2835

2936
> Source: `proofs/artifacts/music_release_metrics.json`, `validation/results/release_verification.json`
3037
31-
All four metrics measured on the bounded authority test corpus (11 synthetic/controlled MusicXML cases). These are test-corpus results on the authority path, not production-generality claims. This is a symbolic-score codec — no audio codec comp benchmarks (MP3/AAC/Opus/MIDI/MusicGen) exist or apply.
38+
## Repo Identity
3239

33-
Additional verified metrics (not in the 4-row canonical table, included for full disclosure):
40+
| Field | Value |
41+
| ------- | ------- |
42+
| Identifier | ZPE-Music |
43+
| Repository | https://github.com/Zer0pa/ZPE-Music |
44+
| Section | encoding |
45+
| Visibility | PUBLIC |
46+
| Architecture | MUSIC_STREAM |
47+
| Encoding | MUSIC_SYMBOLIC_V1 |
48+
| Commit SHA | cdd6b75 |
49+
| License | SAL-7.0 |
50+
| Authority Source | proofs/artifacts/music_release_metrics.json |
3451

35-
| Metric | Value | Proof artifact | CI test |
36-
|--------|-------|----------------|---------|
37-
| PERFORMANCE_TUPLE_EXACT (`performance_tuple_exact_rate_mean`) | 1.0 | `proofs/artifacts/music_release_metrics.json` | `tests/test_music_expression_authority_roundtrip.py` |
38-
| REPEATED_NOTE_CASE (`repeated_note_case_exact_rate`) | 1.0 | `proofs/artifacts/music_release_metrics.json` | `tests/test_music_expression_authority_roundtrip.py::test_repeated_note_expression_roundtrip_exact` |
39-
| REQUIRED_CHECKS_PASSED | 11/11 in 3.39 s | `validation/results/release_verification.json` | `validation/run_release_verification.py` |
52+
## Readiness
53+
54+
| Field | Value |
55+
| ------- | ------- |
56+
| Verdict | STAGED |
57+
| Checks | 7/7 |
58+
| Anchors | 2 display anchors |
59+
| Commit | cdd6b75 |
60+
| Authority | proofs/artifacts/music_release_metrics.json |
61+
62+
### Honest Blocker
63+
64+
Audio waveform understanding or performer-audio interpretation.; Continuous tempo curves or continuous dynamics curves.; Pedal, sustain, performer state, or general expressive performance modeling.
4065

4166
## What We Prove
4267

4368
- Canonical symbolic score events roundtrip exactly on the verified authority path.
4469
- Part, voice, rest, articulation, and per-event program survive the bounded score surface exactly.
45-
- Note-local expression fields derived from MusicXML `attack`, `release`, and `dynamics` roundtrip exactly on the same score-anchored note object.
70+
- Note-local expression fields derived from MusicXML attack, release, and dynamics roundtrip exactly on the same score-anchored note object.
4671
- Repeated same-pitch notes remain distinguishable on the bounded expression cases.
4772

4873
## What We Don't Claim
@@ -51,43 +76,50 @@ Additional verified metrics (not in the 4-row canonical table, included for full
5176
- Continuous tempo curves or continuous dynamics curves.
5277
- Pedal, sustain, performer state, or general expressive performance modeling.
5378
- Raw MusicXML part-name identity recovery.
54-
- Anything beyond bounded note-local `attack`, `release`, and `dynamics`-derived refinement.
79+
- Anything beyond bounded note-local attack, release, and dynamics-derived refinement.
5580
- MP3/AAC/Opus/MIDI/MusicGen baselines — this is a symbolic codec; no audio codec comparisons exist or apply.
5681

57-
## Commercial Readiness
58-
59-
| Field | Value |
60-
|-------|-------|
61-
| Verdict | STAGED |
62-
| Commit SHA | cdd6b75 |
63-
| Source | `proofs/artifacts/music_release_metrics.json` |
64-
65-
## Tests and Verification
82+
## Verification Status
6683

6784
| Code | Check | Verdict |
68-
|------|-------|---------|
69-
| V_01 | Score event exact roundtrip — `tests/test_music_authority_roundtrip.py` | PASS |
70-
| V_02 | Part, voice, rest, articulation, program exact roundtrip — `tests/test_music_authority_roundtrip.py` | PASS |
71-
| V_03 | Expression event exact roundtrip — `tests/test_music_expression_authority_roundtrip.py` | PASS |
72-
| V_04 | Performance tuple exact roundtrip — `tests/test_music_expression_authority_roundtrip.py` | PASS |
73-
| V_05 | Repeated same-pitch note distinguishability — `tests/test_music_expression_authority_roundtrip.py::test_repeated_note_expression_roundtrip_exact` | PASS |
74-
| V_06 | Guardrail battery (out-of-scope rejection) — `tests/test_music_authority_guardrails.py` | PASS |
75-
| V_07 | Release verification suite 11/11 — `validation/run_release_verification.py` | PASS |
85+
| ------ | ------- | --------- |
86+
| V_01 | Score event exact roundtrip — tests/test_music_authority_roundtrip.py | PASS |
87+
| V_02 | Part, voice, rest, articulation, program exact roundtrip — tests/test_music_authority_roundtrip.py | PASS |
88+
| V_03 | Expression event exact roundtrip — tests/test_music_expression_authority_roundtrip.py | PASS |
89+
| V_04 | Performance tuple exact roundtrip — tests/test_music_expression_authority_roundtrip.py | PASS |
90+
| V_05 | Repeated same-pitch note distinguishability — tests/test_music_expression_authority_roundtrip.py::test_repeated_note_expression_roundtrip_exact | PASS |
91+
| V_06 | Guardrail battery (out-of-scope rejection) — tests/test_music_authority_guardrails.py | PASS |
92+
| V_07 | Release verification suite 11/11 — validation/run_release_verification.py | PASS |
7693

7794
## Proof Anchors
7895

7996
| Path | State |
80-
|------|-------|
97+
| ------ | ------- |
8198
| `proofs/artifacts/music_release_metrics.json` | VERIFIED |
8299
| `validation/results/release_verification.json` | VERIFIED |
83100

84101
## Repo Shape
85102

86103
| Field | Value |
87-
|-------|-------|
88-
| Proof Anchors | 2 |
104+
| ------- | ------- |
105+
| Proof Anchors | 2 display anchors |
89106
| Modality Lanes | 1 |
90-
| Authority Source | `proofs/artifacts/music_release_metrics.json` |
107+
| Architecture | MUSIC_STREAM |
108+
| Encoding | MUSIC_SYMBOLIC_V1 |
109+
| Verification | 7/7 checks |
110+
| Authority Source | proofs/artifacts/music_release_metrics.json |
111+
112+
## Extended Metrics
113+
114+
Detailed metric rows retained from the previous `## Key Metrics` section. The public product page uses the four-row summary above.
115+
116+
Additional verified metrics (not in the 4-row canonical table, included for full disclosure):
117+
118+
| Metric | Value | Proof artifact | CI test |
119+
|--------|-------|----------------|---------|
120+
| PERFORMANCE_TUPLE_EXACT (`performance_tuple_exact_rate_mean`) | 1.0 | `proofs/artifacts/music_release_metrics.json` | `tests/test_music_expression_authority_roundtrip.py` |
121+
| REPEATED_NOTE_CASE (`repeated_note_case_exact_rate`) | 1.0 | `proofs/artifacts/music_release_metrics.json` | `tests/test_music_expression_authority_roundtrip.py::test_repeated_note_expression_roundtrip_exact` |
122+
| REQUIRED_CHECKS_PASSED | 11/11 in 3.39 s | `validation/results/release_verification.json` | `validation/run_release_verification.py` |
91123

92124
## Quick Start
93125

0 commit comments

Comments
 (0)