From bbcf0d87ace59ec238ec757ea19ec0dd2883e94a Mon Sep 17 00:00:00 2001
From: 雾聪 <wucong.lyb@alibaba-inc.com>
Date: 星期一, 23 十月 2023 11:17:24 +0800
Subject: [PATCH] update docs
---
funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp | 2 +-
funasr/runtime/docs/SDK_advanced_guide_online.md | 4 ++--
funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md | 4 +---
funasr/runtime/docs/SDK_advanced_guide_offline.md | 4 ++--
funasr/runtime/docs/SDK_advanced_guide_offline_en.md | 4 +---
funasr/runtime/docs/SDK_advanced_guide_offline_zh.md | 4 ++--
funasr/runtime/docs/SDK_advanced_guide_online_zh.md | 4 ++--
funasr/runtime/websocket/bin/funasr-wss-server.cpp | 2 +-
8 files changed, 12 insertions(+), 16 deletions(-)
diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline.md b/funasr/runtime/docs/SDK_advanced_guide_offline.md
index ac87653..43a69cd 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_offline.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_offline.md
@@ -84,7 +84,7 @@
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
- --hotwordsfile ../../hotwords.txt > log.out 2>&1 &
+ --hotword ../../hotwords.txt > log.out 2>&1 &
```
Introduction to run_server.sh parameters:
@@ -103,7 +103,7 @@
--io-thread-num: Number of IO threads that the server starts. Default is 1.
--certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl锛宻et 0
--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
---hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
+--hotword Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
```
### Shutting Down the FunASR Service
diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline_en.md b/funasr/runtime/docs/SDK_advanced_guide_offline_en.md
index e409376..b829e67 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_offline_en.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_offline_en.md
@@ -79,8 +79,7 @@
--io-thread-num 8 \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
- --keyfile ../../../ssl_key/server.key \
- --hotwordsfile ../../hotwords.txt
+ --keyfile ../../../ssl_key/server.key > log.out 2>&1 &
```
Introduction to run_server.sh parameters:
@@ -99,7 +98,6 @@
--io-thread-num: Number of IO threads that the server starts. Default is 1.
--certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl锛宻et 0
--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
---hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
```
### Shutting Down the FunASR Service
diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md b/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md
index 90b0963..48c67c9 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_offline_en_zh.md
@@ -162,8 +162,7 @@
--io-thread-num 8 \
--port 10095 \
--certfile ../../../ssl_key/server.crt \
- --keyfile ../../../ssl_key/server.key \
- --hotwordsfile ../../hotwords.txt > log.out 2>&1 &
+ --keyfile ../../../ssl_key/server.key > log.out 2>&1 &
```
**run_server.sh鍛戒护鍙傛暟浠嬬粛**
```text
@@ -180,7 +179,6 @@
--io-thread-num 鏈嶅姟绔惎鍔ㄧ殑IO绾跨▼鏁帮紝榛樿涓� 1
--certfile ssl鐨勮瘉涔︽枃浠讹紝榛樿涓猴細../../../ssl_key/server.crt锛屽鏋滈渶瑕佸叧闂璼sl锛屽弬鏁拌缃负0
--keyfile ssl鐨勫瘑閽ユ枃浠讹紝榛樿涓猴細../../../ssl_key/server.key
---hotwordsfile 鐑瘝鏂囦欢璺緞锛屾瘡涓�涓儹璇嶄竴琛岋紝濡傛灉瀹㈡埛绔彁渚涚儹璇嶏紝鍒欎笌瀹㈡埛绔彁渚涚殑鐑瘝鍚堝苟涓�璧蜂娇鐢ㄣ�傞粯璁や负锛�../../hotwords.txt
```
### 鍏抽棴FunASR鏈嶅姟
diff --git a/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md b/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md
index c1b33b6..ee65501 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_offline_zh.md
@@ -166,7 +166,7 @@
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
- --hotwordsfile ../../hotwords.txt > log.out 2>&1 &
+ --hotword ../../hotwords.txt > log.out 2>&1 &
```
**run_server.sh鍛戒护鍙傛暟浠嬬粛**
```text
@@ -183,7 +183,7 @@
--io-thread-num 鏈嶅姟绔惎鍔ㄧ殑IO绾跨▼鏁帮紝榛樿涓� 1
--certfile ssl鐨勮瘉涔︽枃浠讹紝榛樿涓猴細../../../ssl_key/server.crt锛屽鏋滈渶瑕佸叧闂璼sl锛屽弬鏁拌缃负0
--keyfile ssl鐨勫瘑閽ユ枃浠讹紝榛樿涓猴細../../../ssl_key/server.key
---hotwordsfile 鐑瘝鏂囦欢璺緞锛屾瘡涓�涓儹璇嶄竴琛岋紝濡傛灉瀹㈡埛绔彁渚涚儹璇嶏紝鍒欎笌瀹㈡埛绔彁渚涚殑鐑瘝鍚堝苟涓�璧蜂娇鐢ㄣ�傞粯璁や负锛�../../hotwords.txt
+--hotword 鐑瘝鏂囦欢璺緞锛屾瘡涓�涓儹璇嶄竴琛岋紝濡傛灉瀹㈡埛绔彁渚涚儹璇嶏紝鍒欎笌瀹㈡埛绔彁渚涚殑鐑瘝鍚堝苟涓�璧蜂娇鐢ㄣ�傞粯璁や负锛�../../hotwords.txt
```
### 鍏抽棴FunASR鏈嶅姟
diff --git a/funasr/runtime/docs/SDK_advanced_guide_online.md b/funasr/runtime/docs/SDK_advanced_guide_online.md
index c4fac4a..ddc02cf 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_online.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_online.md
@@ -73,7 +73,7 @@
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
- --hotwordsfile ../../hotwords.txt > log.out 2>&1 &
+ --hotword ../../hotwords.txt > log.out 2>&1 &
# If you want to close ssl锛宲lease add锛�--certfile 0
# If you want to deploy the timestamp or hotword model, please set --model-dir to the corresponding model:
@@ -98,7 +98,7 @@
--io-thread-num: Number of IO threads that the server starts. Default is 1.
--certfile <string>: SSL certificate file. Default is ../../../ssl_key/server.crt. If you want to close ssl锛宻et 0
--keyfile <string>: SSL key file. Default is ../../../ssl_key/server.key.
---hotwordsfile Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
+--hotword Hotword file path, one line for each hot word, if the client provides hot words, then combined with the hot words provided by the client. Default is ../../hotwords.txt
```
### Shutting Down the FunASR Service
diff --git a/funasr/runtime/docs/SDK_advanced_guide_online_zh.md b/funasr/runtime/docs/SDK_advanced_guide_online_zh.md
index a8e7933..902ae7a 100644
--- a/funasr/runtime/docs/SDK_advanced_guide_online_zh.md
+++ b/funasr/runtime/docs/SDK_advanced_guide_online_zh.md
@@ -82,7 +82,7 @@
--port 10095 \
--certfile ../../../ssl_key/server.crt \
--keyfile ../../../ssl_key/server.key \
- --hotwordsfile ../../hotwords.txt > log.out 2>&1 &
+ --hotword ../../hotwords.txt > log.out 2>&1 &
```
**run_server_2pass.sh鍛戒护鍙傛暟浠嬬粛**
```text
@@ -100,7 +100,7 @@
--io-thread-num 鏈嶅姟绔惎鍔ㄧ殑IO绾跨▼鏁帮紝榛樿涓� 1
--certfile ssl鐨勮瘉涔︽枃浠讹紝榛樿涓猴細../../../ssl_key/server.crt锛屽鏋滈渶瑕佸叧闂璼sl锛屽弬鏁拌缃负0
--keyfile ssl鐨勫瘑閽ユ枃浠讹紝榛樿涓猴細../../../ssl_key/server.key
---hotwordsfile 鐑瘝鏂囦欢璺緞锛屾瘡涓�涓儹璇嶄竴琛岋紝濡傛灉瀹㈡埛绔彁渚涚儹璇嶏紝鍒欎笌瀹㈡埛绔彁渚涚殑鐑瘝鍚堝苟涓�璧蜂娇鐢ㄣ�傞粯璁や负锛�../../hotwords.txt
+--hotword 鐑瘝鏂囦欢璺緞锛屾瘡涓�涓儹璇嶄竴琛岋紝濡傛灉瀹㈡埛绔彁渚涚儹璇嶏紝鍒欎笌瀹㈡埛绔彁渚涚殑鐑瘝鍚堝苟涓�璧蜂娇鐢ㄣ�傞粯璁や负锛�../../hotwords.txt
```
### 鍏抽棴FunASR鏈嶅姟
diff --git a/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp b/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp
index 4aba830..1c87957 100644
--- a/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp
+++ b/funasr/runtime/websocket/bin/funasr-wss-server-2pass.cpp
@@ -113,7 +113,7 @@
false, "../../../ssl_key/server.key", "string");
TCLAP::ValueArg<std::string> hotwordsfile(
- "", "hotwordsfile",
+ "", "hotword",
"default: ../../hotwords.txt, path of hotwordsfile"
"connection",
false, "../../hotwords.txt", "string");
diff --git a/funasr/runtime/websocket/bin/funasr-wss-server.cpp b/funasr/runtime/websocket/bin/funasr-wss-server.cpp
index c7dba43..b571dbe 100644
--- a/funasr/runtime/websocket/bin/funasr-wss-server.cpp
+++ b/funasr/runtime/websocket/bin/funasr-wss-server.cpp
@@ -99,7 +99,7 @@
false, "../../../ssl_key/server.key", "string");
TCLAP::ValueArg<std::string> hotwordsfile(
- "", "hotwordsfile",
+ "", "hotword",
"default: ../../hotwords.txt, path of hotwordsfile"
"connection",
false, "../../hotwords.txt", "string");
--
Gitblit v1.9.1