FunASR/docs/index.rst

.. Funasr documentation master file, created by
   sphinx-quickstart on Tues Dec 6 19:05:00 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

FunASR: A Fundamental End-to-End Speech Recognition Toolkit
============================================================
.. image:: ./images/funasr_logo.jpg

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！

.. toctree::
   :maxdepth: 1
   :caption: Installation

   ./installation.md

.. toctree::
   :maxdepth: 1
   :caption: Recipe

   ./recipe/asr_recipe.md
   ./recipe/sv_recipe.md
   ./recipe/punc_recipe.md
   ./recipe/vad_recipe.md

.. toctree::
   :maxdepth: 1
   :caption: Custom Your Model

   ./build_task.md

.. toctree::
   :maxdepth: 1
   :caption: Model Zoo

   ./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

.. 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
   :caption: Papers

   ./papers.md

.. toctree::
   :maxdepth: 1
   :caption: API Reference



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`