Simplify setup to one sourced Bash configuration
Browse files- README.md +11 -6
- SHA256SUMS +2 -2
- agora-model.json +15 -2
README.md
CHANGED
|
@@ -17,20 +17,25 @@ This public repository contains the **80ms** model package for Agora. Applicatio
|
|
| 17 |
|
| 18 |
## Deployment
|
| 19 |
|
| 20 |
-
|
| 21 |
|
| 22 |
-
For this
|
|
|
|
|
|
|
| 23 |
|
| 24 |
```bash
|
| 25 |
-
|
|
|
|
|
|
|
|
|
|
| 26 |
```
|
| 27 |
|
| 28 |
-
|
| 29 |
|
| 30 |
## Resource layout
|
| 31 |
|
| 32 |
```text
|
| 33 |
-
$
|
| 34 |
βββ models.json # SDK package entry point
|
| 35 |
βββ agora-model.json # Resource and compatibility metadata
|
| 36 |
βββ SHA256SUMS / README.md
|
|
@@ -40,7 +45,7 @@ $AGORA_MODELS_DIR/
|
|
| 40 |
βββ LICENSES/ NOTICE
|
| 41 |
```
|
| 42 |
|
| 43 |
-
Download common files and only the selected target in one HF snapshot. No extraction or manual file moves are needed. --models takes the root containing models.json, not
|
| 44 |
|
| 45 |
The default guide uses main. Use HF's native --revision option when you need an immutable snapshot. SHA256SUMS checks downloaded bytes; --ignore-missing permits intentionally absent other-SoC files but does not prove package completeness. Web startup also checks required resources and hashes.
|
| 46 |
|
|
|
|
| 17 |
|
| 18 |
## Deployment
|
| 19 |
|
| 20 |
+
Use the [shared deployment guide](https://github.com/APLUX-Agora/audio8-asr-infinite-demo/blob/main/docs/AGORA_DEPLOY.md). Developers using GitHub edit the [common configuration template](https://github.com/APLUX-Agora/audio8-asr-infinite-demo/blob/main/agora/agora.env.example); Agora fills the same format from selected content and hardware.
|
| 21 |
|
| 22 |
+
The global file declares only workspace, content ID, code/resource sources and versions, SoC, and operating system. For this package, AGORA_RESOURCE_REPO is `APLUX-Agora/Audio8-ASR-Infinite-80ms`. It does not contain Audio8 clocks, ports, model filenames, or target-directory names. The SDK and Web Demo read the clock from models.json. The project owns its resource filters in [agora/resources.env](https://github.com/APLUX-Agora/audio8-asr-infinite-demo/blob/main/agora/resources.env).
|
| 23 |
+
|
| 24 |
+
After loading the common configuration, getting the code, and creating the project venv, run from workspace/code:
|
| 25 |
|
| 26 |
```bash
|
| 27 |
+
source agora/resources.env
|
| 28 |
+
.venv/bin/python -m pip install huggingface_hub
|
| 29 |
+
.venv/bin/hf download "$AGORA_RESOURCE_REPO" --revision "$AGORA_RESOURCE_REF" \
|
| 30 |
+
--local-dir "$AGORA_WORKSPACE/resources" --include "${AUDIO8_DOWNLOAD_PATTERNS[@]}"
|
| 31 |
```
|
| 32 |
|
| 33 |
+
This is the official HF downloader, with project-maintained file selection. No Agora CLI or authentication is required. The global configuration does not need to track changes to model filenames. Re-source it when opening a new terminal, and choose a separate workspace when switching content/hardware/model variants.
|
| 34 |
|
| 35 |
## Resource layout
|
| 36 |
|
| 37 |
```text
|
| 38 |
+
$AGORA_WORKSPACE/resources/
|
| 39 |
βββ models.json # SDK package entry point
|
| 40 |
βββ agora-model.json # Resource and compatibility metadata
|
| 41 |
βββ SHA256SUMS / README.md
|
|
|
|
| 45 |
βββ LICENSES/ NOTICE
|
| 46 |
```
|
| 47 |
|
| 48 |
+
Download common files and only the selected target in one HF snapshot. No extraction or manual file moves are needed. --models takes workspace/resources, the root containing models.json, not its targets directory. A single target is approximately **3.3 GiB / 3.55 GB**; allow at least 8 GiB for code, dependencies, and resources. Use a separate workspace for each selected model/hardware combination.
|
| 49 |
|
| 50 |
The default guide uses main. Use HF's native --revision option when you need an immutable snapshot. SHA256SUMS checks downloaded bytes; --ignore-missing permits intentionally absent other-SoC files but does not prove package completeness. Web startup also checks required resources and hashes.
|
| 51 |
|
SHA256SUMS
CHANGED
|
@@ -2,8 +2,8 @@ cfc7749b96f63bd31c3c42b5c471bf756814053e847c10f3eb003417bc523d30 LICENSES/Apach
|
|
| 2 |
2de3adf5d4afde83c75ddff3bfe596f9f769acfa746a51ae7ea7e949d2ff297c LICENSES/Pandora-Model-SDK.en.txt
|
| 3 |
2552f7a6eb20986f706e2512fabef6224b9304de8507b8b7896c24e56e5685a1 LICENSES/Pandora-Model-SDK.zh-CN.txt
|
| 4 |
7f8d21c8608897b9828af5caa12484ab2e0fe72c596eb2cf12252d35b3b599b0 NOTICE
|
| 5 |
-
|
| 6 |
-
|
| 7 |
18f549e98fe991bd403b898a524df64467d9a7a9cdad1d3849bcbd91b95e37fe embedding.bin
|
| 8 |
145406c1cb5760d4a705acae693b47e08ee63cbcde35fd86d4d18b92bb613414 frontend/config.json
|
| 9 |
61690c227693ca614d6ec3449f5017520e6c9793aa06c9599c3be610a514d5a0 frontend/rows_const.npy
|
|
|
|
| 2 |
2de3adf5d4afde83c75ddff3bfe596f9f769acfa746a51ae7ea7e949d2ff297c LICENSES/Pandora-Model-SDK.en.txt
|
| 3 |
2552f7a6eb20986f706e2512fabef6224b9304de8507b8b7896c24e56e5685a1 LICENSES/Pandora-Model-SDK.zh-CN.txt
|
| 4 |
7f8d21c8608897b9828af5caa12484ab2e0fe72c596eb2cf12252d35b3b599b0 NOTICE
|
| 5 |
+
92416b6ec4ad35591aca1f804f1be30000780524e5a7a4c7ed0d3432c8d6d47f README.md
|
| 6 |
+
92df747507c7d2e90758f9626ec6db22c29976d74eac00088e75694d91792b96 agora-model.json
|
| 7 |
18f549e98fe991bd403b898a524df64467d9a7a9cdad1d3849bcbd91b95e37fe embedding.bin
|
| 8 |
145406c1cb5760d4a705acae693b47e08ee63cbcde35fd86d4d18b92bb613414 frontend/config.json
|
| 9 |
61690c227693ca614d6ec3449f5017520e6c9793aa06c9599c3be610a514d5a0 frontend/rows_const.npy
|
agora-model.json
CHANGED
|
@@ -58,6 +58,19 @@
|
|
| 58 |
"approx_download_bytes": 3546296093
|
| 59 |
}
|
| 60 |
],
|
| 61 |
-
"notes": "
|
| 62 |
-
"configuration": "agora.env"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
}
|
|
|
|
| 58 |
"approx_download_bytes": 3546296093
|
| 59 |
}
|
| 60 |
],
|
| 61 |
+
"notes": "Global configuration contains only common deployment declarations. The project owns file filters and application options. Ubuntu selections do not qualify the entire native SDK/BSP stack; only QCS8550/Ubuntu22.04 is currently qualified.",
|
| 62 |
+
"configuration": "agora.env",
|
| 63 |
+
"global_parameters": [
|
| 64 |
+
"AGORA_WORKSPACE",
|
| 65 |
+
"AGORA_CONTENT_ID",
|
| 66 |
+
"AGORA_CODE_REPO",
|
| 67 |
+
"AGORA_CODE_REF",
|
| 68 |
+
"AGORA_RESOURCE_REPO",
|
| 69 |
+
"AGORA_RESOURCE_REF",
|
| 70 |
+
"AGORA_SOC",
|
| 71 |
+
"AGORA_OS",
|
| 72 |
+
"AGORA_OS_VERSION"
|
| 73 |
+
],
|
| 74 |
+
"resource_selection": "https://github.com/APLUX-Agora/audio8-asr-infinite-demo/blob/main/agora/resources.env",
|
| 75 |
+
"audio_clock_source": "models.json:audio_clock_ms"
|
| 76 |
}
|