docs

游雁

2023-04-19 81e56b26279cc48a087190b28cf26ff25e22bb11

docs

 .github/workflows/main.yml

@@ -18,10 +18,10 @@
        with:
          docs-folder: "docs/"
          pre-build-command: "pip install sphinx-markdown-tables nbsphinx jinja2 recommonmark sphinx_rtd_theme"
      - uses: ammaraskar/sphinx-action@master
        with:
          docs-folder: "docs_cn/"
          pre-build-command: "pip install sphinx-markdown-tables nbsphinx jinja2 recommonmark sphinx_rtd_theme"
#      - uses: ammaraskar/sphinx-action@master
#        with:
#          docs-folder: "docs_cn/"
#          pre-build-command: "pip install sphinx-markdown-tables nbsphinx jinja2 recommonmark sphinx_rtd_theme"

      - name: deploy copy
        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev_wjm' || github.ref == 'refs/heads/dev_lyh'
@@ -31,9 +31,9 @@
          mkdir public/en
          touch public/en/.nojekyll
          cp -r docs/_build/html/* public/en/
          mkdir public/cn
          touch public/cn/.nojekyll
          cp -r docs_cn/_build/html/* public/cn/
#          mkdir public/cn
#          touch public/cn/.nojekyll
#          cp -r docs_cn/_build/html/* public/cn/
          mkdir public/m2met2
          touch public/m2met2/.nojekyll
          cp -r docs_m2met2/_build/html/* public/m2met2/

 docs/benchmark/benchmark_libtorch.md

New file
@@ -0,0 +1 @@
../../funasr/runtime/python/benchmark_libtorch.md

 docs/benchmark/benchmark_onnx.md

New file
@@ -0,0 +1 @@
../../funasr/runtime/python/benchmark_onnx.md

 docs/index.rst

@@ -63,6 +63,13 @@

.. toctree::
   :maxdepth: 1
   :caption: Benchmark and Leadboard

   ./benchmark/benchmark_onnx.md
   ./benchmark/benchmark_libtorch.md

.. toctree::
   :maxdepth: 1
   :caption: Papers

   ./papers.md

 docs_cn/Makefile

File was deleted

 docs_cn/build_task.md

File was deleted

 docs_cn/conf.py

File was deleted

 docs_cn/get_started.md

File was deleted

 docs_cn/images/DeepScience.png

Binary files differ

 docs_cn/images/dingding.jpg

Binary files differ

 docs_cn/images/funasr_logo.jpg

Binary files differ

 docs_cn/images/wechat.png

Binary files differ

 docs_cn/index.rst

File was deleted

 docs_cn/installation.md

File was deleted

 docs_cn/make.bat

File was deleted

 docs_cn/modelscope_models.md

File was deleted

 docs_cn/modelscope_usages.md

File was deleted

 docs_cn/papers.md

File was deleted

 funasr/runtime/python/benchmark_libtorch.md

@@ -1,27 +1,32 @@
# Benchmark 
# CPU Benchmark (Libtorch)

## Configuration
### Data set:
Aishell1 [test set](https://www.openslr.org/33/) , the total audio duration is 36108.919 seconds.

### Tools
- Install ModelScope and FunASR

#### Install Requirements
Install ModelScope and FunASR
    ```shell
    pip install "modelscope[audio_asr]" --upgrade -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html
pip install -U modelscope funasr
# For the users in China, you could install with the command:
#pip install -U funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple
```

Install requirements
```shell
    git clone https://github.com/alibaba-damo-academy/FunASR.git && cd FunASR
    pip install --editable ./
    cd funasr/runtime/python/utils
    pip install -r requirements.txt
    ```

- recipe
#### Recipe

    set the model, data path and output_dir

    ```shell
    nohup bash test_rtf.sh &> log.txt &
    ```



## [Paraformer-large](https://www.modelscope.cn/models/damo/speech_paraformer-large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/summary) 

 funasr/runtime/python/benchmark_onnx.md

@@ -1,20 +1,26 @@
# Benchmark 
# CPU Benchmark (ONNX)

## Configuration
### Data set:
Aishell1 [test set](https://www.openslr.org/33/) , the total audio duration is 36108.919 seconds.

### Tools
- Install ModelScope and FunASR

#### Install Requirements
Install ModelScope and FunASR
    ```shell
    pip install "modelscope[audio_asr]" --upgrade -f https://modelscope.oss-cn-beijing.aliyuncs.com/releases/repo.html
pip install -U modelscope funasr
# For the users in China, you could install with the command:
#pip install -U funasr -i https://mirror.sjtu.edu.cn/pypi/web/simple
```

Install requirements
```shell
    git clone https://github.com/alibaba-damo-academy/FunASR.git && cd FunASR
    pip install --editable ./
    cd funasr/runtime/python/utils
    pip install -r requirements.txt
    ```

- recipe
#### Recipe

    set the model, data path and output_dir