更新文档

This commit is contained in:
xujiao 2025-07-08 10:42:26 +08:00
parent 8da8917e3b
commit 5cd1038624
68 changed files with 9568 additions and 0 deletions

4
docs/html/.buildinfo Normal file
View File

@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: c457bdf30d2a3c56394067910656aaac
tags: 645f666f9bcd5a90fca523b33c5a78b7

View File

@ -0,0 +1,166 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>config &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>config 源代码</h1><div class="highlight"><pre>
<span></span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">check_path</span><span class="p">,</span> <span class="n">AttributeCopier</span><span class="p">,</span> <span class="n">create_cls</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
<div class="viewcode-block" id="Config">
<a class="viewcode-back" href="../config.html#config.Config">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Config</span><span class="p">(</span><span class="n">AttributeCopier</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;从实例化的 Netrans 中解析模型参数,并基于pnnacc 生成配置文件模板</span>
<span class="sd"> Args:</span>
<span class="sd"> Netrans (class): 实例化的Netrans类,包含 模型信息 和 Netrans 信息</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;从实例化的 Netrans 中解析模型参数</span>
<span class="sd"> Args:</span>
<span class="sd"> source_obj (class): 实例化的Netrans类,包含 模型信息 和 Netrans 信息</span>
<span class="sd"> </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<span class="nd">@check_path</span>
<span class="k">def</span><span class="w"> </span><span class="nf">inputmeta_gen</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;生成配置文件模板</span>
<span class="sd"> Return:</span>
<span class="sd"> None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans</span>
<span class="n">network_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span>
<span class="c1"># 进入网络名称指定的目录</span>
<span class="c1"># os.chdir(network_name)</span>
<span class="c1"># check_env(network_name)</span>
<span class="c1"># 执行 pegasus 命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2"> generate inputmeta --model </span><span class="si">{</span><span class="n">network_name</span><span class="si">}</span><span class="s2">.json --separated-database&quot;</span>
<span class="k">try</span> <span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">except</span> <span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;config failed&#39;</span><span class="p">)</span></div>
<span class="c1"># os.chdir(&quot;..&quot;)</span>
<span class="c1"># def main():</span>
<span class="c1"># # 检查命令行参数数量是否正确</span>
<span class="c1"># if len(sys.argv) != 2:</span>
<span class="c1"># print(&quot;Enter a network name!&quot;)</span>
<span class="c1"># sys.exit(2)</span>
<span class="c1"># # 检查提供的目录是否存在</span>
<span class="c1"># network_name = sys.argv[1]</span>
<span class="c1"># # 构建 netrans 可执行文件的路径</span>
<span class="c1"># netrans_path =os.getenv(&#39;NETRANS_PATH&#39;)</span>
<span class="c1"># cla = create_cls(netrans_path, network_name)</span>
<span class="c1"># func = InputmetaGen(cla)</span>
<span class="c1"># func.inputmeta_gen()</span>
<span class="c1"># if __name__ == &#39;__main__&#39;:</span>
<span class="c1"># main()</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,173 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>example &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>example 源代码</h1><div class="highlight"><pre>
<span></span><span class="ch">#!/usr/bin/env python3</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">argparse</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">netrans</span><span class="w"> </span><span class="kn">import</span> <span class="n">Netrans</span>
<div class="viewcode-block" id="main">
<a class="viewcode-back" href="../example.html#example.main">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
<span class="c1"># 创建参数解析器</span>
<span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span>
<span class="n">description</span><span class="o">=</span><span class="s1">&#39;神经网络模型转换工具&#39;</span><span class="p">,</span>
<span class="n">formatter_class</span><span class="o">=</span><span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentDefaultsHelpFormatter</span> <span class="c1"># 自动显示默认值</span>
<span class="p">)</span>
<span class="c1"># 必填位置参数</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;model_path&#39;</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;输入模型路径(必须参数)&#39;</span>
<span class="p">)</span>
<span class="c1"># 可选参数组</span>
<span class="n">quant_group</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_argument_group</span><span class="p">(</span><span class="s1">&#39;量化参数&#39;</span><span class="p">)</span>
<span class="n">quant_group</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;-q&#39;</span><span class="p">,</span> <span class="s1">&#39;--quantize_type&#39;</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">str</span><span class="p">,</span>
<span class="n">choices</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;uint8&#39;</span><span class="p">,</span> <span class="s1">&#39;int8&#39;</span><span class="p">,</span> <span class="s1">&#39;int16&#39;</span><span class="p">,</span> <span class="s1">&#39;float&#39;</span><span class="p">],</span>
<span class="n">default</span><span class="o">=</span><span class="s1">&#39;uint8&#39;</span><span class="p">,</span>
<span class="n">metavar</span><span class="o">=</span><span class="s1">&#39;TYPE&#39;</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;量化类型(可选值:</span><span class="si">%(choices)s</span><span class="s1">&#39;</span>
<span class="p">)</span>
<span class="n">quant_group</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;-m&#39;</span><span class="p">,</span> <span class="s1">&#39;--mean&#39;</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span>
<span class="n">default</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;归一化均值(默认:</span><span class="si">%(default)s</span><span class="s1">&#39;</span>
<span class="p">)</span>
<span class="n">quant_group</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;-s&#39;</span><span class="p">,</span> <span class="s1">&#39;--scale&#39;</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">float</span><span class="p">,</span>
<span class="n">default</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;量化缩放系数(默认:</span><span class="si">%(default)s</span><span class="s1">&#39;</span>
<span class="p">)</span>
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span>
<span class="s1">&#39;-p&#39;</span><span class="p">,</span> <span class="s1">&#39;--profile&#39;</span><span class="p">,</span>
<span class="n">action</span><span class="o">=</span><span class="s1">&#39;store_true&#39;</span><span class="p">,</span> <span class="c1"># 设置为True当参数存在时</span>
<span class="n">help</span><span class="o">=</span><span class="s1">&#39;启用性能分析模式(默认:</span><span class="si">%(default)s</span><span class="s1">&#39;</span>
<span class="p">)</span>
<span class="c1"># 解析参数</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
<span class="c1"># 执行模型转换</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">model</span> <span class="o">=</span> <span class="n">Netrans</span><span class="p">(</span><span class="n">model_path</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">model_path</span><span class="p">)</span>
<span class="n">model</span><span class="o">.</span><span class="n">model2nbg</span><span class="p">(</span>
<span class="n">quantize_type</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">quantize_type</span><span class="p">,</span>
<span class="n">mean</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">mean</span><span class="p">,</span>
<span class="n">scale</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">scale</span><span class="p">,</span>
<span class="n">profile</span><span class="o">=</span><span class="n">args</span><span class="o">.</span><span class="n">profile</span>
<span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;模型 </span><span class="si">{</span><span class="n">args</span><span class="o">.</span><span class="n">model_path</span><span class="si">}</span><span class="s2"> 转换成功&quot;</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">FileNotFoundError</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;错误:模型文件 </span><span class="si">{</span><span class="n">args</span><span class="o">.</span><span class="n">model_path</span><span class="si">}</span><span class="s2"> 不存在&quot;</span><span class="p">)</span>
<span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span></div>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,285 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>export &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>export 源代码</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">shutil</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">check_path</span><span class="p">,</span> <span class="n">AttributeCopier</span><span class="p">,</span> <span class="n">create_cls</span>
<span class="c1"># 检查 NETRANS_PATH 环境变量是否设置</span>
<span class="c1"># 定义数据集文件路径</span>
<span class="n">dataset</span> <span class="o">=</span> <span class="s1">&#39;dataset.txt&#39;</span>
<div class="viewcode-block" id="Export">
<a class="viewcode-back" href="../export.html#export.Export">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Export</span><span class="p">(</span><span class="n">AttributeCopier</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;从实例化的 Netrans 中解析模型参数,并基于 pnnacc 导出模型ngb文件</span>
<span class="sd"> Args:</span>
<span class="sd"> Netrans (class): 实例化的Netrans类,包含 模型信息 和 Netrans 信息</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;从实例化的 Netrans 中解析模型参数</span>
<span class="sd"> Args:</span>
<span class="sd"> source_obj (class): 实例化的Netrans类,包含 模型信息 和 Netrans 信息</span>
<span class="sd"> </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<span class="nd">@check_path</span>
<span class="k">def</span><span class="w"> </span><span class="nf">export_network</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;基于 pnnacc 导出模型</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">netrans</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans</span>
<span class="n">quantized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">quantize_type</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans_path</span>
<span class="n">ovxgenerator</span> <span class="o">=</span> <span class="n">netrans</span> <span class="o">+</span> <span class="s2">&quot; export ovxlib&quot;</span>
<span class="c1"># 进入模型目录</span>
<span class="c1"># os.chdir(name)</span>
<span class="c1"># 根据量化类型设置参数</span>
<span class="k">if</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;float&#39;</span><span class="p">:</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;float&#39;</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;none_quantized&#39;</span>
<span class="n">generate_path</span> <span class="o">=</span> <span class="s1">&#39;./wksp/none_quantized&#39;</span>
<span class="k">elif</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;uint8&#39;</span><span class="p">:</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;quantized&#39;</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;asymmetric_affine&#39;</span>
<span class="n">generate_path</span> <span class="o">=</span> <span class="s1">&#39;./wksp/asymmetric_affine&#39;</span>
<span class="k">elif</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;int8&#39;</span><span class="p">:</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;quantized&#39;</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;dynamic_fixed_point-8&#39;</span>
<span class="n">generate_path</span> <span class="o">=</span> <span class="s1">&#39;./wksp/dynamic_fixed_point-8&#39;</span>
<span class="k">elif</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;int16&#39;</span><span class="p">:</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;quantized&#39;</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;dynamic_fixed_point-16&#39;</span>
<span class="n">generate_path</span> <span class="o">=</span> <span class="s1">&#39;./wksp/dynamic_fixed_point-16&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== wrong quantization_type ! ( float / uint8 / int8 / int16 )===========&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># 创建输出目录</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">generate_path</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># 构建命令</span>
<span class="k">if</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;float&#39;</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">ovxgenerator</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --model-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --dtype </span><span class="si">{</span><span class="n">type_</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --pack-nbg-viplite </span><span class="se">\</span>
<span class="s2"> --optimize &#39;VIP8000NANOQI_PLUS_PID0XB1&#39;</span><span class="se">\</span>
<span class="s2"> --target-ide-project &#39;linux64&#39; </span><span class="se">\</span>
<span class="s2"> --viv-sdk </span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2">/pnna_sdk </span><span class="se">\</span>
<span class="s2"> --output-path </span><span class="si">{</span><span class="n">generate_path</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize&quot;</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m Can not find </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_postprocess_file.yml&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">ovxgenerator</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --model-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --dtype </span><span class="si">{</span><span class="n">type_</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --pack-nbg-viplite </span><span class="se">\</span>
<span class="s2"> --optimize &#39;VIP8000NANOQI_PLUS_PID0XB1&#39;</span><span class="se">\</span>
<span class="s2"> --viv-sdk </span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2">/pnna_sdk </span><span class="se">\</span>
<span class="s2"> --model-quantize </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize </span><span class="se">\</span>
<span class="s2"> --with-input-meta </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_inputmeta.yml </span><span class="se">\</span>
<span class="s2"> --target-ide-project &#39;linux64&#39; </span><span class="se">\</span>
<span class="s2"> --output-path </span><span class="si">{</span><span class="n">generate_path</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">ovxgenerator</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --model-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --dtype </span><span class="si">{</span><span class="n">type_</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --pack-nbg-viplite </span><span class="se">\</span>
<span class="s2"> --optimize &#39;VIP8000NANOQI_PLUS_PID0XB1&#39;</span><span class="se">\</span>
<span class="s2"> --viv-sdk </span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2">/pnna_sdk </span><span class="se">\</span>
<span class="s2"> --model-quantize </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize </span><span class="se">\</span>
<span class="s2"> --with-input-meta </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_inputmeta.yml </span><span class="se">\</span>
<span class="s2"> --target-ide-project &#39;linux64&#39; </span><span class="se">\</span>
<span class="s2"> --postprocess-file </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_postprocess_file.yml </span><span class="se">\</span>
<span class="s2"> --output-path </span><span class="si">{</span><span class="n">generate_path</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># 检查执行结果</span>
<span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m SUCCESS </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m ERROR ! </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">stderr</span><span class="si">}</span><span class="s2"> </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="c1"># temp=&#39;wksp/temp&#39;</span>
<span class="c1"># os.makedirs(temp, exist_ok=True)</span>
<span class="n">source_dir</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">generate_path</span><span class="si">}</span><span class="s2">_nbg_viplite&quot;</span>
<span class="n">target_dir</span> <span class="o">=</span> <span class="n">generate_path</span>
<span class="n">src_ngb</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">source_dir</span><span class="si">}</span><span class="s2">/network_binary.nb&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">profile</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># 如果目标路径已存在,先删除(确保移动操作能成功)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">target_dir</span><span class="p">):</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">target_dir</span><span class="p">)</span>
<span class="c1"># 移动整个目录到目标位置</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">source_dir</span><span class="p">,</span> <span class="n">target_dir</span><span class="p">)</span>
<span class="c1"># print(f&quot;Successfully moved directory {source_dir} to {target_dir}&quot;)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># 非零退出码表示错误</span>
<span class="c1"># print(f&quot;Error moving directory: {e}&quot;)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># 仅复制network_binary.nb文件</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">generate_path</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">generate_path</span><span class="p">)</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="n">src_ngb</span><span class="p">,</span> <span class="n">generate_path</span><span class="p">)</span>
<span class="c1"># print(f&quot;Successfully copied {src_ngb} to {generate_path}&quot;)</span>
<span class="k">except</span> <span class="ne">FileNotFoundError</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error: </span><span class="si">{</span><span class="n">src_ngb</span><span class="si">}</span><span class="s2"> is not found&quot;</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error occurred: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># 清理源目录</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">source_dir</span><span class="p">)</span>
<span class="c1"># print(f&quot;Removed source directory {source_dir}&quot;)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="c1"># print(f&quot;Error removing directory: {e}&quot;)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># 非零退出码表示错误</span></div>
<div class="viewcode-block" id="main">
<a class="viewcode-back" href="../export.html#export.main">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
<span class="c1"># 检查命令行参数数量</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">3</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Input a network name and quantized type ( float / uint8 / int8 / int16 )&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># 检查网络目录是否存在</span>
<span class="n">network_name</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># check_env(network_name)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">network_name</span><span class="p">)):</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Directory </span><span class="si">{</span><span class="n">network_name</span><span class="si">}</span><span class="s2"> does not exist !&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;NETRANS_PATH&#39;</span><span class="p">]</span>
<span class="c1"># netrans = os.path.join(os.environ[&#39;NETRANS_PATH&#39;], &#39;pnnacc&#39;)</span>
<span class="c1"># 调用导出函数ss</span>
<span class="n">cla</span> <span class="o">=</span> <span class="n">create_cls</span><span class="p">(</span><span class="n">netrans_path</span><span class="p">,</span> <span class="n">network_name</span><span class="p">,</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
<span class="n">func</span> <span class="o">=</span> <span class="n">Export</span><span class="p">(</span><span class="n">cla</span><span class="p">)</span>
<span class="n">func</span><span class="o">.</span><span class="n">export_network</span><span class="p">()</span></div>
<span class="c1"># export_network(netrans, network_name, sys.argv[2])</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,443 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>import_model &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>import_model 源代码</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">check_path</span><span class="p">,</span> <span class="n">AttributeCopier</span><span class="p">,</span> <span class="n">create_cls</span>
<div class="viewcode-block" id="check_status">
<a class="viewcode-back" href="../import_model.html#import_model.check_status">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">check_status</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;解析命令执行情况</span>
<span class="sd"> Args:</span>
<span class="sd"> result (return of subprocrss.run): subprocess.run的返回值</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m LOAD MODEL SUCCESS </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m ERROR: </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">stderr</span><span class="si">}</span><span class="s2"> </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="import_caffe_network">
<a class="viewcode-back" href="../import_model.html#import_model.import_caffe_network">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_caffe_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;导入 caffe 模型</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): 模型名字</span>
<span class="sd"> netrans_path (str): 模型路径</span>
<span class="sd"> Returns:</span>
<span class="sd"> cmd (str): 生成的pnnacc 命令行, 被subprocesses执行</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># 定义转换工具的路径</span>
<span class="n">convert_caffe</span> <span class="o">=</span><span class="n">netrans_path</span> <span class="o">+</span> <span class="s2">&quot; import caffe&quot;</span>
<span class="c1"># 定义模型文件路径</span>
<span class="n">model_json_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json&quot;</span>
<span class="n">model_data_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data&quot;</span>
<span class="n">model_prototxt_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.prototxt&quot;</span>
<span class="n">model_caffemodel_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.caffemodel&quot;</span>
<span class="c1"># 打印转换信息</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;=========== Converting </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> Caffe model ===========&quot;</span><span class="p">)</span>
<span class="c1"># 构建转换命令</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">model_caffemodel_path</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_caffe</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">model_prototxt_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --weights </span><span class="si">{</span><span class="n">model_caffemodel_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">model_json_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">model_data_path</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== fake Caffe model data file =============&quot;</span><span class="p">)</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_caffe</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">model_prototxt_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">model_json_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">model_data_path</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="c1"># 执行转换命令</span>
<span class="c1"># print(cmd)</span>
<span class="c1"># os.system(cmd)</span>
<span class="k">return</span> <span class="n">cmd</span></div>
<div class="viewcode-block" id="import_tensorflow_network">
<a class="viewcode-back" href="../import_model.html#import_model.import_tensorflow_network">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_tensorflow_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;导入 tensorflow 模型</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): 模型名字</span>
<span class="sd"> netrans_path (str): 模型路径</span>
<span class="sd"> Returns:</span>
<span class="sd"> cmd (str): 生成的pnnacc 命令行, 被subprocesses执行</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># 定义转换工具的命令</span>
<span class="n">convertf_cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2"> import tensorflow&quot;</span>
<span class="c1"># 打印转换信息</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;=========== Converting </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> Tensorflow model ===========&quot;</span><span class="p">)</span>
<span class="c1"># 读取 inputs_outputs.txt 文件中的参数</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;inputs_outputs.txt&#39;</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="n">inputs_outputs_params</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="c1"># 构建转换命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convertf_cmd</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.pb </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> </span><span class="si">{</span><span class="n">inputs_outputs_params</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="c1"># 执行转换命令</span>
<span class="c1"># print(cmd)</span>
<span class="k">return</span> <span class="n">cmd</span></div>
<span class="c1"># result = subprocess.run(cmd, shell=True, capture_output=True, text=True)</span>
<span class="c1"># 检查执行结果</span>
<span class="c1"># check_status(result)</span>
<div class="viewcode-block" id="import_onnx_network">
<a class="viewcode-back" href="../import_model.html#import_model.import_onnx_network">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_onnx_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;导入 onnx 模型</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): 模型名字</span>
<span class="sd"> netrans_path (str): 模型路径</span>
<span class="sd"> Returns:</span>
<span class="sd"> cmd (str): 生成的pnnacc 命令行, 被subprocesses执行</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># 定义转换工具的命令</span>
<span class="n">convert_onnx_cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2"> import onnx&quot;</span>
<span class="c1"># 打印转换信息</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;=========== Converting </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> ONNX model ===========&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_outputs.txt&quot;</span><span class="p">):</span>
<span class="n">output_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">(),</span> <span class="n">name</span><span class="o">+</span><span class="s2">&quot;_outputs.txt&quot;</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">output_path</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">outputs</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">file</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_onnx_cmd</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.onnx </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --outputs &#39;</span><span class="si">{</span><span class="n">outputs</span><span class="si">}</span><span class="s2">&#39;&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># 构建转换命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_onnx_cmd</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.onnx </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data&quot;</span>
<span class="c1"># 执行转换命令</span>
<span class="c1"># print(cmd)</span>
<span class="k">return</span> <span class="n">cmd</span></div>
<span class="c1"># result = subprocess.run(cmd, shell=True, capture_output=True, text=True)</span>
<span class="c1"># 检查执行结果</span>
<span class="c1"># check_status(result)</span>
<span class="c1">####### TFLITE</span>
<div class="viewcode-block" id="import_tflite_network">
<a class="viewcode-back" href="../import_model.html#import_model.import_tflite_network">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_tflite_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;导入 tflite 模型</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): 模型名字</span>
<span class="sd"> netrans_path (str): 模型路径</span>
<span class="sd"> Returns:</span>
<span class="sd"> cmd (str): 生成的pnnacc 命令行, 被subprocesses执行</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># 定义转换工具的路径或命令 </span>
<span class="n">convert_tflite</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2"> import tflite&quot;</span>
<span class="c1"># 定义模型文件路径</span>
<span class="n">model_json_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json&quot;</span>
<span class="n">model_data_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data&quot;</span>
<span class="n">model_tflite_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.tflite&quot;</span>
<span class="c1"># 打印转换信息</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;=========== Converting </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> TFLite model ===========&quot;</span><span class="p">)</span>
<span class="c1"># 构建转换命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_tflite</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">model_tflite_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">model_json_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">model_data_path</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="c1"># 执行转换命令</span>
<span class="c1"># print(cmd)</span>
<span class="k">return</span> <span class="n">cmd</span></div>
<span class="c1"># result = subprocess.run(cmd, shell=True, capture_output=True, text=True)</span>
<span class="c1"># 检查执行结果</span>
<span class="c1"># check_status(result)</span>
<div class="viewcode-block" id="import_darknet_network">
<a class="viewcode-back" href="../import_model.html#import_model.import_darknet_network">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_darknet_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;导入 darknet 模型</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): 模型名字</span>
<span class="sd"> netrans_path (str): 模型路径</span>
<span class="sd"> Returns:</span>
<span class="sd"> cmd (str): 生成的pnnacc 命令行, 被subprocesses执行</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># 定义转换工具的命令</span>
<span class="n">convert_darknet_cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2"> import darknet&quot;</span>
<span class="c1"># 打印转换信息</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;=========== Converting </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> darknet model ===========&quot;</span><span class="p">)</span>
<span class="c1"># 构建转换命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_darknet_cmd</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.cfg </span><span class="se">\</span>
<span class="s2"> --weight </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.weights </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data&quot;</span>
<span class="c1"># 执行转换命令</span>
<span class="c1"># print(cmd)</span>
<span class="k">return</span> <span class="n">cmd</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># 检查执行结果</span>
<span class="n">check_status</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="import_pytorch_network">
<a class="viewcode-back" href="../import_model.html#import_model.import_pytorch_network">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_pytorch_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;导入 pytorch 模型</span>
<span class="sd"> Args:</span>
<span class="sd"> name (str): 模型名字</span>
<span class="sd"> netrans_path (str): 模型路径</span>
<span class="sd"> Returns:</span>
<span class="sd"> cmd (str): 生成的pnnacc 命令行, 被subprocesses执行</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># 定义转换工具的命令</span>
<span class="n">convert_pytorch_cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans_path</span><span class="si">}</span><span class="s2"> import pytorch&quot;</span>
<span class="c1"># 打印转换信息</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;=========== Converting </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> pytorch model ===========&quot;</span><span class="p">)</span>
<span class="c1"># 读取 input_size.txt 文件中的参数</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;input_size.txt&#39;</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">input_size_params</span> <span class="o">=</span> <span class="s1">&#39; &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">file</span><span class="o">.</span><span class="n">readlines</span><span class="p">())</span>
<span class="k">except</span> <span class="ne">FileNotFoundError</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Error: input_size.txt not found.&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># 构建转换命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">convert_pytorch_cmd</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.pt </span><span class="se">\</span>
<span class="s2"> --output-model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --output-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> </span><span class="si">{</span><span class="n">input_size_params</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="c1"># 执行转换命令</span>
<span class="c1"># print(cmd)</span>
<span class="k">return</span> <span class="n">cmd</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># 检查执行结果</span>
<span class="n">check_status</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
<span class="c1"># 使用示例</span>
<span class="c1"># import_tensorflow_network(&#39;model_name&#39;, &#39;/path/to/NETRANS_PATH&#39;)</span>
<div class="viewcode-block" id="ImportModel">
<a class="viewcode-back" href="../import_model.html#import_model.ImportModel">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">ImportModel</span><span class="p">(</span><span class="n">AttributeCopier</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;从实例化的 Netrans 中解析模型参数,并基于 pnnacc 导入模型</span>
<span class="sd"> Args:</span>
<span class="sd"> Netrans (class): 实例化的Netrans类,包含 模型信息 和 Netrans 信息</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;从实例化的 Netrans 中解析模型参数</span>
<span class="sd"> Args:</span>
<span class="sd"> source_obj (class): 实例化的Netrans类,包含 模型信息 和 Netrans 信息</span>
<span class="sd"> </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<span class="c1"># print(source_obj.__dict__)</span>
<span class="nd">@check_path</span>
<span class="k">def</span><span class="w"> </span><span class="nf">import_network</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;基于 pnnacc 导入模型</span>
<span class="sd"> Raises:</span>
<span class="sd"> FileExistsError: 如果不存在模型文件则会报错 FileExistsError</span>
<span class="sd"> RuntimeError: 如果执行导入失败则会报 RuntimeError</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span> <span class="ow">is</span> <span class="kc">True</span> <span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;begin load model&quot;</span><span class="p">)</span>
<span class="c1"># print(self.model_path)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">())</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">model_name</span><span class="si">}</span><span class="s2">.weights&quot;</span><span class="p">)</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.prototxt&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">import_caffe_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.pb&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">import_tensorflow_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.onnx&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">import_onnx_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.tflite&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">import_tflite_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.weights&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">import_darknet_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.pt&quot;</span><span class="p">):</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">import_pytorch_network</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="k">raise</span> <span class="ne">FileExistsError</span><span class="p">(</span><span class="s2">&quot;Can not find suitable model files&quot;</span><span class="p">)</span>
<span class="k">try</span> <span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">except</span> <span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;load model failed&quot;</span><span class="p">)</span>
<span class="c1"># 检查执行结果</span>
<span class="n">check_status</span><span class="p">(</span><span class="n">result</span><span class="p">)</span></div>
<span class="c1"># os.chdir(&quot;..&quot;) </span>
<span class="c1"># def main():</span>
<span class="c1"># if len(sys.argv) != 2 :</span>
<span class="c1"># print(&quot;Input a network&quot;)</span>
<span class="c1"># sys.exit(-1)</span>
<span class="c1"># network_name = sys.argv[1]</span>
<span class="c1"># # check_env(network_name)</span>
<span class="c1"># netrans_path = os.environ[&#39;NETRANS_PATH&#39;]</span>
<span class="c1"># # netrans = os.path.join(netrans_path, &#39;pnnacc&#39;)</span>
<span class="c1"># clas = create_cls(netrans_path, network_name,verbose=False)</span>
<span class="c1"># func = ImportModel(clas)</span>
<span class="c1"># func.import_network()</span>
<span class="c1"># if __name__ == &quot;__main__&quot;:</span>
<span class="c1"># main() </span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,109 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>概览:模块代码 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>代码可用的所有模块</h1>
<ul><li><a href="config.html">config</a></li>
<li><a href="example.html">example</a></li>
<li><a href="export.html">export</a></li>
<li><a href="import_model.html">import_model</a></li>
<li><a href="infer.html">infer</a></li>
<li><a href="quantize.html">quantize</a></li>
<li><a href="quantize_hb.html">quantize_hb</a></li>
<li><a href="utils.html">utils</a></li>
</ul>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,204 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>infer &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>infer 源代码</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">subprocess</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">check_path</span><span class="p">,</span> <span class="n">AttributeCopier</span><span class="p">,</span> <span class="n">create_cls</span>
<div class="viewcode-block" id="Infer">
<a class="viewcode-back" href="../infer.html#infer.Infer">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Infer</span><span class="p">(</span><span class="n">AttributeCopier</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<span class="nd">@check_path</span>
<span class="k">def</span><span class="w"> </span><span class="nf">inference_network</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">netrans</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans</span>
<span class="n">quantized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">quantize_type</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span>
<span class="c1"># print(self.__dict__)</span>
<span class="n">netrans</span> <span class="o">+=</span> <span class="s2">&quot; inference&quot;</span>
<span class="c1"># 进入模型目录</span>
<span class="c1"># 定义类型和量化类型</span>
<span class="k">if</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;float&#39;</span><span class="p">:</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;float32&#39;</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;float32&#39;</span>
<span class="k">elif</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;uint8&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;asymmetric_affine&#39;</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;quantized&#39;</span>
<span class="k">elif</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;int8&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;dynamic_fixed_point-8&#39;</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;quantized&#39;</span>
<span class="k">elif</span> <span class="n">quantized</span> <span class="o">==</span> <span class="s1">&#39;int16&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s1">&#39;dynamic_fixed_point-16&#39;</span>
<span class="n">type_</span> <span class="o">=</span> <span class="s1">&#39;quantized&#39;</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== wrong quantization_type ! ( float / uint8 / int8 / int16 )===========&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># 构建推理命令</span>
<span class="n">inf_path</span> <span class="o">=</span> <span class="s1">&#39;./inf&#39;</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --dtype </span><span class="si">{</span><span class="n">type_</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --batch-size 1 </span><span class="se">\</span>
<span class="s2"> --model-quantize </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --model-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --output-dir </span><span class="si">{</span><span class="n">inf_path</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --with-input-meta </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_inputmeta.yml </span><span class="se">\</span>
<span class="s2"> --device CPU&quot;</span>
<span class="c1"># 执行推理命令</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">capture_output</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># 检查执行结果</span>
<span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[32m SUCCESS </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m ERROR: </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">stderr</span><span class="si">}</span><span class="s2"> </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span></div>
<span class="c1"># 返回原始目录</span>
<div class="viewcode-block" id="main">
<a class="viewcode-back" href="../infer.html#infer.main">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
<span class="c1"># 检查命令行参数数量</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">3</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Input a network name and quantized type ( float / uint8 / int8 / int16 )&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># 检查网络目录是否存在</span>
<span class="n">network_name</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">network_name</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Directory </span><span class="si">{</span><span class="n">network_name</span><span class="si">}</span><span class="s2"> does not exist !&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">2</span><span class="p">)</span>
<span class="c1"># print(&quot;here&quot;)</span>
<span class="c1"># 定义 netrans 路径</span>
<span class="c1"># netrans = os.path.join(os.environ[&#39;NETRANS_PATH&#39;], &#39;pnnacc&#39;)</span>
<span class="n">network_name</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># check_env(network_name)</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;NETRANS_PATH&#39;</span><span class="p">]</span>
<span class="c1"># netrans = os.path.join(netrans_path, &#39;pnnacc&#39;)</span>
<span class="n">quantize_type</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
<span class="n">cla</span> <span class="o">=</span> <span class="n">create_cls</span><span class="p">(</span><span class="n">netrans_path</span><span class="p">,</span> <span class="n">network_name</span><span class="p">,</span><span class="n">quantize_type</span><span class="p">,</span><span class="kc">False</span><span class="p">)</span>
<span class="c1"># 调用量化函数</span>
<span class="n">func</span> <span class="o">=</span> <span class="n">Infer</span><span class="p">(</span><span class="n">cla</span><span class="p">)</span>
<span class="n">func</span><span class="o">.</span><span class="n">inference_network</span><span class="p">()</span></div>
<span class="c1"># 定义数据集文件路径</span>
<span class="c1"># dataset_path = &#39;./dataset.txt&#39;</span>
<span class="c1"># 调用推理函数</span>
<span class="c1"># inference_network(network_name, sys.argv[2])</span>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s1">&#39;__main__&#39;</span><span class="p">:</span>
<span class="c1"># print(&quot;main&quot;)</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,211 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>quantize &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>quantize 源代码</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">check_path</span><span class="p">,</span> <span class="n">AttributeCopier</span><span class="p">,</span> <span class="n">create_cls</span>
<div class="viewcode-block" id="Quantize">
<a class="viewcode-back" href="../quantize.html#quantize.Quantize">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Quantize</span><span class="p">(</span><span class="n">AttributeCopier</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> 解析 Netrans 参数,基于 pnnacc 量化模型</span>
<span class="sd"> Args:</span>
<span class="sd"> cla (class): 实例化以后的 Netrans 类,需要解析里面包含的参数</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> 从 Netrans 类中获取模型信息</span>
<span class="sd"> Args:</span>
<span class="sd"> source_obj (class): 实例化以后的 Netrans 类,需要解析里面包含的参数</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<span class="nd">@check_path</span>
<span class="k">def</span><span class="w"> </span><span class="nf">quantize_network</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;基于 pnnacc 量化模型 </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">netrans</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans</span>
<span class="n">quantized_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">quantize_type</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span>
<span class="c1"># check_env(name)</span>
<span class="c1"># print(os.getcwd())</span>
<span class="n">netrans</span> <span class="o">+=</span> <span class="s2">&quot; quantize&quot;</span>
<span class="c1"># 根据量化类型设置量化参数</span>
<span class="k">if</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;float&#39;</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== do not need quantized===========&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;uint8&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s2">&quot;asymmetric_affine&quot;</span>
<span class="k">elif</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;int8&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s2">&quot;dynamic_fixed_point-8&quot;</span>
<span class="k">elif</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;int16&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s2">&quot;dynamic_fixed_point-16&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== wrong quantization_type ! ( uint8 / int8 / int16 )===========&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># 输出量化信息</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot; =======================================================================&quot;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; ==== Start Quantizing </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> model with type of </span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2"> ===&quot;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot; =======================================================================&quot;</span><span class="p">)</span>
<span class="n">current_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
<span class="n">txt_path</span> <span class="o">=</span> <span class="n">current_directory</span><span class="o">+</span><span class="s2">&quot;/dataset.txt&quot;</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">txt_path</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">num_lines</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">file</span><span class="o">.</span><span class="n">readlines</span><span class="p">())</span>
<span class="c1"># 移除已存在的量化文件</span>
<span class="n">quantize_file</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize&quot;</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">quantize_file</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m rm </span><span class="si">{</span><span class="n">quantize_file</span><span class="si">}</span><span class="s2"> </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">quantize_file</span><span class="p">)</span>
<span class="c1"># 构建并执行量化命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --batch-size 1 </span><span class="se">\</span>
<span class="s2"> --qtype </span><span class="si">{</span><span class="n">quantized_type</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --rebuild </span><span class="se">\</span>
<span class="s2"> --quantizer </span><span class="si">{</span><span class="n">quantization_type</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model-quantize </span><span class="si">{</span><span class="n">quantize_file</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --model-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --with-input-meta </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_inputmeta.yml </span><span class="se">\</span>
<span class="s2"> --device CPU </span><span class="se">\</span>
<span class="s2"> --algorithm kl_divergence </span><span class="se">\</span>
<span class="s2"> --iterations </span><span class="si">{</span><span class="n">num_lines</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
<span class="c1"># 检查量化结果</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">quantize_file</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m QUANTIZED SUCCESS </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m ERROR ! </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span></div>
<span class="c1"># def main():</span>
<span class="c1"># # 检查命令行参数数量</span>
<span class="c1"># if len(sys.argv) &lt; 3:</span>
<span class="c1"># print(&quot;Input a network name and quantized type ( uint8 / int8 / int16 )&quot;)</span>
<span class="c1"># sys.exit(-1)</span>
<span class="c1"># # 检查网络目录是否存在</span>
<span class="c1"># network_name = sys.argv[1]</span>
<span class="c1"># # 定义 netrans 路径</span>
<span class="c1"># # netrans = os.path.join(os.environ[&#39;NETRANS_PATH&#39;], &#39;pnnacc&#39;)</span>
<span class="c1"># # network_name = sys.argv[1]</span>
<span class="c1"># # check_env(network_name)</span>
<span class="c1"># netrans_path = os.environ[&#39;NETRANS_PATH&#39;]</span>
<span class="c1"># # netrans = os.path.join(netrans_path, &#39;pnnacc&#39;)</span>
<span class="c1"># quantize_type = sys.argv[2] </span>
<span class="c1"># cla = create_cls(netrans_path, network_name,quantize_type)</span>
<span class="c1"># # 调用量化函数</span>
<span class="c1"># run = Quantize(cla)</span>
<span class="c1"># run.quantize_network()</span>
<span class="c1"># if __name__ == &quot;__main__&quot;:</span>
<span class="c1"># main() </span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,200 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>quantize_hb &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>quantize_hb 源代码</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">check_path</span><span class="p">,</span> <span class="n">AttributeCopier</span><span class="p">,</span> <span class="n">create_cls</span>
<div class="viewcode-block" id="Quantize">
<a class="viewcode-back" href="../quantize_hb.html#quantize_hb.Quantize">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Quantize</span><span class="p">(</span><span class="n">AttributeCopier</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<span class="nd">@check_path</span>
<span class="k">def</span><span class="w"> </span><span class="nf">quantize_network</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">netrans</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">netrans</span>
<span class="n">quantized_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">quantize_type</span>
<span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">model_name</span>
<span class="c1"># check_env(name)</span>
<span class="c1"># print(os.getcwd())</span>
<span class="n">netrans</span> <span class="o">+=</span> <span class="s2">&quot; quantize&quot;</span>
<span class="c1"># 根据量化类型设置量化参数</span>
<span class="k">if</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;float&#39;</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== do not need quantized===========&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;uint8&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s2">&quot;asymmetric_affine&quot;</span>
<span class="k">elif</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;int8&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s2">&quot;dynamic_fixed_point-8&quot;</span>
<span class="k">elif</span> <span class="n">quantized_type</span> <span class="o">==</span> <span class="s1">&#39;int16&#39;</span><span class="p">:</span>
<span class="n">quantization_type</span> <span class="o">=</span> <span class="s2">&quot;dynamic_fixed_point-16&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;=========== wrong quantization_type ! ( uint8 / int8 / int16 )===========&quot;</span><span class="p">)</span>
<span class="k">return</span>
<span class="c1"># 输出量化信息</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot; =======================================================================&quot;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot; ==== Start Quantizing </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> model with type of </span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2"> ===&quot;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot; =======================================================================&quot;</span><span class="p">)</span>
<span class="c1"># 移除已存在的量化文件</span>
<span class="n">quantize_file</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">quantization_type</span><span class="si">}</span><span class="s2">.quantize&quot;</span>
<span class="n">current_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
<span class="n">txt_path</span> <span class="o">=</span> <span class="n">current_directory</span><span class="o">+</span><span class="s2">&quot;/dataset.txt&quot;</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">txt_path</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">num_lines</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">file</span><span class="o">.</span><span class="n">readlines</span><span class="p">())</span>
<span class="c1"># 构建并执行量化命令</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">netrans</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --qtype </span><span class="si">{</span><span class="n">quantized_type</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --hybrid </span><span class="se">\</span>
<span class="s2"> --quantizer </span><span class="si">{</span><span class="n">quantization_type</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;-&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model-quantize </span><span class="si">{</span><span class="n">quantize_file</span><span class="si">}</span><span class="s2"> </span><span class="se">\</span>
<span class="s2"> --model </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json </span><span class="se">\</span>
<span class="s2"> --model-data </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data </span><span class="se">\</span>
<span class="s2"> --with-input-meta </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">_inputmeta.yml </span><span class="se">\</span>
<span class="s2"> --device CPU </span><span class="se">\</span>
<span class="s2"> --algorithm kl_divergence </span><span class="se">\</span>
<span class="s2"> --divergence-nbins 2048 </span><span class="se">\</span>
<span class="s2"> --iterations </span><span class="si">{</span><span class="n">num_lines</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="n">os</span><span class="o">.</span><span class="n">system</span><span class="p">(</span><span class="n">cmd</span><span class="p">)</span>
<span class="c1"># 检查量化结果</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">quantize_file</span><span class="p">):</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m QUANTIZED SUCCESS </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\033</span><span class="s2">[31m ERROR ! </span><span class="se">\033</span><span class="s2">[0m&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="main">
<a class="viewcode-back" href="../quantize_hb.html#quantize_hb.main">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
<span class="c1"># 检查命令行参数数量</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">&lt;</span> <span class="mi">3</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Input a network name and quantized type ( uint8 / int8 / int16 )&quot;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># 检查网络目录是否存在</span>
<span class="n">network_name</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="c1"># 定义 netrans 路径</span>
<span class="c1"># netrans = os.path.join(os.environ[&#39;NETRANS_PATH&#39;], &#39;pnnacc&#39;)</span>
<span class="c1"># network_name = sys.argv[1]</span>
<span class="c1"># check_env(network_name)</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;NETRANS_PATH&#39;</span><span class="p">]</span>
<span class="c1"># netrans = os.path.join(netrans_path, &#39;pnnacc&#39;)</span>
<span class="n">quantize_type</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
<span class="n">cla</span> <span class="o">=</span> <span class="n">create_cls</span><span class="p">(</span><span class="n">netrans_path</span><span class="p">,</span> <span class="n">network_name</span><span class="p">,</span><span class="n">quantize_type</span><span class="p">)</span>
<span class="c1"># 调用量化函数</span>
<span class="n">run</span> <span class="o">=</span> <span class="n">Quantize</span><span class="p">(</span><span class="n">cla</span><span class="p">)</span>
<span class="n">run</span><span class="o">.</span><span class="n">quantize_network</span><span class="p">()</span></div>
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
<span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,236 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>utils &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="../_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=27fed22d" />
<script src="../_static/documentation_options.js?v=52efc512"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="../genindex.html" />
<link rel="search" title="搜索" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>utils 源代码</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="c1"># from functools import wraps</span>
<span class="c1"># def check_path(netrans, model_path):</span>
<span class="c1"># def decorator(func):</span>
<span class="c1"># @wraps(func)</span>
<span class="c1"># def wrapper(netrans, model_path, *args, **kargs):</span>
<span class="c1"># check_dir(model_path)</span>
<span class="c1"># check_netrans(netrans)</span>
<span class="c1"># if os.getcwd() != model_path :</span>
<span class="c1"># os.chdir(model_path)</span>
<span class="c1"># return func(netrans, model_path, *args, **kargs)</span>
<span class="c1"># return wrapper</span>
<span class="c1"># return decorator</span>
<div class="viewcode-block" id="check_path">
<a class="viewcode-back" href="../utils.html#utils.check_path">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">check_path</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot; 装饰器, 确保在工程目录运行 nertans </span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="nf">wrapper</span><span class="p">(</span><span class="n">cla</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kargs</span><span class="p">):</span>
<span class="n">check_netrans</span><span class="p">(</span><span class="n">cla</span><span class="o">.</span><span class="n">netrans</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> <span class="o">!=</span> <span class="n">cla</span><span class="o">.</span><span class="n">model_path</span> <span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">cla</span><span class="o">.</span><span class="n">model_path</span><span class="p">)</span>
<span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="n">cla</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">wrapper</span></div>
<div class="viewcode-block" id="check_dir">
<a class="viewcode-back" href="../utils.html#utils.check_dir">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">check_dir</span><span class="p">(</span><span class="n">network_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;判断工程目录是否存在</span>
<span class="sd"> Args:</span>
<span class="sd"> network_name (str): 工程目录路径</span>
<span class="sd"> Raises:</span>
<span class="sd"> NotADirectoryError: 没有那个工程目录</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">network_name</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">NotADirectoryError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Directory not found: </span><span class="si">{</span><span class="n">network_name</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span>
<span class="c1"># print(f&quot;Directory {network_name} does not exist !&quot;)</span>
<span class="c1"># sys.exit(-1)</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">network_name</span><span class="p">)</span></div>
<div class="viewcode-block" id="check_netrans">
<a class="viewcode-back" href="../utils.html#utils.check_netrans">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">check_netrans</span><span class="p">(</span><span class="n">netrans</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;判断 netrans 是否配置成功</span>
<span class="sd"> Args:</span>
<span class="sd"> netrans (str, bool): _netrans 路径, 如果没有配置(默认为False)会去环境变量里找</span>
<span class="sd"> Raises:</span>
<span class="sd"> NotADirectoryError: 找不到 Netrans 会返回 NotADirectoryError</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">netrans</span> <span class="o">!=</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">netrans</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="s1">&#39;NETRANS_PATH&#39;</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span> <span class="p">:</span>
<span class="k">return</span>
<span class="k">raise</span> <span class="ne">NotADirectoryError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Netrans not found: </span><span class="si">{</span><span class="n">netrans</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="remove_history_file">
<a class="viewcode-back" href="../utils.html#utils.remove_history_file">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">remove_history_file</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json&quot;</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.json&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data&quot;</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">.data&quot;</span><span class="p">)</span>
<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="s1">&#39;..&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="check_env">
<a class="viewcode-back" href="../utils.html#utils.check_env">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">check_env</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="n">check_dir</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
<span class="c1"># check_netrans()</span>
<span class="c1"># remove_history_file(name)</span>
<div class="viewcode-block" id="AttributeCopier">
<a class="viewcode-back" href="../utils.html#utils.AttributeCopier">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">AttributeCopier</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;快速解析复制 Netrans 信息</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">copy_attribute_name</span><span class="p">(</span><span class="n">source_obj</span><span class="p">)</span>
<div class="viewcode-block" id="AttributeCopier.copy_attribute_name">
<a class="viewcode-back" href="../utils.html#utils.AttributeCopier.copy_attribute_name">[文档]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">copy_attribute_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source_obj</span><span class="p">):</span>
<span class="k">for</span> <span class="n">attribute_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_attribute_names</span><span class="p">(</span><span class="n">source_obj</span><span class="p">):</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attribute_name</span><span class="p">,</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">source_obj</span><span class="p">,</span> <span class="n">attribute_name</span><span class="p">))</span></div>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_get_attribute_names</span><span class="p">(</span><span class="n">source_obj</span><span class="p">):</span>
<span class="k">return</span> <span class="n">source_obj</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span></div>
<div class="viewcode-block" id="create_cls">
<a class="viewcode-back" href="../utils.html#utils.create_cls">[文档]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">create_cls</span><span class="p">():</span> <span class="c1">#dataclass @netrans_params</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;快速测试时候模拟实例化Netrans&quot;&quot;&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">netrans_path</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">quantized_type</span> <span class="o">=</span> <span class="s1">&#39;uint8&#39;</span><span class="p">,</span><span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">netrans_path</span> <span class="o">=</span> <span class="n">netrans_path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">netrans</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">netrans_path</span><span class="p">,</span> <span class="s1">&#39;pnnacc&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">model_path</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">model_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">model_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="o">=</span><span class="n">verbose</span>
<span class="bp">self</span><span class="o">.</span><span class="n">quantize_type</span> <span class="o">=</span> <span class="n">quantized_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profile</span> <span class="o">=</span> <span class="kc">False</span></div>
<span class="c1"># if __name__ == &quot;__main__&quot;:</span>
<span class="c1"># dir_name = &quot;yolo&quot;</span>
<span class="c1"># os.mkdir(dir_name)</span>
<span class="c1"># check_dir(dir_name)</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">模块代码</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

View File

@ -0,0 +1,9 @@
附录
=============
.. toctree::
:maxdepth: 2
gen_api
modules

View File

@ -0,0 +1,7 @@
config module
=============
.. automodule:: config
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,7 @@
dump module
===========
.. automodule:: dump
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,7 @@
example module
==============
.. automodule:: example
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,7 @@
export module
=============
.. automodule:: export
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,7 @@
file\_model module
==================
.. automodule:: file_model
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,136 @@
# gen api html & pdf by sphinx
netrans 目录结构如下
```tree
netrans/
├── docs/ # Sphinx 项目的根目录
│ ├── source/ # 源文件目录
│ │ ├── _static/ # 静态文件如图片、CSS、JS
│ │ ├── _templates/ # 自定义模板
│ │ ├── conf.py # 配置文件
│ │ ├── index.rst # 主页文件
│ │ └── my_module.rst # 其他文档文件
│ └── build/ # 构建输出目录(生成的 HTML 文件等)
└── bin/
└── netrans_cli/
└── netrans_py/
```
1. `sphinx-quickstart docs/` 快速生成
2. 修改 `docs/source/conf.py` ,
### *.rst
rst, reStructuredText 文件用于定义文档的结构。通常放在source目录下。
rst 是一种和 markdown 类似的语法
使用目录树指令 `.. toctree::`,列出其他文档文件。
## 使用 autodoc + Sphinx 实现 python api 文档(html)
1. 修改 docs/source/conf.py
```py3
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'netrans'
copyright = '2025, ccyh'
author = 'xj'
release = '0.1'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
import os
import sys
sys.path.append('../../netrans_py/')
sys.path.append('../../')
# Sphinx 扩展
extensions = [
'sphinx.ext.autodoc', # 自动生成文档
'sphinx.ext.viewcode', # 添加源代码链接
'sphinx.ext.napoleon', # 支持 NumPy 和 Google 风格的 docstring
]
# 主题
html_theme = 'sphinx_rtd_theme'
templates_path = ['_templates']
exclude_patterns = []
language = 'zh'
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster'
html_static_path = ['_static']
source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
}
```
2. sphinx-apidoc -o docs/source/ .
生成 netrans_py 下所有的 *.py 的rst, 并添加到index.rst里.
```text
# index.rst
```
3. sphinx-build -b html docs/source docs/build
## 使用 autodoc + Sphinx 实现 python api 文档(pdf)
1. 在可以生成 html的 基础上, 使用make latexodf 生成 *.tex文件.
这一步会报错,原因是无法识别中文
2.修改 netrans.tex文件
```
cd build/latex
vim netrans.tex
```
在各种usapackage的地方新增:
```
\usepackage[UTF8, fontset=ubuntu]{ctex}
```
3. 使用 xelatex 生成pdf
sphinx使用的是 xelatex 而非 pdflatex
```
xelatex netrans.tex
```
## 常见报错
报错
```log
sphinx-quickstart
Traceback (most recent call last):
File "/home/xj/app/miniforge3/envs/sphinx/bin/sphinx-quickstart", line 8, in <module>
sys.exit(main())
File "/home/xj/app/miniforge3/envs/sphinx/lib/python3.10/site-packages/sphinx/cmd/quickstart.py", line 721, in main
locale.setlocale(locale.LC_ALL, '')
File "/home/xj/app/miniforge3/envs/sphinx/lib/python3.10/locale.py", line 620, in setlocale
return _setlocale(category, locale)
locale.Error: unsupported locale setting
```
解决:
export LC_ALL=en_US.UTF-8

View File

@ -0,0 +1,7 @@
import\_model module
====================
.. automodule:: import_model
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,22 @@
.. netrans documentation master file, created by
sphinx-quickstart on Fri Jun 27 15:04:57 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
netrans documentation
=====================
netrans 是一套针对pnna 芯片的模型处理工具,提供命令行工具 netrans_cli 和 python api netrans_py 其核心功能是将模型权重转换成在pnna芯片上运行的 nbgnetwork binary graph格式.nb 为后缀)。
.. toctree::
:maxdepth: 2
:caption: Contents:
quick_start_guide
netrans_cli
netrans_py
appendix

View File

@ -0,0 +1,7 @@
infer module
============
.. automodule:: infer
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,17 @@
netrans_py
==========
.. toctree::
:maxdepth: 4
netrans
config
dump
example
export
file_model
import_model
infer
quantize
quantize_hb
utils

View File

@ -0,0 +1,7 @@
netrans module
==============
.. automodule:: netrans
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,192 @@
# netrans_cli 使用
netrans_cli 是 netrans 进行模型转换的命令行工具,使用 ntrans_cli 完成模型转换的步骤如下:
1. 导入模型
2. 生成并修改前处理配置文件 *_inputmeta.yml
3. 量化模型
4. 导出模型
## netrans_cli 脚本
|脚本|功能|使用|
|:---|---|---|
|load.sh| 模型导入功能,将模型转换成 Pnna 支持的格式| load.sh model_name|
|config.sh| 预处理模版生成功能,生成预处理模版,根据模型进行对于的修改| config.sh model_name|
|quantize.sh| 量化功能, 对模型进行量化生成量化参数文件| quantize.sh model_name quantize_data_type|
|export.sh|导出功能,将量化好的模型导出成 Pnna 上可以运行的runtime| export.sh model_name quantize_data_type|
<font color="#dd0000">对于不同框架下训练的模型,需要准备不同的数据,所有的数据都需要与模型放在同一个文件夹下,模型文件名和文件夹名需要保持一致。</font>
## load.sh 模型导入
使用 load.sh 导入模型
- 用法: load.sh 以模型文件名命名的模型数据文件夹,例如:
```bash
load.sh lenet
```
"lenet"是文件夹名也作为模型名和权重文件名。导入会打印相关日志信息成功后会打印SUCESS。导入后lenet文件夹应该有"lenet.json"和"lenet.data"文件:
```bash
$ ls -lrt lenet
total 3396
-rwxr-xr-x 1 hope hope 1727201 Nov 5 2018 lenet.pb
-rw-r--r-- 1 hope hope 553 Nov 5 2018 0.jpg
-rwxr--r-- 1 hope hope 6 Apr 21 17:04 dataset.txt
-rw-rw-r-- 1 hope hope 69 Jun 7 09:19 inputs_outputs.txt
-rw-r--r-- 1 hope hope 5553 Jun 7 09:21 lenet.json
-rw-r--r-- 1 hope hope 1725178 Jun 7 09:21 lenet.data
```
## config.sh 预处理配置文件生成
使用 config.sh 生成 inputmeta 文件
- config.sh 以模型文件名命名的模型数据文件夹,例如:
```bash
config.sh lenet
```
inputmeta 文件生成会打印相关日志信息成功后会打印SUCESS。导入后lenet文件夹应该有 "lenet_inputmeta.yml" 文件:
```shell
$ ls -lrt lenet
total 3400
-rwxr-xr-x 1 hope hope 1727201 Nov 5 2018 lenet.pb
-rw-r--r-- 1 hope hope 553 Nov 5 2018 0.jpg
-rwxr--r-- 1 hope hope 6 Apr 21 17:04 dataset.txt
-rw-rw-r-- 1 hope hope 69 Jun 7 09:19 inputs_outputs.txt
-rw-r--r-- 1 hope hope 5553 Jun 7 09:21 lenet.json
-rw-r--r-- 1 hope hope 1725178 Jun 7 09:21 lenet.data
-rw-r--r-- 1 hope hope 948 Jun 7 09:35 lenet_inputmeta.yml
```
可以看到,最终生成的是*.yml文件该文件用于为Netrans中间模型配置输入层数据集合。<b>Netrans中的量化、推理、导出和图片转dat的操作都需要用到这个文件。因此此步骤不可跳过。</b>
Inputmeta.yml文件结构如下
```yaml
%YAML 1.2
---
# !!!This file disallow TABs!!!
# "category" allowed values: "image, undefined"
# "database" allowed types: "H5FS, SQLITE, TEXT, LMDB, NPY, GENERATOR"
# "tensor_name" only support in H5FS database
# "preproc_type" allowed types:"IMAGE_RGB, IMAGE_RGB888_PLANAR, IMAGE_RGB888_PLANAR_SEP,
IMAGE_I420,
# IMAGE_NV12, IMAGE_YUV444, IMAGE_GRAY, IMAGE_BGRA, TENSOR"
input_meta:
databases:
- path: dataset.txt
type: TEXT
ports:
- lid: data_0
category: image
dtype: float32
sparse: false
tensor_name:
layout: nhwc
shape:
- 50
- 224
- 224
- 3
preprocess:
reverse_channel: false
mean:
- 103.94
- 116.78
- 123.67
scale: 0.017
preproc_node_params:
preproc_type: IMAGE_RGB
add_preproc_node: false
preproc_perm:
- 0
- 1
- 2
- 3
- lid: label_0
redirect_to_output: true
category: undefined
tensor_name:
dtype: float32
shape:
- 1
- 1
```
上面示例文件的各个参数解释:
```{table}
:widths: 20, 80
:align: left
| 参数 | 说明 |
| :--- | --- |
| input_meta | 预处理参数配置申明。 |
| databases | 数据配置,包括设置 path、type 和 ports 。|
| path | 数据集文件的相对(执行目录)或绝对路径。默认为 dataset.txt, 不建议修改。 |
| type | 数据集文件格式固定为TEXT。 |
| ports | 指向网络中的输入或重定向的输入,目前只支持一个输入,如果网络存在多个输入,请与@ccyh联系。 |
| lid | 输入层的lid |
| category | 输入的类别。将此参数设置为以下值之一image图像输入或 undefined其他类型的输入。 |
| dtype | 输入张量的数据类型,用于将数据发送到 Pnna 网络的输入端口。支持的数据类型包括 float32 和 quantized。 |
| sparse | 指定网络张量是否以稀疏格式存在。将此参数设置为以下值之一true稀疏格式或 false压缩格式。 |
| tensor_name | 留空此参数 |
| layout | 输入张量的格式,使用 nchw 用于 Caffe、Darknet、ONNX 和 PyTorch 模型。使用 nhwc 用于 TensorFlow、TensorFlow Lite 和 Keras 模型。 |
| shape | 此张量的形状。第一维shape[0]表示每批的输入数量允许在一次推理操作之前将多个输入发送到网络。如果batch维度设置为0则需要从命令行指定--batch-size。如果 batch维度设置为大于1的值则直接使用inputmeta.yml中的batch size并忽略命令行中的--batch-size。 |
| fitting | 保留字段 |
| preprocess | 预处理步骤和顺序。预处理支持下面的四个键,键的顺序代表预处理的顺序。您可以相应地调整顺序。 |
| reverse_channel | 指定是否保留通道顺序。将此参数设置为以下值之一true保留通道顺序或 false不保留通道顺序。对于 TensorFlow 和 TensorFlow Lite 框架的模型使用 true。 |
| mean | 用于每个通道的均值。 |
| scale | 张量的缩放值。均值和缩放值用于根据公式 (inputTensor - mean) × scale 归一化输入张量。|
| preproc_node_params | 预处理节点参数,在 OVxlib C 项目案例中启用预处理任务 |
| add_preproc_node | 用于处理 OVxlib C 项目案例中预处理节点的插入。[true, false] 中的布尔值,表示通过配置以下参数将预处理层添加到导出的应用程序中。此参数仅在 add_preproc_node 参数设置为 true 时有效。|
| preproc_type | 预处理节点输入类型。 [IMAGE_RGB, IMAGE_RGB888_PLANAR,IMAGE_YUV420, IMAGE_GRAY, IMAGE_BGRA, TENSOR] 中的字符串值 |
| preproc_perm | 预处理节点输入的置换参数。 |
| redirect_to_output | 将database张量重定向到图形输出的特殊属性。如果为该属性设置了一个port网络构建器将自动为该port生成一个输出层以便后处理文件可以直接处理来自database的张量。 如果使用网络进行分类则上例中的lid“input_0”表示输入数据集的标签lid。 您可以设置其他名称来表示标签的lid。 请注意redirect_to_output 必须设置为 true以便后处理文件可以直接处理来自database的张量。 标签的lid必须与后处理文件中定义的 labels_tensor 的lid相同。 [true, false] 中的布尔值。 指定是否将由张量表示的输入端口的数据直接发送到网络输出。true直接发送到网络输出或 false不直接发送到网络输出|
```
可以根据实际情况对生成的inputmeta文件进行修改。
## quantize.sh 模型量化
如果我们训练好的模型的数据类型是float32的为了使模型以更高的效率在Pnna上运行我们可以对模型进行量化操作量化操作可能会带来一定程度的精度损失。
- 在netrans_cli目录下使用quantize.sh脚本进行量化操作。
用法:./quantize.sh 以模型文件名命名的模型数据文件夹 量化类型,例如:
```bash
quantize.sh lenet uint8
```
支持的量化类型有uint8、int8、int16
## export.sh 模型导出
使用 export.sh 导出模型生成nbg文件。
用法export.sh 以模型文件名命名的模型数据文件夹 数据类型,例如:
```bash
export.sh lenet uint8
```
导出支持的数据类型float、uint8、int8、int16其中使用uint8、int8、int16导出时需要先进行模型量化。导出的工程会在模型所在的目录下面的wksp目录里。
network_binary.nb文件在"asymmetric_affine"文件夹中:
```shell
ls -lrt lenet/wksp/asymmetric_affine/
-rw-r--r-- 1 hope hope 694912 Jun 7 09:55 network_binary.nb
```
目前支持将生成的network_binary.nb文件部署到Pnna硬件平台。具体部署方法请参阅模型部署相关文档。
## 使用示例
请参照examplesexamples 提供 [caffe 模型转换示例](./examples/caffe_model.md),[darknet 模型转换示例](./examples/darknet_model.md),[tensorflow 模型转换示例](./examples/tensorflow_model.md),[onnx 模型转换示例](./examples/onnx_model.md)。

View File

@ -0,0 +1,167 @@
# netrans_py 使用
netrans_py 为 Netrans 编译器的 python 调用接口。
使用 ntrans_py 完成模型转换的步骤如下:
1. 导入模型
2. 生成并修改前处理配置文件 *_inputmeta.yml
3. 量化模型
4. 导出模型
## Netrans 类
创建 Netrans
描述: 实例化 Netrans 类。
代码示例:
```py3
from netrans import Netrans
yolo_netrans = Netrans("../examples/darknet/yolov4_tiny")
```
参数
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|model_path| str| 第一位置参数,模型文件的路径|
|netans| str | 如果 NETRANS_PATH 没有设置可通过该参数指定netrans的路径|
输出返回:
无。
<!-- <font color="#dd0000">注意:</font> 模型目录准备需要和netrans_cli一致具体数据准备要求见[introduction](./introduction.md)。 -->
## Netrans.import 模型导入
描述: 将模型转换成 Pnna 支持的格式。
代码示例:
```py3
yolo_netrans.import()
```
参数:
无。
输出返回:
无。
在工程目录下生成 Pnna 支持的模型格式,以.json结尾的模型文件和 .data结尾的权重文件。
## Netrans.config 预处理配置文件生成
描述: 将模型转换成 Pnna 支持的格式。
代码示例:
```py3
yolo_netrans.config()
```
参数:
```{table}
:widths: 20, 30, 50
:align: left
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|inputmeta| bool,str, [Fasle, True, "inputmeta_filepath"] | 指定 inputmeta, 默认为False。 <br/> 如果为False则会生成inputmeta模板可使用mean、scale、reverse_channel 配合修改常用参数。<br/>如果已有现成的 inputmeta 文件则可通过该参数进行指定也可使用True, 则会自动索引 model_name_inputmeta.yml |
|mean| float, int, list | 设置预处理中 normalize 的 mean 参数 |
|scale| float, int, list | 设置预处理中 normalize 的 scale 参数 |
|reverse_channel | bool | 设置预处理中的 reverse_channel 参数 |
```
输出返回:
无。
## Netrans.quantize 模型量化
描述: 对模型生成量化配置文件。
代码示例:
```py3
yolo_netrans.quantize("uint8")
```
参数:
```{table}
:widths: 20, 30, 50
:align: left
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|quantize_type| str| 第一位置参数,模型量化类型,仅支持 "uint8", "int8", "int16"|
```
输出返回:
无。
## Netrans.export 模型导出
描述: 对模型生成量化配置文件。
代码示例:
```py3
yolo_netrans.export()
```
参数:
无。
输出返回:
无。请在目录 “wksp/*/” 下检查是否生成nbg文件。
## Netrans.model2nbg 模型生成nbg文件
描述: 模型导入、量化、及nbg文件生产
代码示例:
```py3
# 无预处理
yolo_netrans.model2nbg(quantize_type='uint8')
# 需要对数据进行normlize, menas为128, scale 为 0.0039
yolo_netrans.model2nbg(quantize_type='uint8',mean=128, scale = 0.0039)
# 需要对数据分通道进行normlize, menas为128,127,125,scale 为 0.0039, 且reverse_channel 为 True
yolo_netrans.model2nbg(quantize_type='uint8'mean=[128, 127, 125], scale = 0.0039, reverse_channel= True)
# 已经进行初始化设置
yolo_netrans.model2nbg(quantize_type='uint8', inputmeta=True)
```
参数
```{table}
:widths: 20, 30, 50
:align: left
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|quantize_type| str, ["uint8", "int8", "int16" ] | 量化类型,将模型量化成该参数指定的类型 |
|inputmeta| bool,str, [Fasle, True, "inputmeta_filepath"] | 指定 inputmeta, 默认为False。 <br/> 如果为False则会生成inputmeta模板可使用mean、scale、reverse_channel 配合修改常用参数。<br/>如果已有现成的 inputmeta 文件则可通过该参数进行指定也可使用True, 则会自动索引 model_name_inputmeta.yml |
|mean| float, int, list | 设置预处理中 normalize 的 mean 参数 |
|scale| float, int, list | 设置预处理中 normalize 的 scale 参数 |
|reverse_channel | bool | 设置预处理中的 reverse_channel 参数 |
```
输出返回:
请在目录 “wksp/*/” 下检查是否生成nbg文件。
## 使用示例
```py3
from nertans import Netrans
model_path = 'example/darknet/yolov4_tiny'
netrans_path = "netrans/bin" # 如果进行了export定义申明这一步可以不用
# 初始化netrans
net = Netrans(model_path,netrans=netrans_path)
# 模型载入
net.import()
# 配置预处理 normlize 的参数
net.config(scale=1,mean=0)
# 模型量化
net.quantize("uint8")
# 模型导出
net.export()
# 模型直接量化成 int16 并导出, 直接复用刚配置好的 inputmeta
net.model2nbg(quantize_type = "int16", inputmeta=True)
```

View File

@ -0,0 +1,7 @@
quantize module
===============
.. automodule:: quantize
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,7 @@
quantize\_hb module
===================
.. automodule:: quantize_hb
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,160 @@
# 快速入门
本文档以 onnx 格式的 yolov5s 为例演示如何快速安装Nertans 并使用 Netrans 量化、编译模型并生成 nbg 文件。
## 系统环境
- Linux操作系统推荐 Ubuntu 20.04 或 Debian12
- Python 3.8
- RAM 至少 8GB
## 安装Netrans
创建 python3.8 环境
```bash
wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
mkdir -p ~/app
INSTALL_PATH="${HOME}/app/miniforge3"
bash Miniforge3-Linux-x86_64.sh -b -p ${INSTALL_PATH}
echo "source "${INSTALL_PATH}/etc/profile.d/conda.sh"" >> ${HOME}/.bashrc
echo "source "${INSTALL_PATH}/etc/profile.d/mamba.sh"" >> ${HOME}/.bashrc
source ${HOME}/.bashrc
mamba create -n netrans python=3.8 -y
mamba activate netrans
```
下载 Netrans
```bash
cd ~/app
git clone https://gitlink.org.cn/nudt_dsp/netrans.git
```
配置 Netrans
```bash
cd ~/app/netrans
./setup.sh
```
## 使用 Netrans 编译 yolov5s 模型
进入工作目录
```bash
cd /app/netrans/examples/onnx
```
此时目录如下:
```text
onnx/
├── README.md
└── yolov5s
├── 0.jpg
├── dataset.txt
└── yolov5s.onnx
```
### 使用 netrans_cli 编译 yolov5s
#### 导入模型
```bash
load.sh yolov5s
```
该命令会在工程目录下生成包含模型信息的 .json 和 .data 数据文件。
此时 yolov5s 的目录结构如下
```text
yolov5s/
├── 0.jpg
├── yolov5s.data
├── yolov5s.json
└── yolov5s.onnx
```
#### 生成配置文件模板
配置文件定义输入数据前处理相关参数。Netrans预定义了配置文件模板生成脚本用户需根据模型前处理参数对配置文件进行修改。
```bash
config.sh yolov5s
```
此时 yolov5s 的目录结构如下:
```text
yolov5s/
├── 0.jpg
├── dataset.txt
├── yolov5s.data
├── yolov5s_inputmeta.yml
├── yolov5s.json
└── yolov5s.onnx
```
根据 yolov5s 的前处理参数 ,修改 yml 中的 scale 为 0.003921568627。
打开 ` yolov5s_inputmeta.yml ` 文件修改第30-33行
```text
scale:
- 0.003921568627
- 0.003921568627
- 0.003921568627
```
#### 量化模型
生成 unit8 量化的量化参数文件
```bash
quantize.sh yolov5s uint8
```
此时 yolov5s 的目录结构如下:
```text
yolov5s/
├── 0.jpg
├── dataset.txt
├── yolov5s_asymmetric_affine.quantize
├── yolov5s.data
├── yolov5s_inputmeta.yml
├── yolov5s.json
└── yolov5s.onnx
```
#### 导出模型
导出 unit8 量化的模型项目工程
```bash
export.sh yolov5s uint8
```
此时 yolov5s 的目录结构如下:
```text
yolov5s/
├── 0.jpg
├── dataset.txt
├── wksp
│ └── asymmetric_affine
│ └── network_binary.nb
├── yolov5s_asymmetric_affine.quantize
├── yolov5s.data
├── yolov5s_inputmeta.yml
├── yolov5s.json
└── yolov5s.onnx
```
### 使用 netrans_py 编译 yolov5s 模型
```bash
example.py yolov5s -q uint8 -m 0 -s 0.003921568627
```

View File

@ -0,0 +1,7 @@
setup module
============
.. automodule:: setup
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,7 @@
utils module
============
.. automodule:: utils
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,663 @@
/* -- page layout ----------------------------------------------------------- */
body {
font-family: Georgia, serif;
font-size: 17px;
background-color: #fff;
color: #000;
margin: 0;
padding: 0;
}
div.document {
width: 940px;
margin: 30px auto 0 auto;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 220px;
}
div.sphinxsidebar {
width: 220px;
font-size: 14px;
line-height: 1.5;
}
hr {
border: 1px solid #B1B4B6;
}
div.body {
background-color: #fff;
color: #3E4349;
padding: 0 30px 0 30px;
}
div.body > .section {
text-align: left;
}
div.footer {
width: 940px;
margin: 20px auto 30px auto;
font-size: 14px;
color: #888;
text-align: right;
}
div.footer a {
color: #888;
}
p.caption {
font-family: inherit;
font-size: inherit;
}
div.relations {
display: none;
}
div.sphinxsidebar {
max-height: 100%;
overflow-y: auto;
}
div.sphinxsidebar a {
color: #444;
text-decoration: none;
border-bottom: 1px dotted #999;
}
div.sphinxsidebar a:hover {
border-bottom: 1px solid #999;
}
div.sphinxsidebarwrapper {
padding: 18px 10px;
}
div.sphinxsidebarwrapper p.logo {
padding: 0;
margin: -10px 0 0 0px;
text-align: center;
}
div.sphinxsidebarwrapper h1.logo {
margin-top: -10px;
text-align: center;
margin-bottom: 5px;
text-align: left;
}
div.sphinxsidebarwrapper h1.logo-name {
margin-top: 0px;
}
div.sphinxsidebarwrapper p.blurb {
margin-top: 0;
font-style: normal;
}
div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: Georgia, serif;
color: #444;
font-size: 24px;
font-weight: normal;
margin: 0 0 5px 0;
padding: 0;
}
div.sphinxsidebar h4 {
font-size: 20px;
}
div.sphinxsidebar h3 a {
color: #444;
}
div.sphinxsidebar p.logo a,
div.sphinxsidebar h3 a,
div.sphinxsidebar p.logo a:hover,
div.sphinxsidebar h3 a:hover {
border: none;
}
div.sphinxsidebar p {
color: #555;
margin: 10px 0;
}
div.sphinxsidebar ul {
margin: 10px 0;
padding: 0;
color: #000;
}
div.sphinxsidebar ul li.toctree-l1 > a {
font-size: 120%;
}
div.sphinxsidebar ul li.toctree-l2 > a {
font-size: 110%;
}
div.sphinxsidebar input {
border: 1px solid #CCC;
font-family: Georgia, serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox {
margin: 1em 0;
}
div.sphinxsidebar .search > div {
display: table-cell;
}
div.sphinxsidebar hr {
border: none;
height: 1px;
color: #AAA;
background: #AAA;
text-align: left;
margin-left: 0;
width: 50%;
}
div.sphinxsidebar .badge {
border-bottom: none;
}
div.sphinxsidebar .badge:hover {
border-bottom: none;
}
/* To address an issue with donation coming after search */
div.sphinxsidebar h3.donation {
margin-top: 10px;
}
/* -- body styles ----------------------------------------------------------- */
a {
color: #004B6B;
text-decoration: underline;
}
a:hover {
color: #6D4100;
text-decoration: underline;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: Georgia, serif;
font-weight: normal;
margin: 30px 0px 10px 0px;
padding: 0;
}
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
div.body h2 { font-size: 180%; }
div.body h3 { font-size: 150%; }
div.body h4 { font-size: 130%; }
div.body h5 { font-size: 100%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #DDD;
padding: 0 4px;
text-decoration: none;
}
a.headerlink:hover {
color: #444;
background: #EAEAEA;
}
div.body p, div.body dd, div.body li {
line-height: 1.4em;
}
div.admonition {
margin: 20px 0px;
padding: 10px 30px;
background-color: #EEE;
border: 1px solid #CCC;
}
div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
background-color: #FBFBFB;
border-bottom: 1px solid #fafafa;
}
div.admonition p.admonition-title {
font-family: Georgia, serif;
font-weight: normal;
font-size: 24px;
margin: 0 0 10px 0;
padding: 0;
line-height: 1;
}
div.admonition p.last {
margin-bottom: 0;
}
dt:target, .highlight {
background: #FAF3E8;
}
div.warning {
background-color: #FCC;
border: 1px solid #FAA;
}
div.danger {
background-color: #FCC;
border: 1px solid #FAA;
-moz-box-shadow: 2px 2px 4px #D52C2C;
-webkit-box-shadow: 2px 2px 4px #D52C2C;
box-shadow: 2px 2px 4px #D52C2C;
}
div.error {
background-color: #FCC;
border: 1px solid #FAA;
-moz-box-shadow: 2px 2px 4px #D52C2C;
-webkit-box-shadow: 2px 2px 4px #D52C2C;
box-shadow: 2px 2px 4px #D52C2C;
}
div.caution {
background-color: #FCC;
border: 1px solid #FAA;
}
div.attention {
background-color: #FCC;
border: 1px solid #FAA;
}
div.important {
background-color: #EEE;
border: 1px solid #CCC;
}
div.note {
background-color: #EEE;
border: 1px solid #CCC;
}
div.tip {
background-color: #EEE;
border: 1px solid #CCC;
}
div.hint {
background-color: #EEE;
border: 1px solid #CCC;
}
div.seealso {
background-color: #EEE;
border: 1px solid #CCC;
}
div.topic {
background-color: #EEE;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre, tt, code {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
}
.hll {
background-color: #FFC;
margin: 0 -12px;
padding: 0 12px;
display: block;
}
img.screenshot {
}
tt.descname, tt.descclassname, code.descname, code.descclassname {
font-size: 0.95em;
}
tt.descname, code.descname {
padding-right: 0.08em;
}
img.screenshot {
-moz-box-shadow: 2px 2px 4px #EEE;
-webkit-box-shadow: 2px 2px 4px #EEE;
box-shadow: 2px 2px 4px #EEE;
}
table.docutils {
border: 1px solid #888;
-moz-box-shadow: 2px 2px 4px #EEE;
-webkit-box-shadow: 2px 2px 4px #EEE;
box-shadow: 2px 2px 4px #EEE;
}
table.docutils td, table.docutils th {
border: 1px solid #888;
padding: 0.25em 0.7em;
}
table.field-list, table.footnote {
border: none;
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
table.footnote {
margin: 15px 0;
width: 100%;
border: 1px solid #EEE;
background: #FDFDFD;
font-size: 0.9em;
}
table.footnote + table.footnote {
margin-top: -15px;
border-top: none;
}
table.field-list th {
padding: 0 0.8em 0 0;
}
table.field-list td {
padding: 0;
}
table.field-list p {
margin-bottom: 0.8em;
}
/* Cloned from
* https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
*/
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
table.footnote td.label {
width: .1px;
padding: 0.3em 0 0.3em 0.5em;
}
table.footnote td {
padding: 0.3em 0.5em;
}
dl {
margin-left: 0;
margin-right: 0;
margin-top: 0;
padding: 0;
}
dl dd {
margin-left: 30px;
}
blockquote {
margin: 0 0 0 30px;
padding: 0;
}
ul, ol {
/* Matches the 30px from the narrow-screen "li > ul" selector below */
margin: 10px 0 10px 30px;
padding: 0;
}
pre {
background: unset;
padding: 7px 30px;
margin: 15px 0px;
line-height: 1.3em;
}
div.viewcode-block:target {
background: #ffd;
}
dl pre, blockquote pre, li pre {
margin-left: 0;
padding-left: 30px;
}
tt, code {
background-color: #ecf0f3;
color: #222;
/* padding: 1px 2px; */
}
tt.xref, code.xref, a tt {
background-color: #FBFBFB;
border-bottom: 1px solid #fff;
}
a.reference {
text-decoration: none;
border-bottom: 1px dotted #004B6B;
}
a.reference:hover {
border-bottom: 1px solid #6D4100;
}
/* Don't put an underline on images */
a.image-reference, a.image-reference:hover {
border-bottom: none;
}
a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
vertical-align: top;
border-bottom: 1px dotted #004B6B;
}
a.footnote-reference:hover {
border-bottom: 1px solid #6D4100;
}
a:hover tt, a:hover code {
background: #EEE;
}
@media screen and (max-width: 940px) {
body {
margin: 0;
padding: 20px 30px;
}
div.documentwrapper {
float: none;
background: #fff;
margin-left: 0;
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
}
div.sphinxsidebar {
display: block;
float: none;
width: unset;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
color: #FFF;
}
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
div.sphinxsidebar h3 a {
color: #fff;
}
div.sphinxsidebar a {
color: #AAA;
}
div.sphinxsidebar p.logo {
display: none;
}
div.document {
width: 100%;
margin: 0;
}
div.footer {
display: none;
}
div.bodywrapper {
margin: 0;
}
div.body {
min-height: 0;
min-width: auto; /* fixes width on small screens, breaks .hll */
padding: 0;
}
.hll {
/* "fixes" the breakage */
width: max-content;
}
.rtd_doc_footer {
display: none;
}
.document {
width: auto;
}
.footer {
width: auto;
}
.github {
display: none;
}
ul {
margin-left: 0;
}
li > ul {
/* Matches the 30px from the "ul, ol" selector above */
margin-left: 30px;
}
}
/* misc. */
.revsys-inline {
display: none!important;
}
/* Hide ugly table cell borders in ..bibliography:: directive output */
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
border: none;
/* Below needed in some edge cases; if not applied, bottom shadows appear */
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
/* relbar */
.related {
line-height: 30px;
width: 100%;
font-size: 0.9rem;
}
.related.top {
border-bottom: 1px solid #EEE;
margin-bottom: 20px;
}
.related.bottom {
border-top: 1px solid #EEE;
}
.related ul {
padding: 0;
margin: 0;
list-style: none;
}
.related li {
display: inline;
}
nav#rellinks {
float: right;
}
nav#rellinks li+li:before {
content: "|";
}
nav#breadcrumbs li+li:before {
content: "\00BB";
}
/* Hide certain items when printing */
@media print {
div.related {
display: none;
}
}
img.github {
position: absolute;
top: 0;
border: 0;
right: 0;
}

906
docs/html/_static/basic.css Normal file
View File

@ -0,0 +1,906 @@
/*
* Sphinx stylesheet -- basic theme.
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
div.section::after {
display: block;
content: '';
clear: left;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin-top: 10px;
}
ul.search li {
padding: 5px 0;
}
ul.search li a {
font-weight: bold;
}
ul.search li p.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: inherit;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a:visited {
color: #551A8B;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, figure.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, figure.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, figure.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, figure.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar,
aside.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}
p.sidebar-title {
font-weight: bold;
}
nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
display: block;
content: '';
clear: both;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
margin-top: 10px;
margin-bottom: 10px;
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > :first-child,
td > :first-child {
margin-top: 0px;
}
th > :last-child,
td > :last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure, figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption, figcaption {
padding: 0.3em;
}
div.figure p.caption span.caption-number,
figcaption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text,
figcaption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist {
margin: 1em 0;
}
table.hlist td {
vertical-align: top;
}
/* -- object description styles --------------------------------------------- */
.sig {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
}
.sig-name, code.descname {
background-color: transparent;
font-weight: bold;
}
.sig-name {
font-size: 1.1em;
}
code.descname {
font-size: 1.2em;
}
.sig-prename, code.descclassname {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.sig-param.n {
font-style: italic;
}
/* C++ specific styling */
.sig-inline.c-texpr,
.sig-inline.cpp-texpr {
font-family: unset;
}
.sig.c .k, .sig.c .kt,
.sig.cpp .k, .sig.cpp .kt {
color: #0033B3;
}
.sig.c .m,
.sig.cpp .m {
color: #1750EB;
}
.sig.c .s, .sig.c .sc,
.sig.cpp .s, .sig.cpp .sc {
color: #067D17;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
:not(li) > ol > li:first-child > :first-child,
:not(li) > ul > li:first-child > :first-child {
margin-top: 0px;
}
:not(li) > ol > li:last-child > :last-child,
:not(li) > ul > li:last-child > :last-child {
margin-bottom: 0px;
}
ol.simple ol p,
ol.simple ul p,
ul.simple ol p,
ul.simple ul p {
margin-top: 0;
}
ol.simple > li:not(:first-child) > p,
ul.simple > li:not(:first-child) > p {
margin-top: 0;
}
ol.simple p,
ul.simple p {
margin-bottom: 0;
}
aside.footnote > span,
div.citation > span {
float: left;
}
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > :first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}
.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0 0.5em;
content: ":";
display: inline-block;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
pre, div[class*="highlight-"] {
clear: both;
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}
div[class*="highlight-"] {
margin: 1em 0;
}
td.linenos pre {
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
display: block;
}
table.highlighttable tbody {
display: block;
}
table.highlighttable tr {
display: flex;
}
table.highlighttable td {
margin: 0;
padding: 0;
}
table.highlighttable td.linenos {
padding-right: 0.5em;
}
table.highlighttable td.code {
flex: 1;
overflow: hidden;
}
.highlight .hll {
display: block;
}
div.highlight pre,
table.highlighttable pre {
margin: 0;
}
div.code-block-caption + div {
margin-top: 0;
}
div.code-block-caption {
margin-top: 1em;
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
-moz-user-select: none; /* Firefox */
-ms-user-select: none; /* IE10+ */
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
margin: 1em 0;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: absolute;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

View File

@ -0,0 +1 @@
/* This file intentionally left blank. */

View File

@ -0,0 +1,149 @@
/*
* Base JavaScript utilities for all Sphinx HTML documentation.
*/
"use strict";
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
"TEXTAREA",
"INPUT",
"SELECT",
"BUTTON",
]);
const _ready = (callback) => {
if (document.readyState !== "loading") {
callback();
} else {
document.addEventListener("DOMContentLoaded", callback);
}
};
/**
* Small JavaScript module for the documentation.
*/
const Documentation = {
init: () => {
Documentation.initDomainIndexTable();
Documentation.initOnKeyListeners();
},
/**
* i18n support
*/
TRANSLATIONS: {},
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
LOCALE: "unknown",
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext: (string) => {
const translated = Documentation.TRANSLATIONS[string];
switch (typeof translated) {
case "undefined":
return string; // no translation
case "string":
return translated; // translation exists
default:
return translated[0]; // (singular, plural) translation tuple exists
}
},
ngettext: (singular, plural, n) => {
const translated = Documentation.TRANSLATIONS[singular];
if (typeof translated !== "undefined")
return translated[Documentation.PLURAL_EXPR(n)];
return n === 1 ? singular : plural;
},
addTranslations: (catalog) => {
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
Documentation.PLURAL_EXPR = new Function(
"n",
`return (${catalog.plural_expr})`
);
Documentation.LOCALE = catalog.locale;
},
/**
* helper function to focus on search bar
*/
focusSearchBar: () => {
document.querySelectorAll("input[name=q]")[0]?.focus();
},
/**
* Initialise the domain index toggle buttons
*/
initDomainIndexTable: () => {
const toggler = (el) => {
const idNumber = el.id.substr(7);
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
if (el.src.substr(-9) === "minus.png") {
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
toggledRows.forEach((el) => (el.style.display = "none"));
} else {
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
toggledRows.forEach((el) => (el.style.display = ""));
}
};
const togglerElements = document.querySelectorAll("img.toggler");
togglerElements.forEach((el) =>
el.addEventListener("click", (event) => toggler(event.currentTarget))
);
togglerElements.forEach((el) => (el.style.display = ""));
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
},
initOnKeyListeners: () => {
// only install a listener if it is really needed
if (
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
)
return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.altKey || event.ctrlKey || event.metaKey) return;
if (!event.shiftKey) {
switch (event.key) {
case "ArrowLeft":
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
const prevLink = document.querySelector('link[rel="prev"]');
if (prevLink && prevLink.href) {
window.location.href = prevLink.href;
event.preventDefault();
}
break;
case "ArrowRight":
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
const nextLink = document.querySelector('link[rel="next"]');
if (nextLink && nextLink.href) {
window.location.href = nextLink.href;
event.preventDefault();
}
break;
}
}
// some keyboard layouts may need Shift to get /
switch (event.key) {
case "/":
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
Documentation.focusSearchBar();
event.preventDefault();
}
});
},
};
// quick alias for translations
const _ = Documentation.gettext;
_ready(Documentation.init);

View File

@ -0,0 +1,13 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1',
LANGUAGE: 'zh',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
};

BIN
docs/html/_static/file.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 B

View File

@ -0,0 +1,5 @@
<svg xmlns="http://www.w3.org/2000/svg" width="80" height="80" viewBox="0 0 250 250" fill="#fff">
<path d="M0 0l115 115h15l12 27 108 108V0z" fill="#151513"/>
<path d="M128 109c-15-9-9-19-9-19 3-7 2-11 2-11-1-7 3-2 3-2 4 5 2 11 2 11-3 10 5 15 9 16"/>
<path d="M115 115s4 2 5 0l14-14c3-2 6-3 8-3-8-11-15-24 2-41 5-5 10-7 16-7 1-2 3-7 12-11 0 0 5 3 7 16 4 2 8 5 12 9s7 8 9 12c14 3 17 7 17 7-4 8-9 11-11 11 0 6-2 11-7 16-16 16-30 10-41 2 0 3-1 7-5 11l-12 11c-1 1 1 5 1 5z"/>
</svg>

After

Width:  |  Height:  |  Size: 490 B

View File

@ -0,0 +1,192 @@
/*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*/
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
/* Non-minified version is copied as a separate JS file, if available */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}

BIN
docs/html/_static/minus.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 B

BIN
docs/html/_static/plus.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 B

View File

@ -0,0 +1,84 @@
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #8F5902; font-style: italic } /* Comment */
.highlight .err { color: #A40000; border: 1px solid #EF2929 } /* Error */
.highlight .g { color: #000 } /* Generic */
.highlight .k { color: #004461; font-weight: bold } /* Keyword */
.highlight .l { color: #000 } /* Literal */
.highlight .n { color: #000 } /* Name */
.highlight .o { color: #582800 } /* Operator */
.highlight .x { color: #000 } /* Other */
.highlight .p { color: #000; font-weight: bold } /* Punctuation */
.highlight .ch { color: #8F5902; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #8F5902; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #8F5902 } /* Comment.Preproc */
.highlight .cpf { color: #8F5902; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #8F5902; font-style: italic } /* Comment.Single */
.highlight .cs { color: #8F5902; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A40000 } /* Generic.Deleted */
.highlight .ge { color: #000; font-style: italic } /* Generic.Emph */
.highlight .ges { color: #000 } /* Generic.EmphStrong */
.highlight .gr { color: #EF2929 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888 } /* Generic.Output */
.highlight .gp { color: #745334 } /* Generic.Prompt */
.highlight .gs { color: #000; font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #A40000; font-weight: bold } /* Generic.Traceback */
.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
.highlight .ld { color: #000 } /* Literal.Date */
.highlight .m { color: #900 } /* Literal.Number */
.highlight .s { color: #4E9A06 } /* Literal.String */
.highlight .na { color: #C4A000 } /* Name.Attribute */
.highlight .nb { color: #004461 } /* Name.Builtin */
.highlight .nc { color: #000 } /* Name.Class */
.highlight .no { color: #000 } /* Name.Constant */
.highlight .nd { color: #888 } /* Name.Decorator */
.highlight .ni { color: #CE5C00 } /* Name.Entity */
.highlight .ne { color: #C00; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #000 } /* Name.Function */
.highlight .nl { color: #F57900 } /* Name.Label */
.highlight .nn { color: #000 } /* Name.Namespace */
.highlight .nx { color: #000 } /* Name.Other */
.highlight .py { color: #000 } /* Name.Property */
.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #000 } /* Name.Variable */
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
.highlight .pm { color: #000; font-weight: bold } /* Punctuation.Marker */
.highlight .w { color: #F8F8F8 } /* Text.Whitespace */
.highlight .mb { color: #900 } /* Literal.Number.Bin */
.highlight .mf { color: #900 } /* Literal.Number.Float */
.highlight .mh { color: #900 } /* Literal.Number.Hex */
.highlight .mi { color: #900 } /* Literal.Number.Integer */
.highlight .mo { color: #900 } /* Literal.Number.Oct */
.highlight .sa { color: #4E9A06 } /* Literal.String.Affix */
.highlight .sb { color: #4E9A06 } /* Literal.String.Backtick */
.highlight .sc { color: #4E9A06 } /* Literal.String.Char */
.highlight .dl { color: #4E9A06 } /* Literal.String.Delimiter */
.highlight .sd { color: #8F5902; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4E9A06 } /* Literal.String.Double */
.highlight .se { color: #4E9A06 } /* Literal.String.Escape */
.highlight .sh { color: #4E9A06 } /* Literal.String.Heredoc */
.highlight .si { color: #4E9A06 } /* Literal.String.Interpol */
.highlight .sx { color: #4E9A06 } /* Literal.String.Other */
.highlight .sr { color: #4E9A06 } /* Literal.String.Regex */
.highlight .s1 { color: #4E9A06 } /* Literal.String.Single */
.highlight .ss { color: #4E9A06 } /* Literal.String.Symbol */
.highlight .bp { color: #3465A4 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #000 } /* Name.Function.Magic */
.highlight .vc { color: #000 } /* Name.Variable.Class */
.highlight .vg { color: #000 } /* Name.Variable.Global */
.highlight .vi { color: #000 } /* Name.Variable.Instance */
.highlight .vm { color: #000 } /* Name.Variable.Magic */
.highlight .il { color: #900 } /* Literal.Number.Integer.Long */

View File

@ -0,0 +1,635 @@
/*
* Sphinx JavaScript utilities for the full-text search.
*/
"use strict";
/**
* Simple result scoring code.
*/
if (typeof Scorer === "undefined") {
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [docname, title, anchor, descr, score, filename]
// and returns the new score.
/*
score: result => {
const [docname, title, anchor, descr, score, filename, kind] = result
return score
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {
0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5, // used to be unimportantResults
},
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2,
};
}
// Global search result kind enum, used by themes to style search results.
class SearchResultKind {
static get index() { return "index"; }
static get object() { return "object"; }
static get text() { return "text"; }
static get title() { return "title"; }
}
const _removeChildren = (element) => {
while (element && element.lastChild) element.removeChild(element.lastChild);
};
/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
*/
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;
const [docName, title, anchor, descr, score, _filename, kind] = item;
let listItem = document.createElement("li");
// Add a class representing the item's type:
// can be used by a theme's CSS selector for styling
// See SearchResultKind for the class names.
listItem.classList.add(`kind-${kind}`);
let requestUrl;
let linkUrl;
if (docBuilder === "dirhtml") {
// dirhtml builder
let dirname = docName + "/";
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
requestUrl = contentRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
.then((data) => {
if (data)
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms, anchor)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
const _finishSearch = (resultCount) => {
Search.stopPulse();
Search.title.innerText = _("Search Results");
if (!resultCount)
Search.status.innerText = Documentation.gettext(
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
);
else
Search.status.innerText = Documentation.ngettext(
"Search finished, found one page matching the search query.",
"Search finished, found ${resultCount} pages matching the search query.",
resultCount,
).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
results,
resultCount,
searchTerms,
highlightTerms,
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout(
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5
);
}
// search finished, update title and status message
else _finishSearch(resultCount);
};
// Helper function used by query() to order search results.
// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
// Order the results by score (in opposite order of appearance, since the
// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
const _orderResultsByScoreThenName = (a, b) => {
const leftScore = a[4];
const rightScore = b[4];
if (leftScore === rightScore) {
// same score: sort alphabetically
const leftTitle = a[1].toLowerCase();
const rightTitle = b[1].toLowerCase();
if (leftTitle === rightTitle) return 0;
return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
}
return leftScore > rightScore ? 1 : -1;
};
/**
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
* custom function per language.
*
* The regular expression works by splitting the string on consecutive characters
* that are not Unicode letters, numbers, underscores, or emoji characters.
* This is the same as ``\W+`` in Python, preserving the surrogate pair area.
*/
if (typeof splitQuery === "undefined") {
var splitQuery = (query) => query
.split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
.filter(term => term) // remove remaining empty strings
}
/**
* Search Module
*/
const Search = {
_index: null,
_queued_query: null,
_pulse_status: -1,
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
if (anchorContent) return anchorContent.textContent;
console.warn(
`Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
);
}
// if anchor not specified or not found, fall back to main content
const docContent = htmlElement.querySelector('[role="main"]');
if (docContent) return docContent.textContent;
console.warn(
"Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
);
return "";
},
init: () => {
const query = new URLSearchParams(window.location.search).get("q");
document
.querySelectorAll('input[name="q"]')
.forEach((el) => (el.value = query));
if (query) Search.performSearch(query);
},
loadIndex: (url) =>
(document.body.appendChild(document.createElement("script")).src = url),
setIndex: (index) => {
Search._index = index;
if (Search._queued_query !== null) {
const query = Search._queued_query;
Search._queued_query = null;
Search.query(query);
}
},
hasIndex: () => Search._index !== null,
deferQuery: (query) => (Search._queued_query = query),
stopPulse: () => (Search._pulse_status = -1),
startPulse: () => {
if (Search._pulse_status >= 0) return;
const pulse = () => {
Search._pulse_status = (Search._pulse_status + 1) % 4;
Search.dots.innerText = ".".repeat(Search._pulse_status);
if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something (or wait until index is loaded)
*/
performSearch: (query) => {
// create the required interface elements
const searchText = document.createElement("h2");
searchText.textContent = _("Searching");
const searchSummary = document.createElement("p");
searchSummary.classList.add("search-summary");
searchSummary.innerText = "";
const searchList = document.createElement("ul");
searchList.setAttribute("role", "list");
searchList.classList.add("search");
const out = document.getElementById("search-results");
Search.title = out.appendChild(searchText);
Search.dots = Search.title.appendChild(document.createElement("span"));
Search.status = out.appendChild(searchSummary);
Search.output = out.appendChild(searchList);
const searchProgress = document.getElementById("search-progress");
// Some themes don't use the search progress node
if (searchProgress) {
searchProgress.innerText = _("Preparing search...");
}
Search.startPulse();
// index already loaded, the browser was quick!
if (Search.hasIndex()) Search.query(query);
else Search.deferQuery(query);
},
_parseQuery: (query) => {
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
const excludedTerms = new Set();
const highlightTerms = new Set();
const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
splitQuery(query.trim()).forEach((queryTerm) => {
const queryTermLower = queryTerm.toLowerCase();
// maybe skip this "word"
// stopwords array is from language_data.js
if (
stopwords.indexOf(queryTermLower) !== -1 ||
queryTerm.match(/^\d+$/)
)
return;
// stem the word
let word = stemmer.stemWord(queryTermLower);
// select the correct list
if (word[0] === "-") excludedTerms.add(word.substr(1));
else {
searchTerms.add(word);
highlightTerms.add(queryTermLower);
}
});
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
}
// console.debug("SEARCH: searching for:");
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
},
/**
* execute search (requires search index to be loaded)
*/
_performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const allTitles = Search._index.alltitles;
const indexEntries = Search._index.indexentries;
// Collect multiple result groups to be sorted separately and then ordered.
// Each is an array of [docname, title, anchor, descr, score, filename, kind].
const normalResults = [];
const nonMainIndexResults = [];
_removeChildren(document.getElementById("search-progress"));
const queryLower = query.toLowerCase().trim();
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score + boost,
filenames[file],
SearchResultKind.title,
]);
}
}
}
// search for explicit entries in index directives
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
for (const [file, id, isMain] of foundEntries) {
const score = Math.round(100 * queryLower.length / entry.length);
const result = [
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
SearchResultKind.index,
];
if (isMain) {
normalResults.push(result);
} else {
nonMainIndexResults.push(result);
}
}
}
}
// lookup as object
objectTerms.forEach((term) =>
normalResults.push(...Search.performObjectSearch(term, objectTerms))
);
// lookup as search terms in fulltext
normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
normalResults.forEach((item) => (item[4] = Scorer.score(item)));
nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
}
// Sort each group of results by score and then alphabetically by name.
normalResults.sort(_orderResultsByScoreThenName);
nonMainIndexResults.sort(_orderResultsByScoreThenName);
// Combine the result groups in (reverse) order.
// Non-main index entries are typically arbitrary cross-references,
// so display them after other results.
let results = [...nonMainIndexResults, ...normalResults];
// remove duplicate search results
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
let seen = new Set();
results = results.reverse().reduce((acc, result) => {
let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
if (!seen.has(resultStr)) {
acc.push(result);
seen.add(resultStr);
}
return acc;
}, []);
return results.reverse();
},
query: (query) => {
const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
// for debugging
//Search.lastresults = results.slice(); // a copy
// console.info("search results:", Search.lastresults);
// print the results
_displayNextItem(results, results.length, searchTerms, highlightTerms);
},
/**
* search for object names
*/
performObjectSearch: (object, objectTerms) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const objects = Search._index.objects;
const objNames = Search._index.objnames;
const titles = Search._index.titles;
const results = [];
const objectSearchCallback = (prefix, match) => {
const name = match[4]
const fullname = (prefix ? prefix + "." : "") + name;
const fullnameLower = fullname.toLowerCase();
if (fullnameLower.indexOf(object) < 0) return;
let score = 0;
const parts = fullnameLower.split(".");
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullnameLower === object || parts.slice(-1)[0] === object)
score += Scorer.objNameMatch;
else if (parts.slice(-1)[0].indexOf(object) > -1)
score += Scorer.objPartialMatch; // matches in last name
const objName = objNames[match[1]][2];
const title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
const otherTerms = new Set(objectTerms);
otherTerms.delete(object);
if (otherTerms.size > 0) {
const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
if (
[...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
)
return;
}
let anchor = match[3];
if (anchor === "") anchor = fullname;
else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
const descr = objName + _(", in ") + title;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2]))
score += Scorer.objPrio[match[2]];
else score += Scorer.objPrioDefault;
results.push([
docNames[match[0]],
fullname,
"#" + anchor,
descr,
score,
filenames[match[0]],
SearchResultKind.object,
]);
};
Object.keys(objects).forEach((prefix) =>
objects[prefix].forEach((array) =>
objectSearchCallback(prefix, array)
)
);
return results;
},
/**
* search for full-text terms in the index
*/
performTermsSearch: (searchTerms, excludedTerms) => {
// prepare search
const terms = Search._index.terms;
const titleTerms = Search._index.titleterms;
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const scoreMap = new Map();
const fileMap = new Map();
// perform the search on the required terms
searchTerms.forEach((word) => {
const files = [];
// find documents, if any, containing the query word in their text/title term indices
// use Object.hasOwnProperty to avoid mismatching against prototype properties
const arr = [
{ files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
{ files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
];
// add support for partial matches
if (word.length > 2) {
const escapedWord = _escapeRegExp(word);
if (!terms.hasOwnProperty(word)) {
Object.keys(terms).forEach((term) => {
if (term.match(escapedWord))
arr.push({ files: terms[term], score: Scorer.partialTerm });
});
}
if (!titleTerms.hasOwnProperty(word)) {
Object.keys(titleTerms).forEach((term) => {
if (term.match(escapedWord))
arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
});
}
}
// no match but word was a required one
if (arr.every((record) => record.files === undefined)) return;
// found search word in contents
arr.forEach((record) => {
if (record.files === undefined) return;
let recordFiles = record.files;
if (recordFiles.length === undefined) recordFiles = [recordFiles];
files.push(...recordFiles);
// set score for the word in each file
recordFiles.forEach((file) => {
if (!scoreMap.has(file)) scoreMap.set(file, new Map());
const fileScores = scoreMap.get(file);
fileScores.set(word, record.score);
});
});
// create the mapping
files.forEach((file) => {
if (!fileMap.has(file)) fileMap.set(file, [word]);
else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
});
});
// now check if the files don't contain excluded terms
const results = [];
for (const [file, wordList] of fileMap) {
// check if all requirements are matched
// as search terms with length < 3 are discarded
const filteredTermCount = [...searchTerms].filter(
(term) => term.length > 2
).length;
if (
wordList.length !== searchTerms.size &&
wordList.length !== filteredTermCount
)
continue;
// ensure that none of the excluded terms is in the search result
if (
[...excludedTerms].some(
(term) =>
terms[term] === file ||
titleTerms[term] === file ||
(terms[term] || []).includes(file) ||
(titleTerms[term] || []).includes(file)
)
)
break;
// select one (max) score for the file.
const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
// add result to the result list
results.push([
docNames[file],
titles[file],
"",
null,
score,
filenames[file],
SearchResultKind.text,
]);
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words.
*/
makeSearchSummary: (htmlText, keywords, anchor) => {
const text = Search.htmlToText(htmlText, anchor);
if (text === "") return null;
const textLower = text.toLowerCase();
const actualStartPosition = [...keywords]
.map((k) => textLower.indexOf(k.toLowerCase()))
.filter((i) => i > -1)
.slice(-1)[0];
const startWithContext = Math.max(actualStartPosition - 120, 0);
const top = startWithContext === 0 ? "" : "...";
const tail = startWithContext + 240 < text.length ? "..." : "";
let summary = document.createElement("p");
summary.classList.add("context");
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
return summary;
},
};
_ready(Search.init);

View File

@ -0,0 +1,154 @@
/* Highlighting utilities for Sphinx HTML documentation. */
"use strict";
const SPHINX_HIGHLIGHT_ENABLED = true
/**
* highlight a given string on a node by wrapping it in
* span elements with the given class name.
*/
const _highlight = (node, addItems, text, className) => {
if (node.nodeType === Node.TEXT_NODE) {
const val = node.nodeValue;
const parent = node.parentNode;
const pos = val.toLowerCase().indexOf(text);
if (
pos >= 0 &&
!parent.classList.contains(className) &&
!parent.classList.contains("nohighlight")
) {
let span;
const closestNode = parent.closest("body, svg, foreignObject");
const isInSVG = closestNode && closestNode.matches("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.classList.add(className);
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
rest,
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);
if (isInSVG) {
const rect = document.createElementNS(
"http://www.w3.org/2000/svg",
"rect"
);
const bbox = parent.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute("class", className);
addItems.push({ parent: parent, target: rect });
}
}
} else if (node.matches && !node.matches("button, select, textarea")) {
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
}
};
const _highlightText = (thisNode, text, className) => {
let addItems = [];
_highlight(thisNode, addItems, text, className);
addItems.forEach((obj) =>
obj.parent.insertAdjacentElement("beforebegin", obj.target)
);
};
/**
* Small JavaScript module for the documentation.
*/
const SphinxHighlight = {
/**
* highlight the search words provided in localstorage in the text
*/
highlightSearchWords: () => {
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
// get and clear terms from localstorage
const url = new URL(window.location);
const highlight =
localStorage.getItem("sphinx_highlight_terms")
|| url.searchParams.get("highlight")
|| "";
localStorage.removeItem("sphinx_highlight_terms")
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
// get individual terms from highlight string
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
if (terms.length === 0) return; // nothing to do
// There should never be more than one element matching "div.body"
const divBody = document.querySelectorAll("div.body");
const body = divBody.length ? divBody[0] : document.querySelector("body");
window.setTimeout(() => {
terms.forEach((term) => _highlightText(body, term, "highlighted"));
}, 10);
const searchBox = document.getElementById("searchbox");
if (searchBox === null) return;
searchBox.appendChild(
document
.createRange()
.createContextualFragment(
'<p class="highlight-link">' +
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
_("Hide Search Matches") +
"</a></p>"
)
);
},
/**
* helper function to hide the search marks again
*/
hideSearchWords: () => {
document
.querySelectorAll("#searchbox .highlight-link")
.forEach((el) => el.remove());
document
.querySelectorAll("span.highlighted")
.forEach((el) => el.classList.remove("highlighted"));
localStorage.removeItem("sphinx_highlight_terms")
},
initEscapeListener: () => {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
SphinxHighlight.hideSearchWords();
event.preventDefault();
}
});
},
};
_ready(() => {
/* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});

140
docs/html/appendix.html Normal file
View File

@ -0,0 +1,140 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>附录 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="gen api html &amp; pdf by sphinx" href="gen_api.html" />
<link rel="prev" title="netrans_py 使用" href="netrans_py.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="id1">
<h1>附录<a class="headerlink" href="#id1" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gen_api.html#rst">*.rst</a></li>
<li class="toctree-l2"><a class="reference internal" href="gen_api.html#autodoc-sphinx-python-api-html">使用 autodoc + Sphinx 实现 python api 文档(html)</a></li>
<li class="toctree-l2"><a class="reference internal" href="gen_api.html#autodoc-sphinx-python-api-pdf">使用 autodoc + Sphinx 实现 python api 文档(pdf)</a></li>
<li class="toctree-l2"><a class="reference internal" href="gen_api.html#id1">常见报错</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules.html">netrans_py</a><ul>
<li class="toctree-l2"><a class="reference internal" href="netrans.html">netrans module</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html">config module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dump.html">dump module</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html">example module</a></li>
<li class="toctree-l2"><a class="reference internal" href="export.html">export module</a></li>
<li class="toctree-l2"><a class="reference internal" href="file_model.html">file_model module</a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html">import_model module</a></li>
<li class="toctree-l2"><a class="reference internal" href="infer.html">infer module</a></li>
<li class="toctree-l2"><a class="reference internal" href="quantize.html">quantize module</a></li>
<li class="toctree-l2"><a class="reference internal" href="quantize_hb.html">quantize_hb module</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">utils module</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">附录</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="netrans_py.html" title="上一章">netrans_py 使用</a></li>
<li>Next: <a href="gen_api.html" title="下一章">gen api html &amp; pdf by sphinx</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/appendix.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

136
docs/html/config.html Normal file
View File

@ -0,0 +1,136 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>config module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="dump module" href="dump.html" />
<link rel="prev" title="netrans module" href="netrans.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-config">
<span id="config-module"></span><h1>config module<a class="headerlink" href="#module-config" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="config.Config">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">config.</span></span><span class="sig-name descname"><span class="pre">Config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/config.html#Config"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#config.Config" title="Link to this definition"></a></dt>
<dd><p>基类:<a class="reference internal" href="utils.html#utils.AttributeCopier" title="utils.AttributeCopier"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a></p>
<p>从实例化的 Netrans 中解析模型参数,并基于pnnacc 生成配置文件模板</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Netrans</strong> (<em>class</em>) -- 实例化的Netrans类,包含 模型信息 和 Netrans 信息</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="config.Config.inputmeta_gen">
<span class="sig-name descname"><span class="pre">inputmeta_gen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#config.Config.inputmeta_gen" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="netrans.html" title="上一章">netrans module</a></li>
<li>Next: <a href="dump.html" title="下一章">dump module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/config.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

119
docs/html/dump.html Normal file
View File

@ -0,0 +1,119 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>dump module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="example module" href="example.html" />
<link rel="prev" title="config module" href="config.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="dump-module">
<h1>dump module<a class="headerlink" href="#dump-module" title="Link to this heading"></a></h1>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="config.html" title="上一章">config module</a></li>
<li>Next: <a href="example.html" title="下一章">example module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/dump.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

124
docs/html/example.html Normal file
View File

@ -0,0 +1,124 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>example module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="export module" href="export.html" />
<link rel="prev" title="dump module" href="dump.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-example">
<span id="example-module"></span><h1>example module<a class="headerlink" href="#module-example" title="Link to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="example.main">
<span class="sig-prename descclassname"><span class="pre">example.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/example.html#main"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#example.main" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="dump.html" title="上一章">dump module</a></li>
<li>Next: <a href="export.html" title="下一章">export module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/example.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

141
docs/html/export.html Normal file
View File

@ -0,0 +1,141 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>export module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="file_model module" href="file_model.html" />
<link rel="prev" title="example module" href="example.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-export">
<span id="export-module"></span><h1>export module<a class="headerlink" href="#module-export" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="export.Export">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">export.</span></span><span class="sig-name descname"><span class="pre">Export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/export.html#Export"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#export.Export" title="Link to this definition"></a></dt>
<dd><p>基类:<a class="reference internal" href="utils.html#utils.AttributeCopier" title="utils.AttributeCopier"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a></p>
<p>从实例化的 Netrans 中解析模型参数,并基于 pnnacc 导出模型ngb文件</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Netrans</strong> (<em>class</em>) -- 实例化的Netrans类,包含 模型信息 和 Netrans 信息</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="export.Export.export_network">
<span class="sig-name descname"><span class="pre">export_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#export.Export.export_network" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="export.main">
<span class="sig-prename descclassname"><span class="pre">export.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/export.html#main"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#export.main" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="example.html" title="上一章">example module</a></li>
<li>Next: <a href="file_model.html" title="下一章">file_model module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/export.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

119
docs/html/file_model.html Normal file
View File

@ -0,0 +1,119 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>file_model module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="import_model module" href="import_model.html" />
<link rel="prev" title="export module" href="export.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-file_model">
<span id="file-model-module"></span><h1>file_model module<a class="headerlink" href="#module-file_model" title="Link to this heading"></a></h1>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="export.html" title="上一章">export module</a></li>
<li>Next: <a href="import_model.html" title="下一章">import_model module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/file_model.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

249
docs/html/gen_api.html Normal file
View File

@ -0,0 +1,249 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>gen api html &amp; pdf by sphinx &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="netrans_py" href="modules.html" />
<link rel="prev" title="附录" href="appendix.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="gen-api-html-pdf-by-sphinx">
<h1>gen api html &amp; pdf by sphinx<a class="headerlink" href="#gen-api-html-pdf-by-sphinx" title="Link to this heading"></a></h1>
<p>netrans 目录结构如下</p>
<div class="highlight-tree notranslate"><div class="highlight"><pre><span></span>netrans/
├── docs/ # Sphinx 项目的根目录
│ ├── source/ # 源文件目录
│ │ ├── _static/ # 静态文件如图片、CSS、JS
│ │ ├── _templates/ # 自定义模板
│ │ ├── conf.py # 配置文件
│ │ ├── index.rst # 主页文件
│ │ └── my_module.rst # 其他文档文件
│ └── build/ # 构建输出目录(生成的 HTML 文件等)
└── bin/
└── netrans_cli/
└── netrans_py/
</pre></div>
</div>
<ol class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sphinx-quickstart</span> <span class="pre">docs/</span></code> 快速生成</p></li>
<li><p>修改 <code class="docutils literal notranslate"><span class="pre">docs/source/conf.py</span></code> ,</p></li>
</ol>
<section id="rst">
<h2>*.rst<a class="headerlink" href="#rst" title="Link to this heading"></a></h2>
<p>rst, reStructuredText 文件用于定义文档的结构。通常放在source目录下。</p>
<p>rst 是一种和 markdown 类似的语法</p>
<p>使用目录树指令 <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">toctree::</span></code>,列出其他文档文件。</p>
</section>
<section id="autodoc-sphinx-python-api-html">
<h2>使用 autodoc + Sphinx 实现 python api 文档(html)<a class="headerlink" href="#autodoc-sphinx-python-api-html" title="Link to this heading"></a></h2>
<ol class="simple">
<li><p>修改 docs/source/conf.py</p></li>
</ol>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># Configuration file for the Sphinx documentation builder.</span>
<span class="c1">#</span>
<span class="c1"># For the full list of built-in configuration values, see the documentation:</span>
<span class="c1"># https://www.sphinx-doc.org/en/master/usage/configuration.html</span>
<span class="c1"># -- Project information -----------------------------------------------------</span>
<span class="c1"># https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information</span>
<span class="n">project</span> <span class="o">=</span> <span class="s1">&#39;netrans&#39;</span>
<span class="n">copyright</span> <span class="o">=</span> <span class="s1">&#39;2025, ccyh&#39;</span>
<span class="n">author</span> <span class="o">=</span> <span class="s1">&#39;xj&#39;</span>
<span class="n">release</span> <span class="o">=</span> <span class="s1">&#39;0.1&#39;</span>
<span class="c1"># -- General configuration ---------------------------------------------------</span>
<span class="c1"># https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../../netrans_py/&#39;</span><span class="p">)</span>
<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../../&#39;</span><span class="p">)</span>
<span class="c1"># Sphinx 扩展</span>
<span class="n">extensions</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;sphinx.ext.autodoc&#39;</span><span class="p">,</span> <span class="c1"># 自动生成文档</span>
<span class="s1">&#39;sphinx.ext.viewcode&#39;</span><span class="p">,</span> <span class="c1"># 添加源代码链接</span>
<span class="s1">&#39;sphinx.ext.napoleon&#39;</span><span class="p">,</span> <span class="c1"># 支持 NumPy 和 Google 风格的 docstring</span>
<span class="p">]</span>
<span class="c1"># 主题</span>
<span class="n">html_theme</span> <span class="o">=</span> <span class="s1">&#39;sphinx_rtd_theme&#39;</span>
<span class="n">templates_path</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;_templates&#39;</span><span class="p">]</span>
<span class="n">exclude_patterns</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">language</span> <span class="o">=</span> <span class="s1">&#39;zh&#39;</span>
<span class="c1"># -- Options for HTML output -------------------------------------------------</span>
<span class="c1"># https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output</span>
<span class="n">html_theme</span> <span class="o">=</span> <span class="s1">&#39;alabaster&#39;</span>
<span class="n">html_static_path</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;_static&#39;</span><span class="p">]</span>
<span class="n">source_suffix</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;.rst&#39;</span><span class="p">:</span> <span class="s1">&#39;restructuredtext&#39;</span><span class="p">,</span>
<span class="s1">&#39;.md&#39;</span><span class="p">:</span> <span class="s1">&#39;markdown&#39;</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
<ol class="simple">
<li><p>sphinx-apidoc -o docs/source/ .
生成 netrans_py 下所有的 *.py 的rst, 并添加到index.rst里.</p></li>
</ol>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span># index.rst
</pre></div>
</div>
<ol class="simple">
<li><p>sphinx-build -b html docs/source docs/build</p></li>
</ol>
</section>
<section id="autodoc-sphinx-python-api-pdf">
<h2>使用 autodoc + Sphinx 实现 python api 文档(pdf)<a class="headerlink" href="#autodoc-sphinx-python-api-pdf" title="Link to this heading"></a></h2>
<ol class="simple">
<li><p>在可以生成 html的 基础上, 使用make latexodf 生成 *.tex文件.
这一步会报错,原因是无法识别中文</p></li>
</ol>
<p>2.修改 netrans.tex文件</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">build</span><span class="o">/</span><span class="n">latex</span>
<span class="n">vim</span> <span class="n">netrans</span><span class="o">.</span><span class="n">tex</span>
</pre></div>
</div>
<p>在各种usapackage的地方新增:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>\<span class="n">usepackage</span><span class="p">[</span><span class="n">UTF8</span><span class="p">,</span> <span class="n">fontset</span><span class="o">=</span><span class="n">ubuntu</span><span class="p">]{</span><span class="n">ctex</span><span class="p">}</span>
</pre></div>
</div>
<ol class="simple">
<li><p>使用 xelatex 生成pdf
sphinx使用的是 xelatex 而非 pdflatex</p></li>
</ol>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">xelatex</span> <span class="n">netrans</span><span class="o">.</span><span class="n">tex</span>
</pre></div>
</div>
</section>
<section id="id1">
<h2>常见报错<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<p>报错</p>
<div class="highlight-log notranslate"><div class="highlight"><pre><span></span>sphinx-quickstart
Traceback (most recent call last):
File &quot;/home/xj/app/miniforge3/envs/sphinx/bin/sphinx-quickstart&quot;, line 8, in &lt;module&gt;
sys.exit(main())
File &quot;/home/xj/app/miniforge3/envs/sphinx/lib/python3.10/site-packages/sphinx/cmd/quickstart.py&quot;, line 721, in main
locale.setlocale(locale.LC_ALL, &#39;&#39;)
File &quot;/home/xj/app/miniforge3/envs/sphinx/lib/python3.10/locale.py&quot;, line 620, in setlocale
return _setlocale(category, locale)
locale.Error: unsupported locale setting
</pre></div>
</div>
<p>解决:
export LC_ALL=en_US.UTF-8</p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li>Previous: <a href="appendix.html" title="上一章">附录</a></li>
<li>Next: <a href="modules.html" title="下一章">netrans_py</a></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/gen_api.md.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

341
docs/html/genindex.html Normal file
View File

@ -0,0 +1,341 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>索引 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="#" />
<link rel="search" title="搜索" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="index">索引</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#U"><strong>U</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="utils.html#utils.AttributeCopier">AttributeCopierutils 中的类)</a>
</li>
</ul></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="utils.html#utils.check_dir">check_dir()(在 utils 模块中)</a>
</li>
<li><a href="utils.html#utils.check_env">check_env()(在 utils 模块中)</a>
</li>
<li><a href="utils.html#utils.check_netrans">check_netrans()(在 utils 模块中)</a>
</li>
<li><a href="utils.html#utils.check_path">check_path()(在 utils 模块中)</a>
</li>
<li><a href="import_model.html#import_model.check_status">check_status()(在 import_model 模块中)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
config
<ul>
<li><a href="config.html#module-config">module</a>
</li>
</ul></li>
<li><a href="config.html#config.Config">Configconfig 中的类)</a>
</li>
<li><a href="utils.html#utils.AttributeCopier.copy_attribute_name">copy_attribute_name() utils.AttributeCopier 方法)</a>
</li>
<li><a href="utils.html#utils.create_cls">create_clsutils 中的类)</a>
</li>
</ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
example
<ul>
<li><a href="example.html#module-example">module</a>
</li>
</ul></li>
<li>
export
<ul>
<li><a href="export.html#module-export">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="export.html#export.Export.export_network">export_network() export.Export 方法)</a>
</li>
<li><a href="export.html#export.Export">Exportexport 中的类)</a>
</li>
</ul></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
file_model
<ul>
<li><a href="file_model.html#module-file_model">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="import_model.html#import_model.import_caffe_network">import_caffe_network()(在 import_model 模块中)</a>
</li>
<li><a href="import_model.html#import_model.import_darknet_network">import_darknet_network()(在 import_model 模块中)</a>
</li>
<li>
import_model
<ul>
<li><a href="import_model.html#module-import_model">module</a>
</li>
</ul></li>
<li><a href="import_model.html#import_model.ImportModel.import_network">import_network() import_model.ImportModel 方法)</a>
</li>
<li><a href="import_model.html#import_model.import_onnx_network">import_onnx_network()(在 import_model 模块中)</a>
</li>
<li><a href="import_model.html#import_model.import_pytorch_network">import_pytorch_network()(在 import_model 模块中)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="import_model.html#import_model.import_tensorflow_network">import_tensorflow_network()(在 import_model 模块中)</a>
</li>
<li><a href="import_model.html#import_model.import_tflite_network">import_tflite_network()(在 import_model 模块中)</a>
</li>
<li><a href="import_model.html#import_model.ImportModel">ImportModelimport_model 中的类)</a>
</li>
<li>
infer
<ul>
<li><a href="infer.html#module-infer">module</a>
</li>
</ul></li>
<li><a href="infer.html#infer.Infer.inference_network">inference_network() infer.Infer 方法)</a>
</li>
<li><a href="infer.html#infer.Infer">Inferinfer 中的类)</a>
</li>
<li><a href="config.html#config.Config.inputmeta_gen">inputmeta_gen() config.Config 方法)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="example.html#example.main">main()(在 example 模块中)</a>
</li>
<li><a href="export.html#export.main">main()(在 export 模块中)</a>
</li>
<li><a href="infer.html#infer.main">main()(在 infer 模块中)</a>
</li>
<li><a href="quantize_hb.html#quantize_hb.main">main()(在 quantize_hb 模块中)</a>
</li>
<li>
module
<ul>
<li><a href="config.html#module-config">config</a>
</li>
<li><a href="example.html#module-example">example</a>
</li>
<li><a href="export.html#module-export">export</a>
</li>
<li><a href="file_model.html#module-file_model">file_model</a>
</li>
<li><a href="import_model.html#module-import_model">import_model</a>
</li>
<li><a href="infer.html#module-infer">infer</a>
</li>
<li><a href="netrans.html#module-netrans">netrans</a>
</li>
<li><a href="quantize.html#module-quantize">quantize</a>
</li>
<li><a href="quantize_hb.html#module-quantize_hb">quantize_hb</a>
</li>
<li><a href="utils.html#module-utils">utils</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
netrans
<ul>
<li><a href="netrans.html#module-netrans">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
quantize
<ul>
<li><a href="quantize.html#module-quantize">module</a>
</li>
</ul></li>
<li>
quantize_hb
<ul>
<li><a href="quantize_hb.html#module-quantize_hb">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="quantize.html#quantize.Quantize.quantize_network">quantize_network() quantize.Quantize 方法)</a>
</li>
<li><a href="quantize_hb.html#quantize_hb.Quantize.quantize_network">quantize_network() quantize_hb.Quantize 方法)</a>
</li>
<li><a href="quantize.html#quantize.Quantize">Quantizequantize 中的类)</a>
</li>
<li><a href="quantize_hb.html#quantize_hb.Quantize">Quantizequantize_hb 中的类)</a>
</li>
</ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="utils.html#utils.remove_history_file">remove_history_file()(在 utils 模块中)</a>
</li>
</ul></td>
</tr></table>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
utils
<ul>
<li><a href="utils.html#module-utils">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

267
docs/html/import_model.html Normal file
View File

@ -0,0 +1,267 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>import_model module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="infer module" href="infer.html" />
<link rel="prev" title="file_model module" href="file_model.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-import_model">
<span id="import-model-module"></span><h1>import_model module<a class="headerlink" href="#module-import_model" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="import_model.ImportModel">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">ImportModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#ImportModel"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.ImportModel" title="Link to this definition"></a></dt>
<dd><p>基类:<a class="reference internal" href="utils.html#utils.AttributeCopier" title="utils.AttributeCopier"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a></p>
<p>从实例化的 Netrans 中解析模型参数,并基于 pnnacc 导入模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>Netrans</strong> (<em>class</em>) -- 实例化的Netrans类,包含 模型信息 和 Netrans 信息</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="import_model.ImportModel.import_network">
<span class="sig-name descname"><span class="pre">import_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#import_model.ImportModel.import_network" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.check_status">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">check_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#check_status"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.check_status" title="Link to this definition"></a></dt>
<dd><p>解析命令执行情况</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>result</strong> (<em>return</em><em> of </em><em>subprocrss.run</em>) -- subprocess.run的返回值</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.import_caffe_network">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">import_caffe_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#import_caffe_network"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.import_caffe_network" title="Link to this definition"></a></dt>
<dd><p>导入 caffe 模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) -- 模型名字</p></li>
<li><p><strong>netrans_path</strong> (<em>str</em>) -- 模型路径</p></li>
</ul>
</dd>
<dt class="field-even">返回<span class="colon">:</span></dt>
<dd class="field-even"><p>生成的pnnacc 命令行, 被subprocesses执行</p>
</dd>
<dt class="field-odd">返回类型<span class="colon">:</span></dt>
<dd class="field-odd"><p>cmd (str)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.import_darknet_network">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">import_darknet_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#import_darknet_network"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.import_darknet_network" title="Link to this definition"></a></dt>
<dd><p>导入 darknet 模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) -- 模型名字</p></li>
<li><p><strong>netrans_path</strong> (<em>str</em>) -- 模型路径</p></li>
</ul>
</dd>
<dt class="field-even">返回<span class="colon">:</span></dt>
<dd class="field-even"><p>生成的pnnacc 命令行, 被subprocesses执行</p>
</dd>
<dt class="field-odd">返回类型<span class="colon">:</span></dt>
<dd class="field-odd"><p>cmd (str)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.import_onnx_network">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">import_onnx_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#import_onnx_network"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.import_onnx_network" title="Link to this definition"></a></dt>
<dd><p>导入 onnx 模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) -- 模型名字</p></li>
<li><p><strong>netrans_path</strong> (<em>str</em>) -- 模型路径</p></li>
</ul>
</dd>
<dt class="field-even">返回<span class="colon">:</span></dt>
<dd class="field-even"><p>生成的pnnacc 命令行, 被subprocesses执行</p>
</dd>
<dt class="field-odd">返回类型<span class="colon">:</span></dt>
<dd class="field-odd"><p>cmd (str)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.import_pytorch_network">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">import_pytorch_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#import_pytorch_network"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.import_pytorch_network" title="Link to this definition"></a></dt>
<dd><p>导入 pytorch 模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) -- 模型名字</p></li>
<li><p><strong>netrans_path</strong> (<em>str</em>) -- 模型路径</p></li>
</ul>
</dd>
<dt class="field-even">返回<span class="colon">:</span></dt>
<dd class="field-even"><p>生成的pnnacc 命令行, 被subprocesses执行</p>
</dd>
<dt class="field-odd">返回类型<span class="colon">:</span></dt>
<dd class="field-odd"><p>cmd (str)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.import_tensorflow_network">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">import_tensorflow_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#import_tensorflow_network"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.import_tensorflow_network" title="Link to this definition"></a></dt>
<dd><p>导入 tensorflow 模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) -- 模型名字</p></li>
<li><p><strong>netrans_path</strong> (<em>str</em>) -- 模型路径</p></li>
</ul>
</dd>
<dt class="field-even">返回<span class="colon">:</span></dt>
<dd class="field-even"><p>生成的pnnacc 命令行, 被subprocesses执行</p>
</dd>
<dt class="field-odd">返回类型<span class="colon">:</span></dt>
<dd class="field-odd"><p>cmd (str)</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="import_model.import_tflite_network">
<span class="sig-prename descclassname"><span class="pre">import_model.</span></span><span class="sig-name descname"><span class="pre">import_tflite_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/import_model.html#import_tflite_network"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#import_model.import_tflite_network" title="Link to this definition"></a></dt>
<dd><p>导入 tflite 模型</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> (<em>str</em>) -- 模型名字</p></li>
<li><p><strong>netrans_path</strong> (<em>str</em>) -- 模型路径</p></li>
</ul>
</dd>
<dt class="field-even">返回<span class="colon">:</span></dt>
<dd class="field-even"><p>生成的pnnacc 命令行, 被subprocesses执行</p>
</dd>
<dt class="field-odd">返回类型<span class="colon">:</span></dt>
<dd class="field-odd"><p>cmd (str)</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="file_model.html" title="上一章">file_model module</a></li>
<li>Next: <a href="infer.html" title="下一章">infer module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/import_model.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

145
docs/html/index.html Normal file
View File

@ -0,0 +1,145 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>netrans documentation &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="快速入门" href="quick_start_guide.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="netrans-documentation">
<h1>netrans documentation<a class="headerlink" href="#netrans-documentation" title="Link to this heading"></a></h1>
<p>netrans 是一套针对pnna 芯片的模型处理工具,提供命令行工具 netrans_cli 和 python api netrans_py 其核心功能是将模型权重转换成在pnna芯片上运行的 nbgnetwork binary graph格式.nb 为后缀)。</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="quick_start_guide.html">快速入门</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#id2">系统环境</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#netrans">安装Netrans</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_start_guide.html#netrans-yolov5s">使用 Netrans 编译 yolov5s 模型</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a><ul>
<li class="toctree-l2"><a class="reference internal" href="netrans_cli.html#id1">netrans_cli 脚本</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_cli.html#load-sh">load.sh 模型导入</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_cli.html#config-sh">config.sh 预处理配置文件生成</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_cli.html#quantize-sh">quantize.sh 模型量化</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_cli.html#export-sh">export.sh 模型导出</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_cli.html#id2">使用示例</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a><ul>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#netrans">Netrans 类</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#netrans-import">Netrans.import 模型导入</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#netrans-config">Netrans.config 预处理配置文件生成</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#netrans-quantize">Netrans.quantize 模型量化</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#netrans-export">Netrans.export 模型导出</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#netrans-model2nbg-nbg">Netrans.model2nbg 模型生成nbg文件</a></li>
<li class="toctree-l2"><a class="reference internal" href="netrans_py.html#id1">使用示例</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="quick_start_guide.html" title="下一章">快速入门</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

135
docs/html/infer.html Normal file
View File

@ -0,0 +1,135 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>infer module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="quantize module" href="quantize.html" />
<link rel="prev" title="import_model module" href="import_model.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-infer">
<span id="infer-module"></span><h1>infer module<a class="headerlink" href="#module-infer" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="infer.Infer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">infer.</span></span><span class="sig-name descname"><span class="pre">Infer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/infer.html#Infer"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#infer.Infer" title="Link to this definition"></a></dt>
<dd><p>基类:<a class="reference internal" href="utils.html#utils.AttributeCopier" title="utils.AttributeCopier"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="infer.Infer.inference_network">
<span class="sig-name descname"><span class="pre">inference_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#infer.Infer.inference_network" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="infer.main">
<span class="sig-prename descclassname"><span class="pre">infer.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/infer.html#main"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#infer.main" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="import_model.html" title="上一章">import_model module</a></li>
<li>Next: <a href="quantize.html" title="下一章">quantize module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/infer.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

193
docs/html/modules.html Normal file
View File

@ -0,0 +1,193 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>netrans_py &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="netrans module" href="netrans.html" />
<link rel="prev" title="gen api html &amp; pdf by sphinx" href="gen_api.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="netrans-py">
<h1>netrans_py<a class="headerlink" href="#netrans-py" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="netrans.html">netrans module</a></li>
<li class="toctree-l1"><a class="reference internal" href="config.html">config module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="config.html#config.Config"><code class="docutils literal notranslate"><span class="pre">Config</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="config.html#config.Config.inputmeta_gen"><code class="docutils literal notranslate"><span class="pre">Config.inputmeta_gen()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dump.html">dump module</a></li>
<li class="toctree-l1"><a class="reference internal" href="example.html">example module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="example.html#example.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="export.html">export module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="export.html#export.Export"><code class="docutils literal notranslate"><span class="pre">Export</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="export.html#export.Export.export_network"><code class="docutils literal notranslate"><span class="pre">Export.export_network()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="export.html#export.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="file_model.html">file_model module</a></li>
<li class="toctree-l1"><a class="reference internal" href="import_model.html">import_model module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.ImportModel"><code class="docutils literal notranslate"><span class="pre">ImportModel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="import_model.html#import_model.ImportModel.import_network"><code class="docutils literal notranslate"><span class="pre">ImportModel.import_network()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.check_status"><code class="docutils literal notranslate"><span class="pre">check_status()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.import_caffe_network"><code class="docutils literal notranslate"><span class="pre">import_caffe_network()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.import_darknet_network"><code class="docutils literal notranslate"><span class="pre">import_darknet_network()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.import_onnx_network"><code class="docutils literal notranslate"><span class="pre">import_onnx_network()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.import_pytorch_network"><code class="docutils literal notranslate"><span class="pre">import_pytorch_network()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.import_tensorflow_network"><code class="docutils literal notranslate"><span class="pre">import_tensorflow_network()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="import_model.html#import_model.import_tflite_network"><code class="docutils literal notranslate"><span class="pre">import_tflite_network()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="infer.html">infer module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="infer.html#infer.Infer"><code class="docutils literal notranslate"><span class="pre">Infer</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="infer.html#infer.Infer.inference_network"><code class="docutils literal notranslate"><span class="pre">Infer.inference_network()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="infer.html#infer.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quantize.html">quantize module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quantize.html#quantize.Quantize"><code class="docutils literal notranslate"><span class="pre">Quantize</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="quantize.html#quantize.Quantize.quantize_network"><code class="docutils literal notranslate"><span class="pre">Quantize.quantize_network()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quantize_hb.html">quantize_hb module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quantize_hb.html#quantize_hb.Quantize"><code class="docutils literal notranslate"><span class="pre">Quantize</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="quantize_hb.html#quantize_hb.Quantize.quantize_network"><code class="docutils literal notranslate"><span class="pre">Quantize.quantize_network()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="quantize_hb.html#quantize_hb.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">utils module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.AttributeCopier"><code class="docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="utils.html#utils.AttributeCopier.copy_attribute_name"><code class="docutils literal notranslate"><span class="pre">AttributeCopier.copy_attribute_name()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.check_dir"><code class="docutils literal notranslate"><span class="pre">check_dir()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.check_env"><code class="docutils literal notranslate"><span class="pre">check_env()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.check_netrans"><code class="docutils literal notranslate"><span class="pre">check_netrans()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.check_path"><code class="docutils literal notranslate"><span class="pre">check_path()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.create_cls"><code class="docutils literal notranslate"><span class="pre">create_cls</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html#utils.remove_history_file"><code class="docutils literal notranslate"><span class="pre">remove_history_file()</span></code></a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li>Previous: <a href="gen_api.html" title="上一章">gen api html &amp; pdf by sphinx</a></li>
<li>Next: <a href="netrans.html" title="下一章">netrans module</a></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/modules.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

119
docs/html/netrans.html Normal file
View File

@ -0,0 +1,119 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>netrans module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="config module" href="config.html" />
<link rel="prev" title="netrans_py" href="modules.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-netrans">
<span id="netrans-module"></span><h1>netrans module<a class="headerlink" href="#module-netrans" title="Link to this heading"></a></h1>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="modules.html" title="上一章">netrans_py</a></li>
<li>Next: <a href="config.html" title="下一章">config module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/netrans.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

318
docs/html/netrans_cli.html Normal file
View File

@ -0,0 +1,318 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>netrans_cli 使用 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="netrans_py 使用" href="netrans_py.html" />
<link rel="prev" title="快速入门" href="quick_start_guide.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="netrans-cli">
<h1>netrans_cli 使用<a class="headerlink" href="#netrans-cli" title="Link to this heading"></a></h1>
<p>netrans_cli 是 netrans 进行模型转换的命令行工具,使用 ntrans_cli 完成模型转换的步骤如下:</p>
<ol class="simple">
<li><p>导入模型</p></li>
<li><p>生成并修改前处理配置文件 *_inputmeta.yml</p></li>
<li><p>量化模型</p></li>
<li><p>导出模型</p></li>
</ol>
<section id="id1">
<h2>netrans_cli 脚本<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<table border="1" class="docutils">
<thead>
<tr>
<th style="text-align: left;">脚本</th>
<th>功能</th>
<th>使用</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">load.sh</td>
<td>模型导入功能,将模型转换成 Pnna 支持的格式</td>
<td>load.sh model_name</td>
</tr>
<tr>
<td style="text-align: left;">config.sh</td>
<td>预处理模版生成功能,生成预处理模版,根据模型进行对于的修改</td>
<td>config.sh model_name</td>
</tr>
<tr>
<td style="text-align: left;">quantize.sh</td>
<td>量化功能, 对模型进行量化生成量化参数文件</td>
<td>quantize.sh model_name quantize_data_type</td>
</tr>
<tr>
<td style="text-align: left;">export.sh</td>
<td>导出功能,将量化好的模型导出成 Pnna 上可以运行的runtime</td>
<td>export.sh model_name quantize_data_type</td>
</tr>
</tbody>
</table><p><font color="#dd0000">对于不同框架下训练的模型,需要准备不同的数据,所有的数据都需要与模型放在同一个文件夹下,模型文件名和文件夹名需要保持一致。</font></p>
</section>
<section id="load-sh">
<h2>load.sh 模型导入<a class="headerlink" href="#load-sh" title="Link to this heading"></a></h2>
<p>使用 load.sh 导入模型</p>
<ul>
<li><p>用法: load.sh 以模型文件名命名的模型数据文件夹,例如:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>load.sh<span class="w"> </span>lenet
</pre></div>
</div>
<p>&quot;lenet&quot;是文件夹名也作为模型名和权重文件名。导入会打印相关日志信息成功后会打印SUCESS。导入后lenet文件夹应该有&quot;lenet.json&quot;&quot;lenet.data&quot;文件:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>ls<span class="w"> </span>-lrt<span class="w"> </span>lenet
total<span class="w"> </span><span class="m">3396</span>
-rwxr-xr-x<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">1727201</span><span class="w"> </span>Nov<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2018</span><span class="w"> </span>lenet.pb
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">553</span><span class="w"> </span>Nov<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2018</span><span class="w"> </span><span class="m">0</span>.jpg
-rwxr--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">6</span><span class="w"> </span>Apr<span class="w"> </span><span class="m">21</span><span class="w"> </span><span class="m">17</span>:04<span class="w"> </span>dataset.txt
-rw-rw-r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">69</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:19<span class="w"> </span>inputs_outputs.txt
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">5553</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:21<span class="w"> </span>lenet.json
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">1725178</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:21<span class="w"> </span>lenet.data
</pre></div>
</div>
</li>
</ul>
</section>
<section id="config-sh">
<h2>config.sh 预处理配置文件生成<a class="headerlink" href="#config-sh" title="Link to this heading"></a></h2>
<p>使用 config.sh 生成 inputmeta 文件</p>
<ul>
<li><p>config.sh 以模型文件名命名的模型数据文件夹,例如:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>config.sh<span class="w"> </span>lenet
</pre></div>
</div>
<p>inputmeta 文件生成会打印相关日志信息成功后会打印SUCESS。导入后lenet文件夹应该有 &quot;lenet_inputmeta.yml&quot; 文件:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>$<span class="w"> </span>ls<span class="w"> </span>-lrt<span class="w"> </span>lenet
total<span class="w"> </span><span class="m">3400</span>
-rwxr-xr-x<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">1727201</span><span class="w"> </span>Nov<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2018</span><span class="w"> </span>lenet.pb
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">553</span><span class="w"> </span>Nov<span class="w"> </span><span class="m">5</span><span class="w"> </span><span class="m">2018</span><span class="w"> </span><span class="m">0</span>.jpg
-rwxr--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">6</span><span class="w"> </span>Apr<span class="w"> </span><span class="m">21</span><span class="w"> </span><span class="m">17</span>:04<span class="w"> </span>dataset.txt
-rw-rw-r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">69</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:19<span class="w"> </span>inputs_outputs.txt
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">5553</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:21<span class="w"> </span>lenet.json
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">1725178</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:21<span class="w"> </span>lenet.data
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">948</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:35<span class="w"> </span>lenet_inputmeta.yml
</pre></div>
</div>
<p>可以看到,最终生成的是*.yml文件该文件用于为Netrans中间模型配置输入层数据集合。<b>Netrans中的量化、推理、导出和图片转dat的操作都需要用到这个文件。因此此步骤不可跳过。</b></p>
</li>
</ul>
<p>Inputmeta.yml文件结构如下</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">%YAML</span><span class="w"> </span><span class="m">1.2</span>
<span class="nn">---</span>
<span class="c1"># !!!This file disallow TABs!!!</span>
<span class="c1"># &quot;category&quot; allowed values: &quot;image, undefined&quot;</span>
<span class="c1"># &quot;database&quot; allowed types: &quot;H5FS, SQLITE, TEXT, LMDB, NPY, GENERATOR&quot;</span>
<span class="c1"># &quot;tensor_name&quot; only support in H5FS database</span>
<span class="c1"># &quot;preproc_type&quot; allowed types:&quot;IMAGE_RGB, IMAGE_RGB888_PLANAR, IMAGE_RGB888_PLANAR_SEP, </span>
<span class="l l-Scalar l-Scalar-Plain">IMAGE_I420,</span><span class="w"> </span>
<span class="l l-Scalar l-Scalar-Plain"># IMAGE_NV12, IMAGE_YUV444, IMAGE_GRAY, IMAGE_BGRA, TENSOR&quot;</span>
<span class="l l-Scalar l-Scalar-Plain">input_meta</span><span class="p p-Indicator">:</span>
<span class="w"> </span><span class="nt">databases</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dataset.txt</span>
<span class="w"> </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">TEXT</span>
<span class="w"> </span><span class="nt">ports</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">lid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">data_0</span>
<span class="w"> </span><span class="nt">category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">image</span>
<span class="w"> </span><span class="nt">dtype</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">float32</span>
<span class="w"> </span><span class="nt">sparse</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">tensor_name</span><span class="p">:</span>
<span class="w"> </span><span class="nt">layout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nhwc</span>
<span class="w"> </span><span class="nt">shape</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">50</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">224</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">224</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span>
<span class="w"> </span><span class="nt">preprocess</span><span class="p">:</span>
<span class="w"> </span><span class="nt">reverse_channel</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">mean</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">103.94</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">116.78</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">123.67</span>
<span class="w"> </span><span class="nt">scale</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0.017</span>
<span class="w"> </span><span class="nt">preproc_node_params</span><span class="p">:</span>
<span class="w"> </span><span class="nt">preproc_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">IMAGE_RGB</span>
<span class="w"> </span><span class="nt">add_preproc_node</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="w"> </span><span class="nt">preproc_perm</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">lid</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">label_0</span>
<span class="w"> </span><span class="nt">redirect_to_output</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class="w"> </span><span class="nt">category</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">undefined</span>
<span class="w"> </span><span class="nt">tensor_name</span><span class="p">:</span>
<span class="w"> </span><span class="nt">dtype</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">float32</span>
<span class="w"> </span><span class="nt">shape</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span>
</pre></div>
</div>
<p>上面示例文件的各个参数解释:</p>
<div class="highlight-{table} notranslate"><div class="highlight"><pre><span></span>:widths: 20, 80
:align: left
| 参数 | 说明 |
| :--- | --- |
| input_meta | 预处理参数配置申明。 |
| databases | 数据配置,包括设置 path、type 和 ports 。|
| path | 数据集文件的相对(执行目录)或绝对路径。默认为 dataset.txt, 不建议修改。 |
| type | 数据集文件格式固定为TEXT。 |
| ports | 指向网络中的输入或重定向的输入,目前只支持一个输入,如果网络存在多个输入,请与@ccyh联系。 |
| lid | 输入层的lid |
| category | 输入的类别。将此参数设置为以下值之一image图像输入或 undefined其他类型的输入。 |
| dtype | 输入张量的数据类型,用于将数据发送到 Pnna 网络的输入端口。支持的数据类型包括 float32 和 quantized。 |
| sparse | 指定网络张量是否以稀疏格式存在。将此参数设置为以下值之一true稀疏格式或 false压缩格式。 |
| tensor_name | 留空此参数 |
| layout | 输入张量的格式,使用 nchw 用于 Caffe、Darknet、ONNX 和 PyTorch 模型。使用 nhwc 用于 TensorFlow、TensorFlow Lite 和 Keras 模型。 |
| shape | 此张量的形状。第一维shape[0]表示每批的输入数量允许在一次推理操作之前将多个输入发送到网络。如果batch维度设置为0则需要从命令行指定--batch-size。如果 batch维度设置为大于1的值则直接使用inputmeta.yml中的batch size并忽略命令行中的--batch-size。 |
| fitting | 保留字段 |
| preprocess | 预处理步骤和顺序。预处理支持下面的四个键,键的顺序代表预处理的顺序。您可以相应地调整顺序。 |
| reverse_channel | 指定是否保留通道顺序。将此参数设置为以下值之一true保留通道顺序或 false不保留通道顺序。对于 TensorFlow 和 TensorFlow Lite 框架的模型使用 true。 |
| mean | 用于每个通道的均值。 |
| scale | 张量的缩放值。均值和缩放值用于根据公式 (inputTensor - mean) × scale 归一化输入张量。|
| preproc_node_params | 预处理节点参数,在 OVxlib C 项目案例中启用预处理任务 |
| add_preproc_node | 用于处理 OVxlib C 项目案例中预处理节点的插入。[true, false] 中的布尔值,表示通过配置以下参数将预处理层添加到导出的应用程序中。此参数仅在 add_preproc_node 参数设置为 true 时有效。|
| preproc_type | 预处理节点输入类型。 [IMAGE_RGB, IMAGE_RGB888_PLANAR,IMAGE_YUV420, IMAGE_GRAY, IMAGE_BGRA, TENSOR] 中的字符串值 |
| preproc_perm | 预处理节点输入的置换参数。 |
| redirect_to_output | 将database张量重定向到图形输出的特殊属性。如果为该属性设置了一个port网络构建器将自动为该port生成一个输出层以便后处理文件可以直接处理来自database的张量。 如果使用网络进行分类则上例中的lid“input_0”表示输入数据集的标签lid。 您可以设置其他名称来表示标签的lid。 请注意redirect_to_output 必须设置为 true以便后处理文件可以直接处理来自database的张量。 标签的lid必须与后处理文件中定义的 labels_tensor 的lid相同。 [true, false] 中的布尔值。 指定是否将由张量表示的输入端口的数据直接发送到网络输出。true直接发送到网络输出或 false不直接发送到网络输出|
</pre></div>
</div>
<p>可以根据实际情况对生成的inputmeta文件进行修改。</p>
</section>
<section id="quantize-sh">
<h2>quantize.sh 模型量化<a class="headerlink" href="#quantize-sh" title="Link to this heading"></a></h2>
<p>如果我们训练好的模型的数据类型是float32的为了使模型以更高的效率在Pnna上运行我们可以对模型进行量化操作量化操作可能会带来一定程度的精度损失。</p>
<ul class="simple">
<li><p>在netrans_cli目录下使用quantize.sh脚本进行量化操作。</p></li>
</ul>
<p>用法:./quantize.sh 以模型文件名命名的模型数据文件夹 量化类型,例如:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>quantize.sh<span class="w"> </span>lenet<span class="w"> </span>uint8
</pre></div>
</div>
<p>支持的量化类型有uint8、int8、int16</p>
</section>
<section id="export-sh">
<h2>export.sh 模型导出<a class="headerlink" href="#export-sh" title="Link to this heading"></a></h2>
<p>使用 export.sh 导出模型生成nbg文件。</p>
<p>用法export.sh 以模型文件名命名的模型数据文件夹 数据类型,例如:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>export.sh<span class="w"> </span>lenet<span class="w"> </span>uint8
</pre></div>
</div>
<p>导出支持的数据类型float、uint8、int8、int16其中使用uint8、int8、int16导出时需要先进行模型量化。导出的工程会在模型所在的目录下面的wksp目录里。
network_binary.nb文件在&quot;asymmetric_affine&quot;文件夹中:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ls<span class="w"> </span>-lrt<span class="w"> </span>lenet/wksp/asymmetric_affine/
-rw-r--r--<span class="w"> </span><span class="m">1</span><span class="w"> </span>hope<span class="w"> </span>hope<span class="w"> </span><span class="m">694912</span><span class="w"> </span>Jun<span class="w"> </span><span class="m">7</span><span class="w"> </span><span class="m">09</span>:55<span class="w"> </span>network_binary.nb
</pre></div>
</div>
<p>目前支持将生成的network_binary.nb文件部署到Pnna硬件平台。具体部署方法请参阅模型部署相关文档。</p>
</section>
<section id="id2">
<h2>使用示例<a class="headerlink" href="#id2" title="Link to this heading"></a></h2>
<p>请参照examplesexamples 提供 <a class="reference external" href="./examples/caffe_model">caffe 模型转换示例</a>,<a class="reference external" href="./examples/darknet_model">darknet 模型转换示例</a>,<a class="reference external" href="./examples/tensorflow_model">tensorflow 模型转换示例</a>,<a class="reference external" href="./examples/onnx_model">onnx 模型转换示例</a></p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">netrans_cli 使用</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">netrans_cli 脚本</a></li>
<li class="toctree-l2"><a class="reference internal" href="#load-sh">load.sh 模型导入</a></li>
<li class="toctree-l2"><a class="reference internal" href="#config-sh">config.sh 预处理配置文件生成</a></li>
<li class="toctree-l2"><a class="reference internal" href="#quantize-sh">quantize.sh 模型量化</a></li>
<li class="toctree-l2"><a class="reference internal" href="#export-sh">export.sh 模型导出</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">使用示例</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="quick_start_guide.html" title="上一章">快速入门</a></li>
<li>Next: <a href="netrans_py.html" title="下一章">netrans_py 使用</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/netrans_cli.md.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

276
docs/html/netrans_py.html Normal file
View File

@ -0,0 +1,276 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>netrans_py 使用 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="附录" href="appendix.html" />
<link rel="prev" title="netrans_cli 使用" href="netrans_cli.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="netrans-py">
<h1>netrans_py 使用<a class="headerlink" href="#netrans-py" title="Link to this heading"></a></h1>
<p>netrans_py 为 Netrans 编译器的 python 调用接口。
使用 ntrans_py 完成模型转换的步骤如下:</p>
<ol class="simple">
<li><p>导入模型</p></li>
<li><p>生成并修改前处理配置文件 *_inputmeta.yml</p></li>
<li><p>量化模型</p></li>
<li><p>导出模型</p></li>
</ol>
<section id="netrans">
<h2>Netrans 类<a class="headerlink" href="#netrans" title="Link to this heading"></a></h2>
<p>创建 Netrans</p>
<p>描述: 实例化 Netrans 类。
代码示例:</p>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">netrans</span><span class="w"> </span><span class="kn">import</span> <span class="n">Netrans</span>
<span class="n">yolo_netrans</span> <span class="o">=</span> <span class="n">Netrans</span><span class="p">(</span><span class="s2">&quot;../examples/darknet/yolov4_tiny&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>参数</p>
<table border="1" class="docutils">
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">model_path</td>
<td>str</td>
<td>第一位置参数,模型文件的路径</td>
</tr>
<tr>
<td style="text-align: left;">netans</td>
<td>str</td>
<td>如果 NETRANS_PATH 没有设置可通过该参数指定netrans的路径</td>
</tr>
</tbody>
</table><p>输出返回:
无。</p>
<!-- <font color="#dd0000">注意:</font> 模型目录准备需要和netrans_cli一致具体数据准备要求见[introduction](./introduction.md)。 --></section>
<section id="netrans-import">
<h2>Netrans.import 模型导入<a class="headerlink" href="#netrans-import" title="Link to this heading"></a></h2>
<p>描述: 将模型转换成 Pnna 支持的格式。
代码示例:</p>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="n">yolo_netrans</span><span class="o">.</span><span class="n">import</span><span class="p">()</span>
</pre></div>
</div>
<p>参数:
无。</p>
<p>输出返回:
无。
在工程目录下生成 Pnna 支持的模型格式,以.json结尾的模型文件和 .data结尾的权重文件。</p>
</section>
<section id="netrans-config">
<h2>Netrans.config 预处理配置文件生成<a class="headerlink" href="#netrans-config" title="Link to this heading"></a></h2>
<p>描述: 将模型转换成 Pnna 支持的格式。
代码示例:</p>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="n">yolo_netrans</span><span class="o">.</span><span class="n">config</span><span class="p">()</span>
</pre></div>
</div>
<p>参数:</p>
<div class="highlight-{table} notranslate"><div class="highlight"><pre><span></span>:widths: 20, 30, 50
:align: left
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|inputmeta| bool,str, [Fasle, True, &quot;inputmeta_filepath&quot;] | 指定 inputmeta, 默认为False。 &lt;br/&gt; 如果为False则会生成inputmeta模板可使用mean、scale、reverse_channel 配合修改常用参数。&lt;br/&gt;如果已有现成的 inputmeta 文件则可通过该参数进行指定也可使用True, 则会自动索引 model_name_inputmeta.yml |
|mean| float, int, list | 设置预处理中 normalize 的 mean 参数 |
|scale| float, int, list | 设置预处理中 normalize 的 scale 参数 |
|reverse_channel | bool | 设置预处理中的 reverse_channel 参数 |
</pre></div>
</div>
<p>输出返回:
无。</p>
</section>
<section id="netrans-quantize">
<h2>Netrans.quantize 模型量化<a class="headerlink" href="#netrans-quantize" title="Link to this heading"></a></h2>
<p>描述: 对模型生成量化配置文件。
代码示例:</p>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="n">yolo_netrans</span><span class="o">.</span><span class="n">quantize</span><span class="p">(</span><span class="s2">&quot;uint8&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>参数:</p>
<div class="highlight-{table} notranslate"><div class="highlight"><pre><span></span>:widths: 20, 30, 50
:align: left
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|quantize_type| str| 第一位置参数,模型量化类型,仅支持 &quot;uint8&quot;, &quot;int8&quot;, &quot;int16&quot;|
</pre></div>
</div>
<p>输出返回:
无。</p>
</section>
<section id="netrans-export">
<h2>Netrans.export 模型导出<a class="headerlink" href="#netrans-export" title="Link to this heading"></a></h2>
<p>描述: 对模型生成量化配置文件。
代码示例:</p>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="n">yolo_netrans</span><span class="o">.</span><span class="n">export</span><span class="p">()</span>
</pre></div>
</div>
<p>参数:
无。</p>
<p>输出返回:
无。请在目录 “wksp/*/” 下检查是否生成nbg文件。</p>
</section>
<section id="netrans-model2nbg-nbg">
<h2>Netrans.model2nbg 模型生成nbg文件<a class="headerlink" href="#netrans-model2nbg-nbg" title="Link to this heading"></a></h2>
<p>描述: 模型导入、量化、及nbg文件生产
代码示例:</p>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span> <span class="c1"># 无预处理</span>
<span class="n">yolo_netrans</span><span class="o">.</span><span class="n">model2nbg</span><span class="p">(</span><span class="n">quantize_type</span><span class="o">=</span><span class="s1">&#39;uint8&#39;</span><span class="p">)</span>
<span class="c1"># 需要对数据进行normlize, menas为128, scale 为 0.0039</span>
<span class="n">yolo_netrans</span><span class="o">.</span><span class="n">model2nbg</span><span class="p">(</span><span class="n">quantize_type</span><span class="o">=</span><span class="s1">&#39;uint8&#39;</span><span class="p">,</span><span class="n">mean</span><span class="o">=</span><span class="mi">128</span><span class="p">,</span> <span class="n">scale</span> <span class="o">=</span> <span class="mf">0.0039</span><span class="p">)</span>
<span class="c1"># 需要对数据分通道进行normlize, menas为128,127,125,scale 为 0.0039, 且reverse_channel 为 True </span>
<span class="n">yolo_netrans</span><span class="o">.</span><span class="n">model2nbg</span><span class="p">(</span><span class="n">quantize_type</span><span class="o">=</span><span class="s1">&#39;uint8&#39;</span><span class="n">mean</span><span class="o">=</span><span class="p">[</span><span class="mi">128</span><span class="p">,</span> <span class="mi">127</span><span class="p">,</span> <span class="mi">125</span><span class="p">],</span> <span class="n">scale</span> <span class="o">=</span> <span class="mf">0.0039</span><span class="p">,</span> <span class="n">reverse_channel</span><span class="o">=</span> <span class="kc">True</span><span class="p">)</span>
<span class="c1"># 已经进行初始化设置</span>
<span class="n">yolo_netrans</span><span class="o">.</span><span class="n">model2nbg</span><span class="p">(</span><span class="n">quantize_type</span><span class="o">=</span><span class="s1">&#39;uint8&#39;</span><span class="p">,</span> <span class="n">inputmeta</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>参数</p>
<div class="highlight-{table} notranslate"><div class="highlight"><pre><span></span>:widths: 20, 30, 50
:align: left
| 参数名 | 类型 | 说明 |
|:---| -- | -- |
|quantize_type| str, [&quot;uint8&quot;, &quot;int8&quot;, &quot;int16&quot; ] | 量化类型,将模型量化成该参数指定的类型 |
|inputmeta| bool,str, [Fasle, True, &quot;inputmeta_filepath&quot;] | 指定 inputmeta, 默认为False。 &lt;br/&gt; 如果为False则会生成inputmeta模板可使用mean、scale、reverse_channel 配合修改常用参数。&lt;br/&gt;如果已有现成的 inputmeta 文件则可通过该参数进行指定也可使用True, 则会自动索引 model_name_inputmeta.yml |
|mean| float, int, list | 设置预处理中 normalize 的 mean 参数 |
|scale| float, int, list | 设置预处理中 normalize 的 scale 参数 |
|reverse_channel | bool | 设置预处理中的 reverse_channel 参数 |
</pre></div>
</div>
<p>输出返回:
请在目录 “wksp/*/” 下检查是否生成nbg文件。</p>
</section>
<section id="id1">
<h2>使用示例<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<div class="highlight-py3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">nertans</span><span class="w"> </span><span class="kn">import</span> <span class="n">Netrans</span>
<span class="n">model_path</span> <span class="o">=</span> <span class="s1">&#39;example/darknet/yolov4_tiny&#39;</span>
<span class="n">netrans_path</span> <span class="o">=</span> <span class="s2">&quot;netrans/bin&quot;</span> <span class="c1"># 如果进行了export定义申明这一步可以不用</span>
<span class="c1"># 初始化netrans</span>
<span class="n">net</span> <span class="o">=</span> <span class="n">Netrans</span><span class="p">(</span><span class="n">model_path</span><span class="p">,</span><span class="n">netrans</span><span class="o">=</span><span class="n">netrans_path</span><span class="p">)</span>
<span class="c1"># 模型载入</span>
<span class="n">net</span><span class="o">.</span><span class="n">import</span><span class="p">()</span>
<span class="c1"># 配置预处理 normlize 的参数</span>
<span class="n">net</span><span class="o">.</span><span class="n">config</span><span class="p">(</span><span class="n">scale</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span><span class="n">mean</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
<span class="c1"># 模型量化</span>
<span class="n">net</span><span class="o">.</span><span class="n">quantize</span><span class="p">(</span><span class="s2">&quot;uint8&quot;</span><span class="p">)</span>
<span class="c1"># 模型导出</span>
<span class="n">net</span><span class="o">.</span><span class="n">export</span><span class="p">()</span>
<span class="c1"># 模型直接量化成 int16 并导出, 直接复用刚配置好的 inputmeta</span>
<span class="n">net</span><span class="o">.</span><span class="n">model2nbg</span><span class="p">(</span><span class="n">quantize_type</span> <span class="o">=</span> <span class="s2">&quot;int16&quot;</span><span class="p">,</span> <span class="n">inputmeta</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">netrans_py 使用</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#netrans">Netrans 类</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans-import">Netrans.import 模型导入</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans-config">Netrans.config 预处理配置文件生成</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans-quantize">Netrans.quantize 模型量化</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans-export">Netrans.export 模型导出</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans-model2nbg-nbg">Netrans.model2nbg 模型生成nbg文件</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">使用示例</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="netrans_cli.html" title="上一章">netrans_cli 使用</a></li>
<li>Next: <a href="appendix.html" title="下一章">附录</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/netrans_py.md.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

BIN
docs/html/objects.inv Normal file

Binary file not shown.

193
docs/html/py-modindex.html Normal file
View File

@ -0,0 +1,193 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python 模块索引 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<script>
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Python 模块索引</h1>
<div class="modindex-jumpbox">
<a href="#cap-c"><strong>c</strong></a> |
<a href="#cap-e"><strong>e</strong></a> |
<a href="#cap-f"><strong>f</strong></a> |
<a href="#cap-i"><strong>i</strong></a> |
<a href="#cap-n"><strong>n</strong></a> |
<a href="#cap-q"><strong>q</strong></a> |
<a href="#cap-u"><strong>u</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-c"><td></td><td>
<strong>c</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="config.html#module-config"><code class="xref">config</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-e"><td></td><td>
<strong>e</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="example.html#module-example"><code class="xref">example</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="export.html#module-export"><code class="xref">export</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-f"><td></td><td>
<strong>f</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="file_model.html#module-file_model"><code class="xref">file_model</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-i"><td></td><td>
<strong>i</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="import_model.html#module-import_model"><code class="xref">import_model</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="infer.html#module-infer"><code class="xref">infer</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-n"><td></td><td>
<strong>n</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="netrans.html#module-netrans"><code class="xref">netrans</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-q"><td></td><td>
<strong>q</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="quantize.html#module-quantize"><code class="xref">quantize</code></a></td><td>
<em></em></td></tr>
<tr>
<td></td>
<td>
<a href="quantize_hb.html#module-quantize_hb"><code class="xref">quantize_hb</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-u"><td></td><td>
<strong>u</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="utils.html#module-utils"><code class="xref">utils</code></a></td><td>
<em></em></td></tr>
</table>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

133
docs/html/quantize.html Normal file
View File

@ -0,0 +1,133 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>quantize module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="quantize_hb module" href="quantize_hb.html" />
<link rel="prev" title="infer module" href="infer.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-quantize">
<span id="quantize-module"></span><h1>quantize module<a class="headerlink" href="#module-quantize" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="quantize.Quantize">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quantize.</span></span><span class="sig-name descname"><span class="pre">Quantize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/quantize.html#Quantize"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#quantize.Quantize" title="Link to this definition"></a></dt>
<dd><p>基类:<a class="reference internal" href="utils.html#utils.AttributeCopier" title="utils.AttributeCopier"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a></p>
<p>解析 Netrans 参数,基于 pnnacc 量化模型
:param cla: 实例化以后的 Netrans 类,需要解析里面包含的参数
:type cla: class</p>
<dl class="py method">
<dt class="sig sig-object py" id="quantize.Quantize.quantize_network">
<span class="sig-name descname"><span class="pre">quantize_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quantize.Quantize.quantize_network" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="infer.html" title="上一章">infer module</a></li>
<li>Next: <a href="quantize_hb.html" title="下一章">quantize_hb module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/quantize.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

135
docs/html/quantize_hb.html Normal file
View File

@ -0,0 +1,135 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>quantize_hb module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="utils module" href="utils.html" />
<link rel="prev" title="quantize module" href="quantize.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-quantize_hb">
<span id="quantize-hb-module"></span><h1>quantize_hb module<a class="headerlink" href="#module-quantize_hb" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="quantize_hb.Quantize">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">quantize_hb.</span></span><span class="sig-name descname"><span class="pre">Quantize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/quantize_hb.html#Quantize"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#quantize_hb.Quantize" title="Link to this definition"></a></dt>
<dd><p>基类:<a class="reference internal" href="utils.html#utils.AttributeCopier" title="utils.AttributeCopier"><code class="xref py py-class docutils literal notranslate"><span class="pre">AttributeCopier</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="quantize_hb.Quantize.quantize_network">
<span class="sig-name descname"><span class="pre">quantize_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#quantize_hb.Quantize.quantize_network" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="quantize_hb.main">
<span class="sig-prename descclassname"><span class="pre">quantize_hb.</span></span><span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/quantize_hb.html#main"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#quantize_hb.main" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="quantize.html" title="上一章">quantize module</a></li>
<li>Next: <a href="utils.html" title="下一章">utils module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/quantize_hb.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

View File

@ -0,0 +1,254 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>快速入门 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="netrans_cli 使用" href="netrans_cli.html" />
<link rel="prev" title="netrans documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="id1">
<h1>快速入门<a class="headerlink" href="#id1" title="Link to this heading"></a></h1>
<p>本文档以 onnx 格式的 yolov5s 为例演示如何快速安装Nertans 并使用 Netrans 量化、编译模型并生成 nbg 文件。</p>
<section id="id2">
<h2>系统环境<a class="headerlink" href="#id2" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Linux操作系统推荐 Ubuntu 20.04 或 Debian12</p></li>
<li><p>Python 3.8</p></li>
<li><p>RAM 至少 8GB</p></li>
</ul>
</section>
<section id="netrans">
<h2>安装Netrans<a class="headerlink" href="#netrans" title="Link to this heading"></a></h2>
<p>创建 python3.8 环境</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>wget<span class="w"> </span><span class="s2">&quot;https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-</span><span class="k">$(</span>uname<span class="k">)</span><span class="s2">-</span><span class="k">$(</span>uname<span class="w"> </span>-m<span class="k">)</span><span class="s2">.sh&quot;</span>
mkdir<span class="w"> </span>-p<span class="w"> </span>~/app
<span class="nv">INSTALL_PATH</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span><span class="s2">/app/miniforge3&quot;</span>
bash<span class="w"> </span>Miniforge3-Linux-x86_64.sh<span class="w"> </span>-b<span class="w"> </span>-p<span class="w"> </span><span class="si">${</span><span class="nv">INSTALL_PATH</span><span class="si">}</span>
<span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;source &quot;</span><span class="si">${</span><span class="nv">INSTALL_PATH</span><span class="si">}</span>/etc/profile.d/conda.sh<span class="s2">&quot;&quot;</span><span class="w"> </span>&gt;&gt;<span class="w"> </span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/.bashrc
<span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;source &quot;</span><span class="si">${</span><span class="nv">INSTALL_PATH</span><span class="si">}</span>/etc/profile.d/mamba.sh<span class="s2">&quot;&quot;</span><span class="w"> </span>&gt;&gt;<span class="w"> </span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/.bashrc
<span class="nb">source</span><span class="w"> </span><span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/.bashrc
mamba<span class="w"> </span>create<span class="w"> </span>-n<span class="w"> </span>netrans<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.8<span class="w"> </span>-y
mamba<span class="w"> </span>activate<span class="w"> </span>netrans
</pre></div>
</div>
<p>下载 Netrans</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/app
git<span class="w"> </span>clone<span class="w"> </span>https://gitlink.org.cn/nudt_dsp/netrans.git
</pre></div>
</div>
<p>配置 Netrans</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~/app/netrans
./setup.sh
</pre></div>
</div>
</section>
<section id="netrans-yolov5s">
<h2>使用 Netrans 编译 yolov5s 模型<a class="headerlink" href="#netrans-yolov5s" title="Link to this heading"></a></h2>
<p>进入工作目录</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>/app/netrans/examples/onnx
</pre></div>
</div>
<p>此时目录如下:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>onnx/
├── README.md
└── yolov5s
├── 0.jpg
├── dataset.txt
└── yolov5s.onnx
</pre></div>
</div>
<section id="netrans-cli-yolov5s">
<h3>使用 netrans_cli 编译 yolov5s<a class="headerlink" href="#netrans-cli-yolov5s" title="Link to this heading"></a></h3>
<section id="id3">
<h4>导入模型<a class="headerlink" href="#id3" title="Link to this heading"></a></h4>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>load.sh<span class="w"> </span>yolov5s
</pre></div>
</div>
<p>该命令会在工程目录下生成包含模型信息的 .json 和 .data 数据文件。</p>
<p>此时 yolov5s 的目录结构如下</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>yolov5s/
├── 0.jpg
├── yolov5s.data
├── yolov5s.json
└── yolov5s.onnx
</pre></div>
</div>
</section>
<section id="id4">
<h4>生成配置文件模板<a class="headerlink" href="#id4" title="Link to this heading"></a></h4>
<p>配置文件定义输入数据前处理相关参数。Netrans预定义了配置文件模板生成脚本用户需根据模型前处理参数对配置文件进行修改。</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>config.sh<span class="w"> </span>yolov5s
</pre></div>
</div>
<p>此时 yolov5s 的目录结构如下:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>yolov5s/
├── 0.jpg
├── dataset.txt
├── yolov5s.data
├── yolov5s_inputmeta.yml
├── yolov5s.json
└── yolov5s.onnx
</pre></div>
</div>
<p>根据 yolov5s 的前处理参数 ,修改 yml 中的 scale 为 0.003921568627。
打开 <code class="docutils literal notranslate"><span class="pre">yolov5s_inputmeta.yml</span></code> 文件修改第30-33行</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span> scale:
- 0.003921568627
- 0.003921568627
- 0.003921568627
</pre></div>
</div>
</section>
<section id="id5">
<h4>量化模型<a class="headerlink" href="#id5" title="Link to this heading"></a></h4>
<p>生成 unit8 量化的量化参数文件</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>quantize.sh<span class="w"> </span>yolov5s<span class="w"> </span>uint8
</pre></div>
</div>
<p>此时 yolov5s 的目录结构如下:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>yolov5s/
├── 0.jpg
├── dataset.txt
├── yolov5s_asymmetric_affine.quantize
├── yolov5s.data
├── yolov5s_inputmeta.yml
├── yolov5s.json
└── yolov5s.onnx
</pre></div>
</div>
</section>
<section id="id6">
<h4>导出模型<a class="headerlink" href="#id6" title="Link to this heading"></a></h4>
<p>导出 unit8 量化的模型项目工程</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>export.sh<span class="w"> </span>yolov5s<span class="w"> </span>uint8
</pre></div>
</div>
<p>此时 yolov5s 的目录结构如下:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>yolov5s/
├── 0.jpg
├── dataset.txt
├── wksp
│ └── asymmetric_affine
│ └── network_binary.nb
├── yolov5s_asymmetric_affine.quantize
├── yolov5s.data
├── yolov5s_inputmeta.yml
├── yolov5s.json
└── yolov5s.onnx
</pre></div>
</div>
</section>
</section>
<section id="netrans-py-yolov5s">
<h3>使用 netrans_py 编译 yolov5s 模型<a class="headerlink" href="#netrans-py-yolov5s" title="Link to this heading"></a></h3>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>example.py<span class="w"> </span>yolov5s<span class="w"> </span>-q<span class="w"> </span>uint8<span class="w"> </span>-m<span class="w"> </span><span class="m">0</span><span class="w"> </span>-s<span class="w"> </span><span class="m">0</span>.003921568627
</pre></div>
</div>
</section>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">快速入门</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id2">系统环境</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans">安装Netrans</a></li>
<li class="toctree-l2"><a class="reference internal" href="#netrans-yolov5s">使用 Netrans 编译 yolov5s 模型</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="上一章">netrans documentation</a></li>
<li>Next: <a href="netrans_cli.html" title="下一章">netrans_cli 使用</a></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/quick_start_guide.md.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

122
docs/html/search.html Normal file
View File

@ -0,0 +1,122 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>搜索 &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="#" />
<script src="searchindex.js" defer="defer"></script>
<meta name="robots" content="noindex" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="search-documentation">搜索</h1>
<noscript>
<div class="admonition warning">
<p>
请激活 JavaScript 以开启搜索功能。
</p>
</div>
</noscript>
<p>
当搜索多个关键词时,只会显示同时包含所有关键词的内容。
</p>
<form action="" method="get">
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="搜索" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
</div>
</body>
</html>

1
docs/html/searchindex.js Normal file

File diff suppressed because one or more lines are too long

107
docs/html/setup.html Normal file
View File

@ -0,0 +1,107 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>setup module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="setup-module">
<h1>setup module<a class="headerlink" href="#setup-module" title="Link to this heading"></a></h1>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix.html">附录</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/setup.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

180
docs/html/utils.html Normal file
View File

@ -0,0 +1,180 @@
<!DOCTYPE html>
<html lang="zh" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>utils module &#8212; netrans 0.1 文档</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=52efc512"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="prev" title="quantize_hb module" href="quantize_hb.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-utils">
<span id="utils-module"></span><h1>utils module<a class="headerlink" href="#module-utils" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="utils.AttributeCopier">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">AttributeCopier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#AttributeCopier"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.AttributeCopier" title="Link to this definition"></a></dt>
<dd><p>基类:<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>快速解析复制 Netrans 信息</p>
<dl class="py method">
<dt class="sig sig-object py" id="utils.AttributeCopier.copy_attribute_name">
<span class="sig-name descname"><span class="pre">copy_attribute_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source_obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#AttributeCopier.copy_attribute_name"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.AttributeCopier.copy_attribute_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="utils.check_dir">
<span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">check_dir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#check_dir"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.check_dir" title="Link to this definition"></a></dt>
<dd><p>判断工程目录是否存在</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>network_name</strong> (<em>str</em>) -- 工程目录路径</p>
</dd>
<dt class="field-even">抛出<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>NotADirectoryError</strong> -- 没有那个工程目录</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="utils.check_env">
<span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">check_env</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#check_env"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.check_env" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="utils.check_netrans">
<span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">check_netrans</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">netrans</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#check_netrans"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.check_netrans" title="Link to this definition"></a></dt>
<dd><p>判断 netrans 是否配置成功</p>
<dl class="field-list simple">
<dt class="field-odd">参数<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>netrans</strong> (<em>str</em><em>, </em><em>bool</em>) -- _netrans 路径, 如果没有配置(默认为False)会去环境变量里找</p>
</dd>
<dt class="field-even">抛出<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>NotADirectoryError</strong> -- 找不到 Netrans 会返回 NotADirectoryError</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="utils.check_path">
<span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">check_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#check_path"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.check_path" title="Link to this definition"></a></dt>
<dd><p>装饰器, 确保在工程目录运行 nertans</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="utils.create_cls">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">create_cls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">netrans_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quantized_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'uint8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#create_cls"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.create_cls" title="Link to this definition"></a></dt>
<dd><p>基类:<code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>快速测试时候模拟实例化Netrans</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="utils.remove_history_file">
<span class="sig-prename descclassname"><span class="pre">utils.</span></span><span class="sig-name descname"><span class="pre">remove_history_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/utils.html#remove_history_file"><span class="viewcode-link"><span class="pre">[源代码]</span></span></a><a class="headerlink" href="#utils.remove_history_file" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">netrans</a></h1>
<search id="searchbox" style="display: none" role="search">
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
<input type="submit" value="提交" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>导航</h3>
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quick_start_guide.html">快速入门</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_cli.html">netrans_cli 使用</a></li>
<li class="toctree-l1"><a class="reference internal" href="netrans_py.html">netrans_py 使用</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="appendix.html">附录</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gen_api.html">gen api html &amp; pdf by sphinx</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">netrans_py</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="appendix.html">附录</a><ul>
<li><a href="modules.html">netrans_py</a><ul>
<li>Previous: <a href="quantize_hb.html" title="上一章">quantize_hb module</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&#169;2025, ccyh.
|
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
|
<a href="_sources/utils.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

BIN
docs/netrans.pdf Normal file

Binary file not shown.

View File

@ -100,6 +100,7 @@ class create_cls(): #dataclass @netrans_params
self.quantize_type = quantized_type
self.profile = False
# if __name__ == "__main__":
# dir_name = "yolo"
# os.mkdir(dir_name)