From 5a858c69b53ba94fd660f338c7e3678c64f0d0bb Mon Sep 17 00:00:00 2001 From: Natasha Date: Mon, 16 Jan 2023 20:16:54 +0800 Subject: [PATCH] Docs/add links to deployed docs --- README.md | 10 +++++----- docs/en/flash_model/README.rst | 8 +++++--- docs/en/index.rst | 2 +- docs/en/speech_command_recognition/README.rst | 2 +- docs/en/wake_word_engine/README.rst | 2 +- docs/zh_CN/flash_model/README.rst | 4 +++- 6 files changed, 16 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 890a1f5..1a12eac 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # ESP-SR Speech Recognition Framework -[![Documentation Status](https://readthedocs.com/projects/espressif-esp-adf/badge/?version=latest)](https://docs.espressif.com/projects/esp-sr/zh_CN/latest/esp32/index.html) +[![Documentation Status](https://readthedocs.com/projects/espressif-esp-adf/badge/?version=latest)](https://docs.espressif.com/projects/esp-sr/en/latest/esp32s3/index.html) -Espressif `ESP-SR `_ helps users build AI speech solutions based on ESP32 or ESP32-S3 chips. +Espressif [ESP-SR](https://github.com/espressif/esp-sr) helps users build AI speech solutions based on ESP32 or ESP32-S3 chips. Overview -------- ESP-SR framework includes the following modules: -* Audio Front-end AFE -* Wake Word Engine WakeNet -* Speech Command Word Recognition MultiNet +* [Audio Front-end AFE](https://docs.espressif.com/projects/esp-sr/en/latest/esp32s3/audio_front_end/README.html) +* [Wake Word Engine WakeNet](https://docs.espressif.com/projects/esp-sr/en/latest/esp32s3/wake_word_engine/README.html) +* [Speech Command Word Recognition MultiNet](https://docs.espressif.com/projects/esp-sr/en/latest/esp32s3/speech_command_recognition/README.html) * Speech Synthesis (only supports Chinese language) These algorithms are provided in the form of a component, so they can be integrated into your projects with minimum effort. diff --git a/docs/en/flash_model/README.rst b/docs/en/flash_model/README.rst index c7944d8..594d51f 100644 --- a/docs/en/flash_model/README.rst +++ b/docs/en/flash_model/README.rst @@ -1,9 +1,11 @@ -Flash Model -=========== +Flashing Models +=============== :link_to_translation:`zh_CN:[中文]` -ESP-SR's WakeNet and MultiNet both use a lot of model data (which can be found in :project:`model`). Currently, ESP-SR supports the following methods to flash models: +In the AI industry, a model refers to a mathematical representation of a system or process. It is used to make predictions or decisions based on input data. There are many types of models, such as decision trees, neural networks, and support vector machines, each with their own strengths and weaknesses. Esprssif also provides our trained models such as WakeNet and MultiNet (see the model data used in :project:`model`) + +To use our models in your project, you need to flash these models. Currently, ESP-SR supports the following methods to flash models: .. only:: esp32 diff --git a/docs/en/index.rst b/docs/en/index.rst index 1054197..00d0480 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -17,7 +17,7 @@ ESP-SR User Guide Audio Front-end (AFE) Wake Word WakeNet Speech Command Word MultiNet - Flash Model + Flashing Models Resource Overhead Test Report Glossary \ No newline at end of file diff --git a/docs/en/speech_command_recognition/README.rst b/docs/en/speech_command_recognition/README.rst index c9565fd..935cb53 100644 --- a/docs/en/speech_command_recognition/README.rst +++ b/docs/en/speech_command_recognition/README.rst @@ -35,7 +35,7 @@ The following table shows the models supported by Espressif SoCs: | English | | | | √ | +---------+-----------+-------------+---------------+-------------+ -For details on flash models, see Section :doc:`flash model <../flash_model/README>` . +For details on flash models, see Section :doc:`Flashing Models <../flash_model/README>` . .. note:: Models ending with Q8 represents the 8 bit version of the model, which is more lightweight. diff --git a/docs/en/wake_word_engine/README.rst b/docs/en/wake_word_engine/README.rst index be968cc..1d750a1 100644 --- a/docs/en/wake_word_engine/README.rst +++ b/docs/en/wake_word_engine/README.rst @@ -77,7 +77,7 @@ Use WakeNet - Select WakeNet model - To select WakeNet model, please refer to Section :doc:`flash model <../flash_model/README>` . + To select WakeNet model, please refer to Section :doc:`Flashing Models <../flash_model/README>` . To customize wake words, please refer to Section :doc:`Espressif Speech Wake-up Solution Customization Process ` diff --git a/docs/zh_CN/flash_model/README.rst b/docs/zh_CN/flash_model/README.rst index cad5347..0a73cbc 100644 --- a/docs/zh_CN/flash_model/README.rst +++ b/docs/zh_CN/flash_model/README.rst @@ -3,7 +3,9 @@ :link_to_translation:`en:[English]` -ESP-SR 的 WakeNet 和 MultiNet 均会使用大量的模型数据，模型数据位于 :project:`model` 中。目前 ESP-SR 支持以下模型加载方式： +在人工智能行业中，模型是指一个系统或过程的数学表示。它用于基于输入数据做出预测或决策，有许多不同类型的模型，如决策树、神经网络和支持向量机，每种模型都有其优缺点。乐鑫也提供经过训练的 WakeNet 和 MultiNet 模型（数据模型见 :project:`model`） 。 + +使用模型前需先将其加载至你的项目，目前 ESP-SR 支持以下模型加载方式： .. only:: esp32