mirror of
https://github.com/k2-fsa/icefall.git
synced 2025-08-08 09:32:20 +00:00
237 lines
14 KiB
HTML
237 lines
14 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Icefall — icefall 0.1 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
|
||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||
|
||
|
||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=e031e9a9"></script>
|
||
<script src="_static/doctools.js?v=888ff710"></script>
|
||
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Icefall for dummies tutorial" href="for-dummies/index.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="#" class="icon icon-home">
|
||
icefall
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="for-dummies/index.html">Icefall for dummies tutorial</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker/index.html">Docker</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faqs.html">Frequently Asked Questions (FAQs)</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="model-export/index.html">Model export</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="fst-based-forced-alignment/index.html">FST-based forced alignment</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="recipes/index.html">Recipes</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="huggingface/index.html">Huggingface</a></li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="decoding-with-langugage-models/index.html">Decoding with language models</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="#">icefall</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Icefall</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="https://github.com/k2-fsa/icefall/blob/master/docs/source/index.rst" class="fa fa-github"> Edit on GitHub</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="icefall">
|
||
<h1>Icefall<a class="headerlink" href="#icefall" title="Permalink to this heading"></a></h1>
|
||
<a class="reference external image-reference" href="https://github.com/k2-fsa/icefall"><img alt="icefall logo" class="align-center" src="_images/logo.png" style="width: 168px;" /></a>
|
||
<p>Documentation for <a class="reference external" href="https://github.com/k2-fsa/icefall">icefall</a>, containing
|
||
speech recognition recipes using <a class="reference external" href="https://github.com/k2-fsa/k2">k2</a>.</p>
|
||
<div class="toctree-wrapper compound">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="for-dummies/index.html">Icefall for dummies tutorial</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="for-dummies/environment-setup.html">Environment setup</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="for-dummies/data-preparation.html">Data Preparation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="for-dummies/training.html">Training</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="for-dummies/decoding.html">Decoding</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="for-dummies/model-export.html">Model Export</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#install-cuda-toolkit-and-cudnn">(0) Install CUDA toolkit and cuDNN</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#install-torch-and-torchaudio">(1) Install torch and torchaudio</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#install-k2">(2) Install k2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#install-lhotse">(3) Install lhotse</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#download-icefall">(4) Download icefall</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#installation-example">Installation example</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#test-your-installation">Test Your Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="installation/index.html#youtube-video">YouTube Video</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="docker/index.html">Docker</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html">Introduction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html#view-available-tags">View available tags</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html#download-a-docker-image-cuda">Download a docker image (CUDA)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html#download-a-docker-image-cpu">Download a docker image (CPU)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html#run-a-docker-image-with-gpu">Run a docker image with GPU</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html#run-a-docker-image-with-cpu">Run a docker image with CPU</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="docker/intro.html#run-yesno-within-a-docker-container">Run yesno within a docker container</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="faqs.html">Frequently Asked Questions (FAQs)</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="faqs.html#oserror-libtorch-hip-so-cannot-open-shared-object-file-no-such-file-or-directory">OSError: libtorch_hip.so: cannot open shared object file: no such file or directory</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="faqs.html#attributeerror-module-distutils-has-no-attribute-version">AttributeError: module ‘distutils’ has no attribute ‘version’</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="faqs.html#importerror-libpython3-10-so-1-0-cannot-open-shared-object-file-no-such-file-or-directory">ImportError: libpython3.10.so.1.0: cannot open shared object file: No such file or directory</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="model-export/index.html">Model export</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="model-export/export-model-state-dict.html">Export model.state_dict()</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="model-export/export-with-torch-jit-trace.html">Export model with torch.jit.trace()</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="model-export/export-with-torch-jit-script.html">Export model with torch.jit.script()</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="model-export/export-onnx.html">Export to ONNX</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="model-export/export-ncnn.html">Export to ncnn</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="fst-based-forced-alignment/index.html">FST-based forced alignment</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="fst-based-forced-alignment/diff.html">Two approaches</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="fst-based-forced-alignment/kaldi-based.html">Kaldi-based forced alignment</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="fst-based-forced-alignment/k2-based.html">k2-based forced alignment</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="recipes/index.html">Recipes</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="recipes/Non-streaming-ASR/index.html">Non Streaming ASR</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Non-streaming-ASR/aishell/index.html">aishell</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Non-streaming-ASR/librispeech/index.html">LibriSpeech</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Non-streaming-ASR/timit/index.html">TIMIT</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Non-streaming-ASR/yesno/index.html">YesNo</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="recipes/Streaming-ASR/index.html">Streaming ASR</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Streaming-ASR/introduction.html">Introduction</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Streaming-ASR/librispeech/index.html">LibriSpeech</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="recipes/RNN-LM/index.html">RNN-LM</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/RNN-LM/librispeech/lm-training.html">Train an RNN language model</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="recipes/TTS/index.html">TTS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/TTS/ljspeech/vits.html">VITS-LJSpeech</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/TTS/vctk/vits.html">VITS-VCTK</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="recipes/Finetune/index.html">Fine-tune a pre-trained model</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Finetune/from_supervised/finetune_zipformer.html">Finetune from a supervised pre-trained Zipformer model</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="recipes/Finetune/adapter/finetune_adapter.html">Finetune from a pre-trained Zipformer model with adapters</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="contributing/index.html">Contributing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="contributing/doc.html">Contributing to Documentation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="contributing/code-style.html">Follow the code style</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="contributing/how-to-create-a-recipe.html">How to create a recipe</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="huggingface/index.html">Huggingface</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="huggingface/pretrained-models.html">Pre-trained models</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="huggingface/spaces.html">Huggingface spaces</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="decoding-with-langugage-models/index.html">Decoding with language models</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="decoding-with-langugage-models/shallow-fusion.html">Shallow fusion for Transducer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="decoding-with-langugage-models/LODR.html">LODR for RNN Transducer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="decoding-with-langugage-models/rescoring.html">LM rescoring for Transducer</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="for-dummies/index.html" class="btn btn-neutral float-right" title="Icefall for dummies tutorial" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2021, icefall development team.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |