FunASR/docs/README.md

FunASR Documentation

中文文档 | English documentation | Model Zoo | Releases

Start Here

Your task	Guide
Choose a model, language, or timestamp capability	Model selection / 中文
Run the first transcription	Quickstart / CLI
Move from Whisper or a cloud API	Migration / 中文

Models and Deployment

Your task	Guide
Compare CPU, GPU, realtime and API runtimes	Deployment matrix / 中文
Transcribe and diarize with third-party MOSS	MOSS / 中文
Accelerate with the FunASR vLLM split engine	vLLM / 中文
Evaluate native vLLM serving	Validation record
Deploy llama.cpp, TensorRT, Docker or Kubernetes	Deployment manuals

Evaluate and Operate

• Performance methodology and realtime WebSocket benchmarks
• Troubleshooting / 中文
• Use cases, community integrations, and repository responsibilities

The product-site documentation is rendered from these Markdown sources. Edit the source once; the site build updates article content, navigation and local search. The catalogue lives in documentation.json. Model weights retain their individual licenses; the FunASR toolkit is MIT licensed.

Build the Product Documentation

From the repository root:

python -m pip install -r web-pages/product-site/requirements-site.txt
python web-pages/product-site/build.py --output /tmp/funasr-docs
python web-pages/product-site/validate.py /tmp/funasr-docs
python -m http.server --directory /tmp/funasr-docs 8000

Build the Sphinx Reference

For convenience, we provide users with the ability to generate local HTML manually.

First, you should install the following packages, which is required for building HTML:

pip3 install -U "funasr[docs]"

Then you can generate HTML manually.

cd docs
make html

The generated files are all contained in the "FunASR/docs/_build" directory. You can access the FunASR documentation by simply opening the "html/index.html" file in your browser from this directory.