zhifu gao
2023-04-24 331d57253ae25dd42c8e14930dee30cd8d2affa6
docs/index.rst
@@ -9,43 +9,101 @@
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:
   :caption: Installation
   ./installation.md
   ./docker.md
.. toctree::
   :maxdepth: 1
   :caption: Tutorial:
   :caption: Academic Egs
   ./get_started.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: 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: Model Zoo
   ./modelscope_models.md
   ./huggingface_models.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_onnx_cpp.md
   ./benchmark/benchmark_libtorch.md
.. toctree::
   :maxdepth: 1
   :caption: Funasr Library
   ./build_task.md
.. toctree::
   :maxdepth: 1
   :caption: Runtime:
   ./export.md
   ../funasr/export/README.md
   ../funasr/runtime/python/onnxruntime/README.md
   ../funasr/runtime/python/libtorch/README.md
   ../funasr/runtime/onnxruntime/readme.md
   ../funasr/runtime/grpc/Readme.md
.. toctree::
   :maxdepth: 1
   :caption: ModelScope pipeline:
   ./modelscope_models.md
   ./modelscope_usages.md
.. toctree::
   :maxdepth: 1
   :caption: Papers:
   :caption: Papers
   ./papers.md
.. toctree::
   :maxdepth: 1
   :caption: Application
   ./application.md
.. toctree::
   :maxdepth: 1
   :caption: FQA
   ./FQA.md
Indices and tables
==================