mirrors/icefall
1
0
Fork 0
mirror of https://github.com/k2-fsa/icefall.git synced 2025-08-08 09:32:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix doc URLs (#1660)

Browse Source
This commit is contained in:
Fangjun Kuang 2024-06-21 11:10:14 +08:00 committed by GitHub
parent ff2bef9e50
commit 3059eb4511
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -16,12 +16,12 @@ Please refer to [document](https://k2-fsa.github.io/icefall/huggingface/spaces.h
# Installation
Please refer to [document](https://icefall.readthedocs.io/en/latest/installation/index.html)
Please refer to [document](https://k2-fsa.github.io/icefall/installation/index.html)
for installation.
# Recipes
Please refer to [document](https://icefall.readthedocs.io/en/latest/recipes/index.html)
Please refer to [document](https://k2-fsa.github.io/icefall/recipes/index.html)
for more details.
## ASR: Automatic Speech Recognition
@ -77,7 +77,7 @@ The [LibriSpeech][librispeech] recipe supports the most comprehensive set of mod
#### Whisper
- [OpenAi Whisper](https://arxiv.org/abs/2212.04356) (We support fine-tuning on AiShell-1.)
If you are willing to contribute to icefall, please refer to [contributing](https://icefall.readthedocs.io/en/latest/contributing/index.html) for more details.
If you are willing to contribute to icefall, please refer to [contributing](https://k2-fsa.github.io/icefall/contributing/index.html) for more details.
We would like to highlight the performance of some of the recipes here.
@ -343,7 +343,12 @@ We provide a Colab notebook to test the pre-trained model: [![Open In Colab](htt
Once you have trained a model in icefall, you may want to deploy it with C++ without Python dependencies.
Please refer to the [document](https://icefall.readthedocs.io/en/latest/recipes/Non-streaming-ASR/librispeech/conformer_ctc.html#deployment-with-c)
Please refer to
- https://k2-fsa.github.io/icefall/model-export/export-with-torch-jit-script.html
- https://k2-fsa.github.io/icefall/model-export/export-onnx.html
- https://k2-fsa.github.io/icefall/model-export/export-ncnn.html
for how to do this.
We also provide a Colab notebook, showing you how to run a torch scripted model in [k2][k2] with C++.

2
egs/aidatatang_200zh/ASR/README.md
View File

@ -6,7 +6,7 @@ The main repositories are list below, we will update the training and decoding s
k2: https://github.com/k2-fsa/k2
icefall: https://github.com/k2-fsa/icefall
lhotse: https://github.com/lhotse-speech/lhotse
* Install k2 and lhotse, k2 installation guide refers to https://k2.readthedocs.io/en/latest/installation/index.html, lhotse refers to https://lhotse.readthedocs.io/en/latest/getting-started.html#installation. I think the latest version would be ok. And please also install the requirements listed in icefall.
* Install k2 and lhotse, k2 installation guide refers to https://k2-fsa.github.io/k2/installation/index.html, lhotse refers to https://lhotse.readthedocs.io/en/latest/getting-started.html#installation. I think the latest version would be ok. And please also install the requirements listed in icefall.
* Clone icefall(https://github.com/k2-fsa/icefall) and check to the commit showed above.
```
git clone https://github.com/k2-fsa/icefall

2
egs/aishell/ASR/tdnn_lstm_ctc/README.md
View File

@ -1,4 +1,4 @@
Please visit
<https://icefall.readthedocs.io/en/latest/recipes/aishell/tdnn_lstm_ctc.html>
<https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/aishell/tdnn_lstm_ctc.html>
for how to run this recipe.

2
egs/librispeech/ASR/README.md
View File

@ -1,6 +1,6 @@
# Introduction
Please refer to <https://icefall.readthedocs.io/en/latest/recipes/Non-streaming-ASR/librispeech/index.html> for how to run models in this recipe.
Please refer to <https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/librispeech/index.html> for how to run models in this recipe.
[./RESULTS.md](./RESULTS.md) contains the latest results.

4
egs/librispeech/ASR/conformer_ctc/README.md
View File

@ -1,7 +1,7 @@
## Introduction
Please visit
<https://icefall.readthedocs.io/en/latest/recipes/librispeech/conformer_ctc.html>
<https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/librispeech/conformer_ctc.html>
for how to run this recipe.
## How to compute framewise alignment information
@ -9,7 +9,7 @@ for how to run this recipe.
### Step 1: Train a model
Please use `conformer_ctc/train.py` to train a model.
See <https://icefall.readthedocs.io/en/latest/recipes/librispeech/conformer_ctc.html>
See <https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/librispeech/conformer_ctc.html>
for how to do it.
### Step 2: Compute framewise alignment

2
egs/timit/ASR/README.md
View File

@ -1,3 +1,3 @@
Please refer to <https://icefall.readthedocs.io/en/latest/recipes/Non-streaming-ASR/timit/index.html>
Please refer to <https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/timit/index.html>
for how to run models in this recipe.

2
egs/yesno/ASR/README.md
View File

@ -10,5 +10,5 @@ get the following WER:
```
Please refer to
<https://icefall.readthedocs.io/en/latest/recipes/Non-streaming-ASR/yesno/index.html>
<https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/yesno/index.html>
for detailed instructions.

2
egs/yesno/ASR/tdnn/README.md
View File

@ -2,7 +2,7 @@
## How to run this recipe
You can find detailed instructions by visiting
<https://icefall.readthedocs.io/en/latest/recipes/yesno.html>
<https://k2-fsa.github.io/icefall/recipes/Non-streaming-ASR/yesno/index.html>
It describes how to run this recipe and how to use
a pre-trained model with `./pretrained.py`.