From 3cd3473bf7a3b41484baa86d9092248d78e7af39 Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期五, 21 四月 2023 17:17:37 +0800
Subject: [PATCH] docs
---
docs/index.rst | 74 +++++++++++++++++++++++++++----------
1 files changed, 54 insertions(+), 20 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index e6fe51d..e8b0711 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,30 +9,62 @@
FunASR hopes to build a bridge between academic research and industrial applications on speech recognition. By supporting the training & finetuning of the industrial-grade speech recognition model released on `ModelScope <https://www.modelscope.cn/models?page=1&tasks=auto-speech-recognition>`_, researchers and developers can conduct research and production of speech recognition models more conveniently, and promote the development of speech recognition ecology. ASR for Fun锛�
+Overview
+============================================================
+.. image:: ./images/funasr_overview.png
+
.. toctree::
:maxdepth: 1
:caption: Installation
./installation.md
+ ./docker.md
.. toctree::
:maxdepth: 1
- :caption: Recipe
+ :caption: Academic Egs
- ./recipe/asr_recipe.md
- ./recipe/sv_recipe.md
- ./recipe/punc_recipe.md
- ./recipe/vad_recipe.md
+ ./academic_recipe/asr_recipe.md
+ ./academic_recipe/punc_recipe.md
+ ./academic_recipe/vad_recipe.md
+ ./academic_recipe/sv_recipe.md
+ ./academic_recipe/sd_recipe.md
+
.. toctree::
:maxdepth: 1
- :caption: Define Model
+ :caption: Model Zoo
+
+ ./modelscope_models.md
+ ./huggingface_models.md
+
+.. toctree::
+ :maxdepth: 1
+ :caption: ModelScope Egs
+
+ ./modescope_pipeline/quick_start.md
+ ./modescope_pipeline/asr_pipeline.md
+ ./modescope_pipeline/vad_pipeline.md
+ ./modescope_pipeline/punc_pipeline.md
+ ./modescope_pipeline/tp_pipeline.md
+ ./modescope_pipeline/sv_pipeline.md
+ ./modescope_pipeline/sd_pipeline.md
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Huggingface Egs
+
+ Undo
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Funasr Library
./build_task.md
.. toctree::
:maxdepth: 1
- :caption: Runtime
+ :caption: Runtime and Service
./runtime/export.md
./runtime/onnxruntime_python.md
@@ -44,20 +76,10 @@
.. toctree::
:maxdepth: 1
- :caption: Model Zoo
+ :caption: Benchmark and Leadboard
- ./modelscope_models.md
- ./huggingface_models.md
-
-.. toctree::
- :maxdepth: 1
- :caption: ModelScope pipeline
-
- ./modescope_pipeline/quick_start.md
- ./modescope_pipeline/asr_pipeline.md
- ./modescope_pipeline/vad_pipeline.md
- ./modescope_pipeline/punc_pipeline.md
- ./modescope_pipeline/sv_pipeline.md
+ ./benchmark/benchmark_onnx.md
+ ./benchmark/benchmark_libtorch.md
.. toctree::
:maxdepth: 1
@@ -65,6 +87,18 @@
./papers.md
+.. toctree::
+ :maxdepth: 1
+ :caption: Application
+
+ ./application.md
+
+.. toctree::
+ :maxdepth: 1
+ :caption: FQA
+
+ ./FQA.md
+
Indices and tables
==================
--
Gitblit v1.9.1