deploy: e24568e

k2-fsa · Oct 13, 2024 · 2b8b5fd · 2b8b5fd
commit 2b8b5fd
Show file tree

Hide file tree

Showing 790 changed files with 246,463 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 02fb259b3c10616edf9e48803ed39b3a
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/1.png b/_images/1.png
diff --git a/_images/2.png b/_images/2.png
diff --git a/_images/2023-01-09-fp32-decoding.png b/_images/2023-01-09-fp32-decoding.png
diff --git a/_images/2023-01-09-int8-decoding.png b/_images/2023-01-09-int8-decoding.png
diff --git a/_images/3.png b/_images/3.png
diff --git a/_images/add-an-account-2.png b/_images/add-an-account-2.png
diff --git a/_images/add-an-account-21.png b/_images/add-an-account-21.png
diff --git a/_images/add-an-account-3.png b/_images/add-an-account-3.png
diff --git a/_images/add-an-account-31.png b/_images/add-an-account-31.png
diff --git a/_images/add-an-account-4.png b/_images/add-an-account-4.png
diff --git a/_images/add-an-account-41.png b/_images/add-an-account-41.png
diff --git a/_images/add-an-account-5.png b/_images/add-an-account-5.png
diff --git a/_images/add-an-account-51.png b/_images/add-an-account-51.png
diff --git a/_images/add-an-account.png b/_images/add-an-account.png
diff --git a/_images/add-an-account1.png b/_images/add-an-account1.png
diff --git a/_images/add-framework-to-your-project.png b/_images/add-framework-to-your-project.png
diff --git a/_images/add-other.png b/_images/add-other.png
diff --git a/_images/after-finishing-build.png b/_images/after-finishing-build.png
diff --git a/_images/after-finishing-build1.png b/_images/after-finishing-build1.png
diff --git a/_images/analyze-apk-result.jpg b/_images/analyze-apk-result.jpg
diff --git a/_images/analyze-apk-result.png b/_images/analyze-apk-result.png
diff --git a/_images/analyze-apk.png b/_images/analyze-apk.png
diff --git a/_images/analyze-apk1.png b/_images/analyze-apk1.png
diff --git a/_images/android-studio-version.png b/_images/android-studio-version.png
diff --git a/_images/android-studio-version1.png b/_images/android-studio-version1.png
diff --git a/_images/arecord.jpg b/_images/arecord.jpg
diff --git a/_images/build-make-project.png b/_images/build-make-project.png
diff --git a/_images/build-make-project1.png b/_images/build-make-project1.png
diff --git a/_images/client-1.jpg b/_images/client-1.jpg
diff --git a/_images/client-2.jpg b/_images/client-2.jpg
diff --git a/_images/client-3.jpg b/_images/client-3.jpg
diff --git a/_images/client-4.jpg b/_images/client-4.jpg
diff --git a/_images/client-5.jpg b/_images/client-5.jpg
diff --git a/_images/conformer-rnnt-streaming-asr-web-client.jpg b/_images/conformer-rnnt-streaming-asr-web-client.jpg
diff --git a/_images/context_graph.png b/_images/context_graph.png
diff --git a/_images/cuda_ge_10.1-orange.svg b/_images/cuda_ge_10.1-orange.svg
diff --git a/_images/emformer-streaming-asr-web-client.png b/_images/emformer-streaming-asr-web-client.png
diff --git a/_images/error-no-model.png b/_images/error-no-model.png
diff --git a/_images/error-no-model1.png b/_images/error-no-model1.png
diff --git a/_images/header-search-path.png b/_images/header-search-path.png
diff --git a/_images/hf-space.png b/_images/hf-space.png
diff --git a/_images/hugging-face-sherpa-2.png b/_images/hugging-face-sherpa-2.png
diff --git a/_images/hugging-face-sherpa-3.png b/_images/hugging-face-sherpa-3.png
diff --git a/_images/hugging-face-sherpa.png b/_images/hugging-face-sherpa.png
diff --git a/_images/link-libc++.png b/_images/link-libc++.png
diff --git a/_images/linux-x64.jpg b/_images/linux-x64.jpg
diff --git a/_images/lscpu.jpg b/_images/lscpu.jpg
diff --git a/_images/lscpu2.jpg b/_images/lscpu2.jpg
diff --git a/_images/lscpu21.jpg b/_images/lscpu21.jpg
diff --git a/_images/macos-x64.jpg b/_images/macos-x64.jpg
diff --git a/_images/microphone-alsa.jpg b/_images/microphone-alsa.jpg
diff --git a/_images/ndk-tools.png b/_images/ndk-tools.png
diff --git a/_images/ndk-tools1.png b/_images/ndk-tools1.png
diff --git a/_images/open-sherpa-ncnn.png b/_images/open-sherpa-ncnn.png
diff --git a/_images/open-sherpa-onnx.png b/_images/open-sherpa-onnx.png
diff --git a/_images/os-brightgreen.svg b/_images/os-brightgreen.svg
diff --git a/_images/pre-trained-model-1.png b/_images/pre-trained-model-1.png
diff --git a/_images/pre-trained-model-11.png b/_images/pre-trained-model-11.png
diff --git a/_images/pre-trained-model-2022-12-06.png b/_images/pre-trained-model-2022-12-06.png
diff --git a/_images/pre-trained-model-2023-02-20.png b/_images/pre-trained-model-2023-02-20.png
diff --git a/_images/pub-dev.png b/_images/pub-dev.png
diff --git a/_images/python_ge_3.7-blue.svg b/_images/python_ge_3.7-blue.svg
diff --git a/_images/pytorch_ge_1.6.0-blueviolet.svg b/_images/pytorch_ge_1.6.0-blueviolet.svg
diff --git a/_images/qq-group-for-next-gen-kaldi.jpg b/_images/qq-group-for-next-gen-kaldi.jpg
diff --git a/_images/raspberrypi_3b_shot_1.png b/_images/raspberrypi_3b_shot_1.png
diff --git a/_images/raspberrypi_3b_shot_2.png b/_images/raspberrypi_3b_shot_2.png
diff --git a/_images/raspberrypi_3b_shot_4.png b/_images/raspberrypi_3b_shot_4.png
diff --git a/_images/raspberrypi_3b_shot_5.png b/_images/raspberrypi_3b_shot_5.png
diff --git a/_images/rtf-1-thread.jpg b/_images/rtf-1-thread.jpg
diff --git a/_images/rtf-2-threads.jpg b/_images/rtf-2-threads.jpg
diff --git a/_images/rtf-2-threads1.jpg b/_images/rtf-2-threads1.jpg
diff --git a/_images/rtf-4-threads.jpg b/_images/rtf-4-threads.jpg
diff --git a/_images/rtf-4-threads1.jpg b/_images/rtf-4-threads1.jpg
diff --git a/_images/rtf-6-threads.jpg b/_images/rtf-6-threads.jpg
diff --git a/_images/rtf.jpg b/_images/rtf.jpg
diff --git a/_images/rule1.png b/_images/rule1.png
diff --git a/_images/rule2.png b/_images/rule2.png
diff --git a/_images/rule3.png b/_images/rule3.png
diff --git a/_images/run-2.png b/_images/run-2.png
diff --git a/_images/run-21.png b/_images/run-21.png
diff --git a/_images/run-3.png b/_images/run-3.png
diff --git a/_images/run-31.png b/_images/run-31.png
diff --git a/_images/run-4.jpg b/_images/run-4.jpg
diff --git a/_images/run-4.png b/_images/run-4.png
diff --git a/_images/run-5.jpg b/_images/run-5.jpg
diff --git a/_images/run-5.png b/_images/run-5.png
diff --git a/_images/run-6.jpg b/_images/run-6.jpg
diff --git a/_images/run-7.jpg b/_images/run-7.jpg
diff --git a/_images/run-the-project.png b/_images/run-the-project.png
diff --git a/_images/run-the-project1.png b/_images/run-the-project1.png
diff --git a/_images/run.png b/_images/run.png
diff --git a/_images/run1.png b/_images/run1.png
diff --git a/_images/select-device-2.png b/_images/select-device-2.png
diff --git a/_images/select-device-21.png b/_images/select-device-21.png
diff --git a/_images/select-device.png b/_images/select-device.png
diff --git a/_images/select-device1.png b/_images/select-device1.png
diff --git a/_images/select-product-build.png b/_images/select-product-build.png
diff --git a/_images/select-product-build1.png b/_images/select-product-build1.png
diff --git a/_images/select-sdk-manager.png b/_images/select-sdk-manager.png
diff --git a/_images/select-sdk-manager1.png b/_images/select-sdk-manager1.png
diff --git a/_images/sense-voice-hf-space.jpg b/_images/sense-voice-hf-space.jpg
diff --git a/_images/set-bridging-header.png b/_images/set-bridging-header.png
diff --git a/_images/set-framework-search-path.png b/_images/set-framework-search-path.png
diff --git a/_images/so-libs-for-arm64-v8a.jpg b/_images/so-libs-for-arm64-v8a.jpg
diff --git a/_images/so-libs-for-arm64-v8a.png b/_images/so-libs-for-arm64-v8a.png
diff --git a/_images/so-libs-for-armeabi-v7a.png b/_images/so-libs-for-armeabi-v7a.png
diff --git a/_images/so-libs-for-armv7a-eabi.jpg b/_images/so-libs-for-armv7a-eabi.jpg
diff --git a/_images/so-libs-for-x86-64.jpg b/_images/so-libs-for-x86-64.jpg
diff --git a/_images/so-libs-for-x86-64.png b/_images/so-libs-for-x86-64.png
diff --git a/_images/so-libs-for-x86.jpg b/_images/so-libs-for-x86.jpg
diff --git a/_images/start-android-studio.png b/_images/start-android-studio.png
diff --git a/_images/start-android-studio1.png b/_images/start-android-studio1.png
diff --git a/_images/start-xcode-for-sherpa-ncnn.png b/_images/start-xcode-for-sherpa-ncnn.png
diff --git a/_images/start-xcode-for-sherpa-onnx.png b/_images/start-xcode-for-sherpa-onnx.png
diff --git a/_images/step-to-add-pre-trained-model-1.png b/_images/step-to-add-pre-trained-model-1.png
diff --git a/_images/step-to-add-pre-trained-model-11.png b/_images/step-to-add-pre-trained-model-11.png
diff --git a/_images/step-to-add-pre-trained-model-2.png b/_images/step-to-add-pre-trained-model-2.png
diff --git a/_images/step-to-add-pre-trained-model-21.png b/_images/step-to-add-pre-trained-model-21.png
diff --git a/_images/step-to-add-pre-trained-model-3.png b/_images/step-to-add-pre-trained-model-3.png
diff --git a/_images/step-to-add-pre-trained-model-31.png b/_images/step-to-add-pre-trained-model-31.png
diff --git a/_images/step-to-add-pre-trained-model-4.png b/_images/step-to-add-pre-trained-model-4.png
diff --git a/_images/step-to-add-pre-trained-model-41.png b/_images/step-to-add-pre-trained-model-41.png
diff --git a/_images/streaming-1.png b/_images/streaming-1.png
diff --git a/_images/streaming-2.png b/_images/streaming-2.png
diff --git a/_images/type-for-pre-trained-model-2022-12-06.png b/_images/type-for-pre-trained-model-2022-12-06.png
diff --git a/_images/type-for-pre-trained-model-2023-02-20.png b/_images/type-for-pre-trained-model-2023-02-20.png
diff --git a/_images/utf8-setting.jpg b/_images/utf8-setting.jpg
diff --git a/_images/visit.png b/_images/visit.png
diff --git a/_images/visit2.png b/_images/visit2.png
diff --git a/_images/wasm-asr-sherpa-onnx-1.png b/_images/wasm-asr-sherpa-onnx-1.png
diff --git a/_images/wasm-asr-sherpa-onnx-2.png b/_images/wasm-asr-sherpa-onnx-2.png
diff --git a/_images/wasm-hf-en.png b/_images/wasm-hf-en.png
diff --git a/_images/wasm-hf-en1.png b/_images/wasm-hf-en1.png
diff --git a/_images/wasm-hf-tts-de.png b/_images/wasm-hf-tts-de.png
diff --git a/_images/wasm-hf-tts-en.png b/_images/wasm-hf-tts-en.png
diff --git a/_images/wasm-hf-zh-en-paraformer.png b/_images/wasm-hf-zh-en-paraformer.png
diff --git a/_images/wasm-hf-zh-en-zipformer.png b/_images/wasm-hf-zh-en-zipformer.png
diff --git a/_images/wasm-hf-zh-en.png b/_images/wasm-hf-zh-en.png
diff --git a/_images/wasm-hf-zh-yue-en-paraformer.png b/_images/wasm-hf-zh-yue-en-paraformer.png
diff --git a/_images/wasm-sherpa-ncnn-1.png b/_images/wasm-sherpa-ncnn-1.png
diff --git a/_images/wasm-sherpa-ncnn-2.png b/_images/wasm-sherpa-ncnn-2.png
diff --git a/_images/wasm-sherpa-onnx-tts-1.png b/_images/wasm-sherpa-onnx-tts-1.png
diff --git a/_images/wasm-sherpa-onnx-tts-2.png b/_images/wasm-sherpa-onnx-tts-2.png
diff --git a/_images/wechat-group-for-next-gen-kaldi.jpg b/_images/wechat-group-for-next-gen-kaldi.jpg
diff --git a/_images/wechat-group-for-next-gen-kaldi1.jpg b/_images/wechat-group-for-next-gen-kaldi1.jpg
diff --git a/_images/wenet-models-onnx-list.jpg b/_images/wenet-models-onnx-list.jpg
diff --git a/_images/whisper-colab.png b/_images/whisper-colab.png
diff --git a/_images/whisper-hf.png b/_images/whisper-hf.png
diff --git a/_images/windows-x64.jpg b/_images/windows-x64.jpg
diff --git a/_images/xcode-settings.png b/_images/xcode-settings.png
diff --git a/_images/xcode-settings1.png b/_images/xcode-settings1.png
diff --git a/_sources/cpp/installation/index.rst.txt b/_sources/cpp/installation/index.rst.txt
@@ -0,0 +1,86 @@
+.. _cpp_installation:
+
+Installation
+============
+
+Before installing `sherpa`_, we assume you have installed:
+
+- `PyTorch`_
+- `k2`_
+- `kaldifeat`_
+
+You can use the following commands to install `sherpa`_:
+
+.. code-block:: bash
+
+   git clone http://github.com/k2-fsa/sherpa
+   cd sherpa
+   python3 setup.py bdist_wheel
+   ls -lh dist
+   pip install ./dist/k2_sherpa*.whl
+
+.. caution::
+
+   Please don't use ``python3 setup.py install``. Otherwise, you won't get
+   `sherpa`_ related binaries installed, such as ``sherpa-offline`` and
+   ``sherpa-online``.
+
+To uninstall `sherpa`_, please use
+
+.. code-block:: bash
+
+   pip uninstall k2-sherpa
+
+To test that you have installed `sherpa`_ successfully, you can run the
+following commands:
+
+.. code-block:: bash
+
+   sherpa-version
+
+   sherpa-offline --help
+   sherpa-online --help
+   sherpa-online-microphone --help
+
+   sherpa-offline-websocket-server --help
+   sherpa-offline-websocket-client --help
+
+   sherpa-online-websocket-server --help
+   sherpa-online-websocket-client --help
+   sherpa-online-websocket-client-microphone --help
+
+If you have any issues about the installation, please create an issue
+at the following address:
+
+  `<https://github.com/k2-fsa/sherpa/issues>`_
+
+.. hint::
+
+   If you have a `WeChat <https://www.wechat.com/>`_ account, you can scan
+   the following QR code to join the WeChat group of next-gen Kaldi to get
+   help.
+
+   .. image:: pic/wechat-group-for-next-gen-kaldi.jpg
+    :width: 200
+    :align: center
+    :alt: WeChat group of next-gen Kaldi
+
+
+Installation for advanced users/developers
+------------------------------------------
+
+As an advanced user/developer, you can use the following method to
+install `sherpa`_:
+
+
+.. code-block:: bash
+
+   git clone http://github.com/k2-fsa/sherpa
+   cd sherpa
+   mkdir build
+   cd build
+   cmake ..
+   make -j
+
+   export PATH=$PWD/bin:$PATH
+   export PYTHONPATH=$PWD/lib:$PWD/../sherpa/python:$PYTHONPATH
diff --git a/_sources/cpp/offline_asr/api.rst.txt b/_sources/cpp/offline_asr/api.rst.txt
@@ -0,0 +1,76 @@
+C++ APIs
+========
+
+We provide C++ APIs for non-streaming ASR
+in
+`a single header file <https://github.com/k2-fsa/sherpa/blob/master/sherpa/cpp_api/offline_recognizer.h>`_.
+
+`<https://github.com/k2-fsa/sherpa-torch-cpp-makefile-example>`_
+gives an example of how to use the APIs to decode wave files.
+
+.. hint::
+
+  You can find more examples in
+  `<https://github.com/k2-fsa/sherpa/tree/master/sherpa/cpp_api>`_
+
+The content of the `Makefile <https://github.com/k2-fsa/sherpa-torch-cpp-makefile-example/blob/master/Makefile>`_
+from the above repository is given below:
+
+.. code-block:: makefile
+
+  sherpa_install_dir := $(shell python3 -c 'import os; import sherpa; print(os.path.dirname(sherpa.__file__))')
+  sherpa_cxx_flags := $(shell python3 -c 'import os; import sherpa; print(sherpa.cxx_flags)')
+
+  $(info sherpa_install_dir: $(sherpa_install_dir))
+  $(info sherpa_cxx_flags: $(sherpa_cxx_flags))
+
+  CXXFLAGS := -I$(sherpa_install_dir)/include
+  CXXFLAGS += -Wl,-rpath,$(sherpa_install_dir)/lib
+  CXXFLAGS += $(sherpa_cxx_flags)
+  CXXFLAGS += -std=c++14
+
+  LDFLAGS := -L $(sherpa_install_dir)/lib -lsherpa_offline_recognizer
+
+  $(info CXXFLAGS: $(CXXFLAGS))
+  $(info LDFLAGS: $(LDFLAGS))
+
+  test_decode_files: test_decode_files.cc
+    $(CXX) $(CXXFLAGS) -o $@ $< $(LDFLAGS)
+
+  .PHONY: clean
+  clean:
+    $(RM) test_decode_files
+
+Basically, you only need to specify the following stuff to use the non-streaming
+ASR APIs:
+
+- The path to find the header file. You provide:
+
+  .. code-block:: makefile
+
+    CXXFLAGS := -I$(sherpa_install_dir)/include
+
+- The library to link to. You provide:
+
+  .. code-block:: makefile
+
+    LDFLAGS := -L $(sherpa_install_dir)/lib -lsherpa_offline_recognizer
+
+- The CXX flags used to compile ``sherpa``. You provide:
+
+  .. code-block:: makefile
+
+    CXXFLAGS += $(sherpa_cxx_flags)
+
+  .. hint::
+
+    This one is important. For instance, if ``sherpa`` was compiled with
+    ``-D_GLIBCXX_USE_CXX11_ABI=0`` on Linux, you will get link errors like
+    the below one if you don't use this option in your project.
+
+    .. code-block::
+
+      test_decode_files.cc:(.text+0x149): undefined reference to
+      `sherpa::OfflineRecognizer::OfflineRecognizer(std::__cxx11::basic_string<char,
+      std::char_traits<char>, std::allocator<char> > const&, std::__cxx11::basic_string<char,
+      std::char_traits<char>, std::allocator<char> > const&, sherpa::DecodingOptions const&, bool, float)'