mirrors/icefall
1
0
Fork 0
mirror of https://github.com/k2-fsa/icefall.git synced 2025-08-09 01:52:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
icefall/model-export/export-with-torch-jit-script.html

186 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Export model with torch.jit.script() &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=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="Export to ONNX" href="export-onnx.html" />
<link rel="prev" title="Export model with torch.jit.trace()" href="export-with-torch-jit-trace.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"><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 current"><a class="reference internal" href="index.html">Model export</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="export-model-state-dict.html">Export model.state_dict()</a></li>
<li class="toctree-l2"><a class="reference internal" href="export-with-torch-jit-trace.html">Export model with torch.jit.trace()</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Export model with torch.jit.script()</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#when-to-use-it">When to use it</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-to-export">How to export</a></li>
<li class="toctree-l3"><a class="reference internal" href="#how-to-use-the-exported-model">How to use the exported model</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="export-onnx.html">Export to ONNX</a></li>
<li class="toctree-l2"><a class="reference internal" href="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></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"><a href="index.html">Model export</a></li>
<li class="breadcrumb-item active">Export model with torch.jit.script()</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/k2-fsa/icefall/blob/master/docs/source/model-export/export-with-torch-jit-script.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="export-model-with-torch-jit-script">
<span id="id1"></span><h1>Export model with torch.jit.script()<a class="headerlink" href="#export-model-with-torch-jit-script" title="Permalink to this heading"></a></h1>
<p>In this section, we describe how to export a model via
<code class="docutils literal notranslate"><span class="pre">torch.jit.script()</span></code>.</p>
<section id="when-to-use-it">
<h2>When to use it<a class="headerlink" href="#when-to-use-it" title="Permalink to this heading"></a></h2>
<p>If we want to use our trained model with torchscript,
we can use <code class="docutils literal notranslate"><span class="pre">torch.jit.script()</span></code>.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>See <a class="reference internal" href="export-with-torch-jit-trace.html#export-model-with-torch-jit-trace"><span class="std std-ref">Export model with torch.jit.trace()</span></a>
if you want to use <code class="docutils literal notranslate"><span class="pre">torch.jit.trace()</span></code>.</p>
</div>
</section>
<section id="how-to-export">
<h2>How to export<a class="headerlink" href="#how-to-export" title="Permalink to this heading"></a></h2>
<p>We use
<a class="reference external" href="https://github.com/k2-fsa/icefall/tree/master/egs/librispeech/ASR/pruned_transducer_stateless3">https://github.com/k2-fsa/icefall/tree/master/egs/librispeech/ASR/pruned_transducer_stateless3</a>
as an example in the following.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>egs/librispeech/ASR
<span class="nv">epoch</span><span class="o">=</span><span class="m">14</span>
<span class="nv">avg</span><span class="o">=</span><span class="m">1</span>
./pruned_transducer_stateless3/export.py<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--exp-dir<span class="w"> </span>./pruned_transducer_stateless3/exp<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--tokens<span class="w"> </span>data/lang_bpe_500/tokens.txt<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--epoch<span class="w"> </span><span class="nv">$epoch</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--avg<span class="w"> </span><span class="nv">$avg</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>--jit<span class="w"> </span><span class="m">1</span>
</pre></div>
</div>
<p>It will generate a file <code class="docutils literal notranslate"><span class="pre">cpu_jit.pt</span></code> in <code class="docutils literal notranslate"><span class="pre">pruned_transducer_stateless3/exp</span></code>.</p>
<div class="admonition caution">
<p class="admonition-title">Caution</p>
<p>Don’t be confused by <code class="docutils literal notranslate"><span class="pre">cpu</span></code> in <code class="docutils literal notranslate"><span class="pre">cpu_jit.pt</span></code>. We move all parameters
to CPU before saving it into a <code class="docutils literal notranslate"><span class="pre">pt</span></code> file; that’s why we use <code class="docutils literal notranslate"><span class="pre">cpu</span></code>
in the filename.</p>
</div>
</section>
<section id="how-to-use-the-exported-model">
<h2>How to use the exported model<a class="headerlink" href="#how-to-use-the-exported-model" title="Permalink to this heading"></a></h2>
<p>Please refer to the following pages for usage:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://k2-fsa.github.io/sherpa/python/streaming_asr/emformer/index.html">https://k2-fsa.github.io/sherpa/python/streaming_asr/emformer/index.html</a></p></li>
<li><p><a class="reference external" href="https://k2-fsa.github.io/sherpa/python/streaming_asr/conv_emformer/index.html">https://k2-fsa.github.io/sherpa/python/streaming_asr/conv_emformer/index.html</a></p></li>
<li><p><a class="reference external" href="https://k2-fsa.github.io/sherpa/python/streaming_asr/conformer/index.html">https://k2-fsa.github.io/sherpa/python/streaming_asr/conformer/index.html</a></p></li>
<li><p><a class="reference external" href="https://k2-fsa.github.io/sherpa/python/offline_asr/conformer/index.html">https://k2-fsa.github.io/sherpa/python/offline_asr/conformer/index.html</a></p></li>
<li><p><a class="reference external" href="https://k2-fsa.github.io/sherpa/cpp/offline_asr/gigaspeech.html">https://k2-fsa.github.io/sherpa/cpp/offline_asr/gigaspeech.html</a></p></li>
<li><p><a class="reference external" href="https://k2-fsa.github.io/sherpa/cpp/offline_asr/wenetspeech.html">https://k2-fsa.github.io/sherpa/cpp/offline_asr/wenetspeech.html</a></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="export-with-torch-jit-trace.html" class="btn btn-neutral float-left" title="Export model with torch.jit.trace()" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="export-onnx.html" class="btn btn-neutral float-right" title="Export to ONNX" 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>
Reference in New Issue View Git Blame Copy Permalink