From 5cfb12c7dad81d557f7012945d8812f8dfd66f4a Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期五, 21 四月 2023 14:21:19 +0800
Subject: [PATCH] docs
---
docs/index.rst | 72 ++++++++++++++++++++++++++---------
1 files changed, 53 insertions(+), 19 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index e6fe51d..30cf13e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,38 +9,27 @@
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 Recipe
./recipe/asr_recipe.md
- ./recipe/sv_recipe.md
./recipe/punc_recipe.md
./recipe/vad_recipe.md
+ ./recipe/sv_recipe.md
+ ./recipe/sd_recipe.md
-.. toctree::
- :maxdepth: 1
- :caption: Define Model
-
- ./build_task.md
-
-.. toctree::
- :maxdepth: 1
- :caption: Runtime
-
- ./runtime/export.md
- ./runtime/onnxruntime_python.md
- ./runtime/onnxruntime_cpp.md
- ./runtime/libtorch_python.md
- ./runtime/grpc_python.md
- ./runtime/grpc_cpp.md
- ./runtime/websocket_python.md
.. toctree::
:maxdepth: 1
@@ -57,7 +46,40 @@
./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 pipeline
+
+ Undo
+
+.. toctree::
+ :maxdepth: 1
+ :caption: funasr library
+
+ ./build_task.md
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Runtime and Service
+
+ ./runtime/export.md
+ ./runtime/onnxruntime_python.md
+ ./runtime/onnxruntime_cpp.md
+ ./runtime/libtorch_python.md
+ ./runtime/grpc_python.md
+ ./runtime/grpc_cpp.md
+ ./runtime/websocket_python.md
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Benchmark and Leadboard
+
+ ./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