Add SFR package and Evaluate metric links

README.md

@@ -60,16 +60,23 @@ configs:
 
 # Script fidelity benchmark
 
-Anonymous supplement for the paper "Script Collapse in Multilingual ASR:
-Defining and Measuring Script Fidelity Rate."
+Anonymous supplement for the paper "Script collapse in multilingual ASR:
+A reference-free metric and 100-pair benchmark."
 
 Script Fidelity Rate (SFR) measures the fraction of ASR hypothesis characters
 that belong to the expected target script. WER measures word edits, while SFR
 checks whether the output is written in the target orthography.
 
+Related resources:
+
+- PyPI package: <https://pypi.org/project/script-fidelity/>
+- Hugging Face Evaluate metric: <https://huggingface.co/spaces/themechanism/script_fidelity_rate>
+- Load with Evaluate: `evaluate.load("themechanism/script_fidelity_rate", module_type="metric")`
+
 ## Scope
 
-The benchmark contains 100 evaluated model-language pairs on FLEURS test splits:
+The paper benchmark contains 100 evaluated model-language pairs on FLEURS test
+splits:
 
 | Language | Script | FLEURS code | Role |
 |---|---|---|---|
@@ -106,7 +113,7 @@ scripts/
   eval_sfr_lid_hybrid.py SFR+LID audit for saved Gemma 4 outputs
   run_gemma4.sh          Convenience wrapper for the Gemma 4 baseline run
 analysis/
-  sf_results.csv         Main result table
+  sf_results.csv         Main result table plus six supplemental Pashto rows
   gemma4_downstream_mt_summary.csv        MT validation summary
   gemma4_downstream_mt_correlations.csv   MT validation correlations
   sfr_lid_hybrid_summary.csv              SFR+LID audit summary
@@ -124,6 +131,14 @@ LICENSE                 CC-BY-4.0 license notice
 requirements.txt         Python package requirements
 ```
 
+The general SFR library is published separately as `script-fidelity` on PyPI:
+<https://pypi.org/project/script-fidelity/>. The import name is
+`script_fidelity`. This artifact keeps a bundled `scripts/script_fidelity.py`
+for exact reproduction of the submitted benchmark.
+
+The same metric is available as a Hugging Face Evaluate community metric:
+<https://huggingface.co/spaces/themechanism/script_fidelity_rate>.
+
 ## Setup
 
 Python 3.10 or newer is recommended. Use `uv` for all environment and package
@@ -272,7 +287,11 @@ main figures to the 100 model-language pairs reported in the paper.
 
 ## Result fields
 
-`analysis/sf_results.csv` has one row per model-language pair.
+`analysis/sf_results.csv` has one row per evaluated model-language pair. The
+paper's 100-pair matrix is the subset with `family` in `Whisper`, `MMS`,
+`SeamlessM4T`, or `Gemma4`. The six rows with `family=unknown` are supplemental
+Pashto-only comparisons and are not used in the paper denominator, family
+summaries, heatmap, or collapse counts.
 
 | Column | Meaning |
 |---|---|
@@ -288,14 +307,38 @@ main figures to the 100 model-language pairs reported in the paper.
 
 ## SFR library
 
-The metric implementation is standalone:
+For standalone use outside this artifact, install the published package:
+
+```bash
+uv add script-fidelity
+```
+
+Then import it as `script_fidelity`:
 
 ```python
 from script_fidelity import compute_sfr
 
-compute_sfr("کابل کې ښه هوا ده", "pashto")
-compute_sfr("kabul ke sha hawa da", "pashto")
-compute_sfr("नमस्ते", "hindi")
+compute_sfr("کابل کې ښه هوا ده", language="ps_af")
+compute_sfr("kabul ke sha hawa da", language="pashto")
+compute_sfr("नमस्ते", language="hindi")
+```
+
+One-off CLI use:
+
+```bash
+uvx --from script-fidelity sfr score --language ps_af --text "کابل کې ښه هوا ده"
+```
+
+Hugging Face Evaluate use:
+
+```python
+import evaluate
+
+sfr = evaluate.load("themechanism/script_fidelity_rate", module_type="metric")
+sfr.compute(
+    predictions=["کابل کې ښه هوا ده", "romanized output"],
+    language="ps_af",
+)
 ```
 
 The validation script has already been run for the submitted artifact. It checks
@@ -316,7 +359,7 @@ PII status, and Responsible AI fields.
 ```bibtex
 @misc{Anonymous2026ScriptFidelity,
   author = {Anonymous},
-  title = {Script Collapse in Multilingual ASR: Defining and Measuring Script Fidelity Rate},
+  title = {Script collapse in multilingual ASR: A reference-free metric and 100-pair benchmark},
   year = {2026},
   note = {Anonymous submission}
 }