Skip to content

Commit 73ac0e2

Browse files
authored
[doc] update doc for wenetruntime (#1585)
* [doc] update doc for wenetruntime * fix lint
1 parent 1da0acc commit 73ac0e2

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

runtime/binding/python/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@ pip3 install wenetruntime
2121

2222
## Usage
2323

24+
Note:
25+
26+
1. For macOS, wenetruntime packed `libtorch.so`, so we can't import torch and wenetruntime at the same time.
27+
2. For Windows and Linux, wenetruntime depends on torch. Please install and import the same version `torch` as wenetruntime.
28+
2429
### Non-streaming Usage
2530

2631
``` python
2732
import sys
28-
import torch # macOS should comment out this line, and uninstall torch.
33+
import torch
2934
import wenetruntime as wenet
3035

3136
wav_file = sys.argv[1]
@@ -67,7 +72,7 @@ decoder = wenet.Decoder(model_dir,
6772

6873
``` python
6974
import sys
70-
import torch # macOS should comment out this line, and uninstall torch.
75+
import torch
7176
import wave
7277
import wenetruntime as wenet
7378

0 commit comments

Comments
 (0)