FunASR Documentation
====================

Build speech applications with the right model, a reproducible inference path,
and explicit deployment boundaries.

The `product documentation <https://www.funasr.com/en/docs/>`_ and
`Chinese documentation <https://www.funasr.com/docs/>`_ provide a searchable
entry to these guides. Source Markdown remains in this repository.

.. toctree::
   :maxdepth: 1
   :caption: Get Started

   transformers_native
   transformers_native_zh
   installation/installation
   installation/installation_zh
   installation/docker
   installation/docker_zh
   tutorial/README
   tutorial/README_zh
   python_api
   python_api_zh
   model_selection
   model_selection_zh
   cli
   cli_zh
   migration_from_whisper
   migration_from_whisper_zh

.. toctree::
   :maxdepth: 1
   :caption: Train and Extend

   training
   training_zh
   model_registration
   model_registration_zh

.. toctree::
   :maxdepth: 1
   :caption: Models and Deployment

   streaming_vad
   streaming_vad_zh
   keyword_spotting
   keyword_spotting_zh
   speaker_emotion
   speaker_emotion_zh
   deployment_matrix
   deployment_matrix_zh
   ./moss_transcribe_diarize.md
   ./moss_transcribe_diarize_zh.md
   vllm_guide
   vllm_guide_zh
   vllm_official_native_validation
   vllm_official_native_validation_zh
   Historical community vLLM validation (2026-08-13) <vllm_native_funasr_validation>

.. toctree::
   :maxdepth: 1
   :caption: Evaluate and Operate

   benchmark/historical_asr
   benchmark/historical_asr_zh
   benchmark/rtf_reproducibility
   benchmark/realtime_ws_benchmark
   troubleshooting
   troubleshooting_zh

.. toctree::
   :maxdepth: 1
   :caption: Applications and Ecosystem

   agent_integration
   agent_integration_zh
   use_case_showcase
   use_case_showcase_zh
   community_projects
   community_projects_zh
   repository_roles
   repository_roles_zh

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

   reference/build_task
   reference/papers
   reference/application
   reference/FQA

.. toctree::
   :maxdepth: 1
   :caption: Japanese and Korean Guides

   model_selection_ja
   deployment_matrix_ja
   model_selection_ko
   deployment_matrix_ko
   agent_integration_ja
   agent_integration_ko
   benchmark/historical_asr_ja
   benchmark/historical_asr_ko

Model weights and runtime choices
---------------------------------

- `Model Zoo <https://github.com/modelscope/FunASR/tree/main/model_zoo>`_
- `Production deployment manuals <https://www.funasr.com/en/deploy/>`_
- `Training examples <https://github.com/modelscope/FunASR/tree/main/examples>`_
- `Release assets <https://github.com/modelscope/FunASR/releases>`_

Indices
-------

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