chua commited on
Commit
a265e25
·
verified ·
1 Parent(s): 9e48dfc

Document config download accounting

Browse files
Files changed (1) hide show
  1. README.md +5 -0
README.md CHANGED
@@ -48,6 +48,7 @@ locally; no network request is required by the SDK or demo app.
48
  | `ASRDemo/` | Minimal iOS app for microphone recording and one-shot transcription |
49
  | `ANEBench/` | Optional iOS app for Core ML / ANE latency and sustained-load checks |
50
  | `assets/` | Screenshots and model-card media |
 
51
  | `GETTING_STARTED.md` | Reproducible setup, build, signing, and device-testing guide |
52
  | `LICENSE` | Apache License 2.0 |
53
 
@@ -138,6 +139,10 @@ swift run -c release asrkit-cli .. --file /path/to/audio.wav --repeat 10
138
  `asrkit-cli --file` loads `dist/ASRModels.bundle` and runs end-to-end
139
  transcription on macOS.
140
 
 
 
 
 
141
  For memory footprint and thermal checks, run `ASRDemo` on a physical iPhone,
142
  record one utterance, then tap `Repeat Last 10x` while watching the in-app
143
  `System` panel. Simulator memory is useful for trends only; it is not
 
48
  | `ASRDemo/` | Minimal iOS app for microphone recording and one-shot transcription |
49
  | `ANEBench/` | Optional iOS app for Core ML / ANE latency and sustained-load checks |
50
  | `assets/` | Screenshots and model-card media |
51
+ | `config.json` | Machine-readable package metadata and Hugging Face download-stat query file |
52
  | `GETTING_STARTED.md` | Reproducible setup, build, signing, and device-testing guide |
53
  | `LICENSE` | Apache License 2.0 |
54
 
 
139
  `asrkit-cli --file` loads `dist/ASRModels.bundle` and runs end-to-end
140
  transcription on macOS.
141
 
142
+ Hugging Face counts model downloads through query files such as `config.json`.
143
+ If you automate downloads with `snapshot_download` or `hf_hub_download`, include
144
+ the root `config.json` in the request path so repository downloads are counted.
145
+
146
  For memory footprint and thermal checks, run `ASRDemo` on a physical iPhone,
147
  record one utterance, then tap `Repeat Last 10x` while watching the in-app
148
  `System` panel. Simulator memory is useful for trends only; it is not