icefall/docker/index.html

162 lines
8.3 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>Docker &mdash; icefall 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<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="Introduction" href="intro.html" />
<link rel="prev" title="Installation" href="../installation/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="../index.html" 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 class="current">
<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 current"><a class="current reference internal" href="#">Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#view-available-tags">View available tags</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#download-a-docker-image-cuda">Download a docker image (CUDA)</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#download-a-docker-image-cpu">Download a docker image (CPU)</a></li>
<li class="toctree-l2"><a class="reference internal" href="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="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="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></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="../index.html">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="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Docker</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/k2-fsa/icefall/blob/master/docs/source/docker/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="docker">
<span id="icefall-docker"></span><h1>Docker<a class="headerlink" href="#docker" title="Permalink to this heading"></a></h1>
<p>This section describes how to use pre-built docker images to run <a class="reference external" href="https://github.com/k2-fsa/icefall">icefall</a>.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>If you only have CPUs available, you can still use the pre-built docker
images.</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#view-available-tags">View available tags</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#cuda-enabled-docker-images">CUDA-enabled docker images</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#cpu-only-docker-images">CPU-only docker images</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#download-a-docker-image-cuda">Download a docker image (CUDA)</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#download-a-docker-image-cpu">Download a docker image (CPU)</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#run-a-docker-image-with-gpu">Run a docker image with GPU</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#run-a-docker-image-with-cpu">Run a docker image with CPU</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#run-yesno-within-a-docker-container">Run yesno within a docker container</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#update-the-code">Update the code</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#data-preparation">Data preparation</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#training">Training</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#decoding">Decoding</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../installation/index.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; 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>