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: Tutorial:

   ./get_started.md
   ./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:

   ./papers.md


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

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