Merge pull request #1 from pkufool/main_page

Initial version of new homepage

.github/workflows/deploy.yml

@@ -0,0 +1,86 @@
+# Copyright      2024  Wei Kang ([email protected])
+
+# See ../../LICENSE for clarification regarding multiple authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+name: Deploy site
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+
+    - name: Install requirements
+      shell: bash
+      run: |
+        python3 -m pip install -r requirements.txt
+
+    - name: Prepare k2 wheels
+      shell: bash
+      run: |
+        python3 scripts/generate_k2_wheel.py
+        python3 scripts/generate_resources.py
+
+    - name: Build pages
+      shell: bash
+      run: |
+        mkdocs build -f mkdocs.yml
+        mkdocs build -f mkdocs-zh-CN.yml
+
+    - name: Deploy pages to k2-fsa.org
+      if: github.repository_owner == 'k2-fsa'
+      run: |
+        user=${{ secrets.K2_USERNAME }}
+        server=${{ secrets.K2_HOST }}
+        port=${{ secrets.K2_PORT }}
+        echo "${{ secrets.K2_KEY }}" > id_rsa && chmod 600 id_rsa
+        scp -P $port -r -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -i id_rsa site/* $user@$server:~/www
+        rm id_rsa
+
+    - name: Build pages for kingway.fun/k2
+      if: github.repository_owner == 'pkufool'
+      shell: bash
+      run: |
+        sed -i 's/link: \//link: \/k2\//g' mkdocs.yml
+        sed -i 's/link: \//link: \/k2\//g' mkdocs-zh-CN.yml
+        mkdocs build -f mkdocs.yml
+        mkdocs build -f mkdocs-zh-CN.yml
+
+    - name: Deploy pages to kingway.fun/k2
+      if: github.repository_owner == 'pkufool'
+      run: |
+        user=${{ secrets.USERNAME }}
+        server=${{ secrets.HOST }}
+        port=${{ secrets.PORT }}
+        echo "${{ secrets.KEY }}" > id_rsa && chmod 600 id_rsa
+        scp -P $port -r -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -i id_rsa site/* $user@$server:~/deploy/k2
+        rm id_rsa

.gitignore

@@ -0,0 +1,2 @@
+.cache
+.DS_Store

custom/assets/data/asr_model_cn.json

@@ -0,0 +1,29 @@
+[
+    {
+        "language" : "中英文",
+        "mode" : "流式",
+        "engine" : "onnx",
+        "encoder" : "zipformer",
+        "type": "RNNT",
+        "download" : "wget https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2",
+        "description": "本模型由社区开发者贡献，使用了数万小时的内部商用数据，模型参数量约为 80M。\n使用方法：\nhttps://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-transducer/zipformer-transducer-models.html#csukuangfj-sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20-bilingual-chinese-english"
+    },
+    {
+        "language" : "中英文",
+        "mode" : "流式",
+        "engine" : "torch",
+        "encoder" : "zipformer",
+        "type": "RNNT",
+        "download" : "git lfs install\ngit clone https://huggingface.co/pfluo/k2fsa-zipformer-chinese-english-mixed",
+        "description": "本模型由社区开发者贡献，使用了数万小时的内部商用数据，模型参数量约为 80M。\n上述地址包含了可用于 sherpa 推理的 torch script 模型，也包含可用于导出 onnx 和 ncnn 的所有文件。"
+    },
+    {
+        "language" : "中文",
+        "mode" : "流式",
+        "engine" : "onnx",
+        "encoder" : "zipformer",
+        "type": "RNNT",
+        "download" : "GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-streaming-zipformer-zh-14M-2023-02-23\n\ncd sherpa-onnx-streaming-zipformer-zh-14M-2023-02-23\n\ngit lfs pull --include \".*onnx\"",
+        "description": "本模型使用 WenetSpeech L 训练，参数规模为 14M。\n使用方法:\nhttps://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-transducer/zipformer-transducer-models.html#csukuangfj-sherpa-onnx-streaming-zipformer-zh-14m-2023-02-23-chinese"
+    }
+]

custom/assets/data/asr_model_en.json

@@ -0,0 +1,20 @@
+[
+    {
+        "language" : "English & Chinese",
+        "mode" : "Streaming",
+        "engine" : "onnx",
+        "encoder" : "zipformer",
+        "type": "RNNT",
+        "download" : "wget https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20.tar.bz2",
+        "description": "This model is contributed by community users, trained on 10000+ hours inhouse data, #params is 80M.\nUsage:\nhttps://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-transducer/zipformer-transducer-models.html#csukuangfj-sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20-bilingual-chinese-english"
+    },
+    {
+        "language" : "English & Chinese",
+        "mode" : "streaming",
+        "engine" : "torch",
+        "encoder" : "zipformer",
+        "type": "RNNT",
+        "download" : "git lfs install\ngit clone https://huggingface.co/pfluo/k2fsa-zipformer-chinese-english-mixed",
+        "description": "This model is contributed by community users, trained on 10000+ hours inhouse data, #params is 80M.\nThe pre-trained model above contains torch script models for sherpa inference, as well as all files needed for exporting model to onnx and ncnn."
+    }
+]