Skip to content

Commit 231b3e5

Browse files
committed
Update README.md for new supported progamming languages
1 parent 5a20215 commit 231b3e5

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,11 @@
4646
- [Installation](#installation)
4747
- [Quick Start](#quick-start)
4848
- [Python Usage](#python-usage)
49-
- [Linux](#1-linux--macos--windows)
49+
- [Linux / macOS / Windows](#1-linux--macos--windows)
5050
- [JS Usage](#js-usage)
5151
- [Web](#1-web)
5252
- [Java Usage](#java-usage)
53+
- [Go (Golang) Usage](#go-golang-usage)
5354
- [C Usage](#c-usage)
5455
- [Linux](#1-linux)
5556
- [Windows](#2-windows)
@@ -336,7 +337,7 @@ sudo apt install libc++1
336337

337338
<br>
338339

339-
#### **Usage**
340+
#### **Usage (Prebuilt-libs)**
340341

341342
Note: For usage in python, you can either use it by **git clone** or **pip**.
342343

@@ -376,6 +377,22 @@ pip install -U --force-reinstall -v git+https://github.com/TEN-framework/ten-vad
376377
from ten_vad import TenVad
377378
```
378379

380+
#### **Usage (ONNX model)**
381+
You have to download the **onnxruntime** packages from the [microsoft official onnxruntime github website](https://github.com/microsoft/onnxruntime). Note that the version of onnxruntime must be higher than or equal to 1.17.1 (e.g. onnxruntime-linux-x64-1.17.1.tgz).
382+
<br>
383+
<br>
384+
You can check the official **ONNX Runtime releases** from [this website](https://github.com/microsoft/onnxruntime/tags). And for example, to download version 1.17.1 (Linux x64), use [this link](https://github.com/microsoft/onnxruntime/releases/download/v1.17.1/onnxruntime-linux-x64-1.17.1.tgz). After extracting the compressed file, you'll find two important directories:`include/` - header files, `lib/` - library files
385+
386+
```
387+
1) cd examples_onnx/python
388+
2) ./build-and-deploy-linux.sh --ort-path /absolute/path/to/your/onnxruntime/root/dir # For Linux. If macOS, run build-and-deploy-macos.sh instead.
389+
```
390+
391+
**Note 1**: If executing the onnx demo from a different directory than the one used when running build-and-deploy-linux.sh, ensure to create a symbolic link to src/onnx_model/ to prevent ONNX model file loading failures.
392+
<br>
393+
**Note 2**: The **ONNX model** locates in `src/onnx_model` directory.
394+
395+
379396
<br>
380397

381398
### **JS Usage**

0 commit comments

Comments
 (0)