From c2575f022df4d125c9bd1e2b25142417c0a277b5 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期一, 22 七月 2024 17:11:44 +0800
Subject: [PATCH] docs

---
 examples/README.md |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

diff --git a/examples/README.md b/examples/README.md
index fe9a0ed..802b1a4 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -96,6 +96,15 @@
 text = rich_transcription_postprocess(res[0]["text"])
 print(text)
 ```
+Notes:
+- `model_dir`: The name of the model, or the path to the model on the local disk.
+- `vad_model`: This indicates the activation of VAD (Voice Activity Detection). The purpose of VAD is to split long audio into shorter clips. In this case, the inference time includes both VAD and SenseVoice total consumption, and represents the end-to-end latency. If you wish to test the SenseVoice model's inference time separately, the VAD model can be disabled.
+- `vad_kwargs`: Specifies the configurations for the VAD model. `max_single_segment_time`: denotes the maximum duration for audio segmentation by the `vad_model`, with the unit being milliseconds (ms).
+- `use_itn`: Whether the output result includes punctuation and inverse text normalization.
+- `batch_size_s`: Indicates the use of dynamic batching, where the total duration of audio in the batch is measured in seconds (s).
+- `merge_vad`: Whether to merge short audio fragments segmented by the VAD model, with the merged length being `merge_length_s`, in seconds (s).
+- `ban_emo_unk`: Whether to ban the output of the `emo_unk` token.
+
 ##### Paraformer
 ```python
 from funasr import AutoModel

--
Gitblit v1.9.1