ask users to download and install the onnx runtime

Signed-off-by: PeterD1524 <[email protected]>
second-state · Jul 24, 2024 · b94adc5 · b94adc5
1 parent 2e9bca5
commit b94adc5
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.github/workflows/piper.yml b/.github/workflows/piper.yml
@@ -21,6 +21,14 @@ jobs:
           sudo apt-get update
           sudo apt-get install ninja-build
 
+      - name: Install ONNX Runtime 1.14.1
+        run: |
+          curl -LO https://github.com/microsoft/onnxruntime/releases/download/v1.14.1/onnxruntime-linux-x64-1.14.1.tgz
+          tar zxf onnxruntime-linux-x64-1.14.1.tgz
+          mv onnxruntime-linux-x64-1.14.1/include/* /usr/local/include/
+          mv onnxruntime-linux-x64-1.14.1/lib/* /usr/local/lib/
+          rm -rf onnxruntime-linux-x64-1.14.1.tgz onnxruntime-linux-x64-1.14.1
+
       - name: Checkout WasmEdge
         uses: actions/checkout@v4
         with:

diff --git a/wasmedge-piper/README.md b/wasmedge-piper/README.md
@@ -13,7 +13,19 @@ Overview of WASI-NN Piper plugin dependencies:
 - [espeak-ng](https://github.com/rhasspy/espeak-ng): An open source speech synthesizer that supports more than hundred languages and accents. Piper uses it for text to phoneme translation.
 - [onnxruntime](https://github.com/microsoft/onnxruntime): A cross-platform inference and training machine-learning accelerator. [ONNX](https://onnx.ai/) is an open format built to represent machine learning models. Piper uses ONNX Runtime as an inference backend for its ONNX models to convert phoneme ids to WAV audio.
 
-WasmEdge will download and build these dependencies automatically.
+The WasmEdge WASI-NN Piper plugin relies on the ONNX Runtime C++ API. For installation instructions, please refer to the installation table on the [official website](https://onnxruntime.ai/getting-started).
+
+Example of installing ONNX Runtime 1.14.1 on Ubuntu:
+
+```bash
+curl -LO https://github.com/microsoft/onnxruntime/releases/download/v1.14.1/onnxruntime-linux-x64-1.14.1.tgz
+tar zxf onnxruntime-linux-x64-1.14.1.tgz
+mv onnxruntime-linux-x64-1.14.1/include/* /usr/local/include/
+mv onnxruntime-linux-x64-1.14.1/lib/* /usr/local/lib/
+rm -rf onnxruntime-linux-x64-1.14.1.tgz onnxruntime-linux-x64-1.14.1
+```
+
+For other dependencies, WasmEdge will download and build them automatically.
 
 Build WasmEdge from source: