mirror of
https://github.com/modelscope/FunASR.git
synced 2026-10-12 02:19:18 +00:00
106 lines
2.3 KiB
ReStructuredText
106 lines
2.3 KiB
ReStructuredText
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
|
|
|
|
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
|
|
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/rtf_reproducibility
|
|
benchmark/realtime_ws_benchmark
|
|
troubleshooting
|
|
troubleshooting_zh
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Applications and Ecosystem
|
|
|
|
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
|
|
|
|
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`
|