index.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. .. Funasr documentation master file, created by
  2. sphinx-quickstart on Tues Dec 6 19:05:00 2022.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. FunASR: A Fundamental End-to-End Speech Recognition Toolkit
  6. ============================================================
  7. .. image:: ./images/funasr_logo.jpg
  8. 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!
  9. .. toctree::
  10. :maxdepth: 1
  11. :caption: Installation
  12. ./installation.md
  13. .. toctree::
  14. :maxdepth: 1
  15. :caption: Recipe
  16. ./recipe/asr_recipe.md
  17. ./recipe/sv_recipe.md
  18. ./recipe/punc_recipe.md
  19. ./recipe/vad_recipe.md
  20. .. toctree::
  21. :maxdepth: 1
  22. :caption: Custom Your Model
  23. ./build_task.md
  24. .. toctree::
  25. :maxdepth: 1
  26. :caption: Model Zoo
  27. ./modelscope_models.md
  28. ./huggingface_models.md
  29. .. toctree::
  30. :maxdepth: 1
  31. :caption: ModelScope pipeline
  32. ./modescope_pipeline/quick_start.md
  33. ./modescope_pipeline/asr_pipeline.md
  34. ./modescope_pipeline/vad_pipeline.md
  35. ./modescope_pipeline/punc_pipeline.md
  36. ./modescope_pipeline/tp_pipeline.md
  37. ./modescope_pipeline/sv_pipeline.md
  38. ./modescope_pipeline/lm_pipeline.md
  39. .. toctree::
  40. :maxdepth: 1
  41. :caption: Runtime
  42. ./runtime/export.md
  43. ./runtime/onnxruntime_python.md
  44. ./runtime/onnxruntime_cpp.md
  45. ./runtime/libtorch_python.md
  46. ./runtime/grpc_python.md
  47. ./runtime/grpc_cpp.md
  48. ./runtime/websocket_python.md
  49. .. toctree::
  50. :maxdepth: 1
  51. :caption: Benchmark and Leadboard
  52. ./benchmark/benchmark_onnx.md
  53. ./benchmark/benchmark_libtorch.md
  54. .. toctree::
  55. :maxdepth: 1
  56. :caption: Papers
  57. ./papers.md
  58. .. toctree::
  59. :maxdepth: 1
  60. :caption: FQA
  61. ./FQA.md
  62. Indices and tables
  63. ==================
  64. * :ref:`genindex`
  65. * :ref:`modindex`
  66. * :ref:`search`