docs: fix same bugs in docs

This commit is contained in:
sxy 2022-12-02 11:39:21 +08:00
parent b9270775aa
commit 9ac683e82d
8 changed files with 16 additions and 15 deletions

View File

@ -18,7 +18,7 @@ Espressif wake word engine [WakeNet](docs/wake_word_engine/README.md) is special
Currently, Espressif has not only provided an official wake word "Hi,Lexin","Hi,ESP" to public for free, but also allows customized wake words. For details on how to customize your own wake words, please see [Espressif Speech Wake Words Customization Process](docs/wake_word_engine/ESP_Wake_Words_Customization.md).
- [WakeNet Performance](docs/performance_test/README.md)
- [WakeNet Performance](docs/benchmark/README.md)
## Speech Command Recognition
@ -26,7 +26,7 @@ Espressif's speech command recognition model [MultiNet](docs/speech_command_reco
Currently, Espressif **MultiNet** supports up to 200 Chinese or English speech commands, such as “打开空调” (Turn on the air conditioner) and “打开卧室灯” (Turn on the bedroom light).
- [MultiNet Performance](docs/performance_test/README.md)
- [MultiNet Performance](docs/benchmark/README.md)
## Audio Front End
@ -34,7 +34,7 @@ Espressif Audio Front-End [AFE](docs/audio_front_end/README.md) integrates AEC (
Our two-mic Audio Front-End (AFE) have been qualified as a “Software Audio Front-End Solution” for [Amazon Alexa Built-in devices](https://developer.amazon.com/en-US/alexa/solution-providers/dev-kits#software-audio-front-end-dev-kits).
- [Audio Front-End Performance](docs/performance_test/README.md)
- [Audio Front-End Performance](docs/benchmark/README.md)
**In order to achieve optimal performance:**

View File

@ -26,7 +26,7 @@ ESP32_DOCS = ['audio_front_end/README.rst',
'flash_model/README.rst',
'audio_front_end/Espressif_Microphone_Design_Guidelines.rst',
'test_report/README.rst',
'performance_test/README.rst',
'benchmark/README.rst',
]
# format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers

View File

@ -24,6 +24,6 @@ Based on years of hardware design and development experience, Loxin can provide
Model loading method <flash_model/README>
Microphone Design Guidelines <audio_front_end/Espressif_Microphone_Design_Guidelines>
Test Reports <test_report/README>
Performance Testing <performance_test/README>
Performance Testing <benchmark/README>
Translated with www.DeepL.com/Translator (free version)

View File

@ -94,7 +94,7 @@ Use wakeNet
Performance Test
----------------
Please refer to `Performance Test <../performance_test/README.rst>`__.
Please refer to `Performance Test <../benchmark/README.rst>`__.
Wake Word Customization
-----------------------

View File

@ -10,9 +10,9 @@ ESP-SR 用户指南
ESP-SR 支持以下模块
* AFE 声学前端算法 <audio_front_end/README>
* 唤醒词检测 (Wake Word Detection) <wake_word_engine/README>
* 自定义语音指令识别 (Speech Command Recognition) <speech_command_recognition/README>
* `声学前端算法 <audio_front_end/README.md>`__
* `唤醒词检测 <wake_word_engine/README.md>`__
* `唤醒词检测 <speech_command_recognition/README>`__
* 语音合成 (目前只支持中文)
准备工作
@ -25,20 +25,21 @@ ESP-SR 支持以下模块
* **USB 数据线** (A 转 Micro-B)
* 电脑 (Linux)
。。 note:: 目前一些开发板使用的是 USB Type C 接口。请确保使用合适的数据线连接开发板!
.. note:: 目前一些开发板使用的是 USB Type C 接口。请确保使用合适的数据线连接开发板!
软件:
~~~~~~
* 下载 `ESP-SKAINET <https://github.com/espressif/esp-skainet>` ESP-SR 将作为 ESP-SKAINET 的组件被一起下载
* 配置安装 ESPIDF, 推荐使用 ESP-SKAINET 中包含的版本。 安装方法请参考 ESP-IDF 快速入门 https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html
* 下载 `ESP-SKAINET <https://github.com/espressif/esp-skainet>`ESP-SR 将作为 ESP-SKAINET 的组件被一起下载
* 配置安装 ESPIDF,推荐使用 ESP-SKAINET 中包含的版本。安装方法请参考 ESP-IDF 快速入门 https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/get-started/index.html
编译运行一个示例
----
* 进入 ESP-SKAINET/examples/cn_speech_commands_recognition 目录,该示例为中文命令指令识别示例,通过说指定唤醒词,触发语音指令识别,当一段时间没有语音指令后,会关闭语音指令识别,并等待下一次唤醒词触发
* 进入 ESP-SKAINET/examples/cn_speech_commands_recognition 目录。
* 参考该示例目录下的配置和编译说明,运行该示例。
* 该示例为中文命令指令识别示例,通过说唤醒词(Hi,乐鑫),触发语音指令识别。当一段时间没有语音指令后,会关闭语音指令识别,并等待下一次唤醒词触发。
   
.. toctree::
:hidden:
@ -50,4 +51,4 @@ ESP-SR 支持以下模块
模型加载方式 <flash_model/README>
麦克风设计指南 <audio_front_end/Espressif_Microphone_Design_Guidelines>
测试报告 <test_report/README>
性能测试 <performance_test/README>
性能测试 <benchmark/README>

View File

@ -99,7 +99,7 @@ WakeNet使用
性能测试
--------
具体请参考 `Performance Test <../performance_test/README.md>`__
具体请参考 `Performance Test <../benchmark/README.md>`__
唤醒词定制
----------