Skip to content
This repository was archived by the owner on Jun 3, 2025. It is now read-only.

Commit 3074bb8

Browse files
authored
update deepsparse docs for 0.1.1 release (#12)
1 parent 7a2b32c commit 3074bb8

22 files changed

+337
-188
lines changed

deepsparse/_modules/deepsparse/benchmark.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

deepsparse/_modules/deepsparse/cpu.html

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

@@ -196,11 +197,12 @@ <h1>Source code for deepsparse.cpu</h1><div class="highlight"><pre>
196197
<span class="sd">code related to detecting the details of the currently available cpu</span>
197198
<span class="sd">&quot;&quot;&quot;</span>
198199

199-
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
200+
<span class="kn">import</span> <span class="nn">json</span>
200201
<span class="kn">import</span> <span class="nn">os</span>
201-
<span class="kn">import</span> <span class="nn">sys</span>
202202
<span class="kn">import</span> <span class="nn">subprocess</span>
203-
<span class="kn">import</span> <span class="nn">json</span>
203+
<span class="kn">import</span> <span class="nn">sys</span>
204+
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
205+
204206

205207
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;cpu_details&quot;</span><span class="p">,</span> <span class="s2">&quot;VALID_VECTOR_EXTENSIONS&quot;</span><span class="p">]</span>
206208

@@ -312,8 +314,9 @@ <h1>Source code for deepsparse.cpu</h1><div class="highlight"><pre>
312314
<span class="p">)</span>
313315
<span class="k">if</span> <span class="n">avx_type_override</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">VALID_VECTOR_EXTENSIONS</span><span class="p">:</span>
314316
<span class="k">raise</span> <span class="ne">OSError</span><span class="p">(</span>
315-
<span class="s2">&quot;neuralmagic: invalid avx instruction set &#39;</span><span class="si">{}</span><span class="s2">&#39; must be one of </span><span class="si">{}</span><span class="s2">.&quot;</span>
316-
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">avx_type_override</span><span class="p">,</span> <span class="s2">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">VALID_VECTOR_EXTENSIONS</span><span class="p">))</span>
317+
<span class="s2">&quot;neuralmagic: invalid avx instruction set &#39;</span><span class="si">{}</span><span class="s2">&#39; must be one of </span><span class="si">{}</span><span class="s2">.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
318+
<span class="n">avx_type_override</span><span class="p">,</span> <span class="s2">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">VALID_VECTOR_EXTENSIONS</span><span class="p">)</span>
319+
<span class="p">)</span>
317320
<span class="p">)</span>
318321
<span class="n">arch</span><span class="o">.</span><span class="n">override_isa</span><span class="p">(</span><span class="n">avx_type_override</span><span class="p">)</span>
319322

deepsparse/_modules/deepsparse/engine.html

Lines changed: 51 additions & 16 deletions
Large diffs are not rendered by default.

deepsparse/_modules/deepsparse/lib.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

deepsparse/_modules/deepsparse/utils/data.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../../../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

deepsparse/_modules/deepsparse/utils/log.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../../../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

deepsparse/_modules/deepsparse/utils/onnx.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../../../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

deepsparse/_modules/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,11 @@
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../api/deepsparse.html">deepsparse package</a></li>
110110
</ul>
111-
<p class="caption"><span class="caption-text">Help and Support</span></p>
111+
<p class="caption"><span class="caption-text">Help</span></p>
112112
<ul>
113113
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/issues">Bugs, Feature Requests</a></li>
114114
<li class="toctree-l1"><a class="reference external" href="https://github.com/neuralmagic/deepsparse/discussions">Support, General Q&amp;A</a></li>
115+
<li class="toctree-l1"><a class="reference external" href="https://docs.neuralmagic.com">Neural Magic Docs</a></li>
115116
</ul>
116117

117118

deepsparse/_sources/api/deepsparse.rst.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
116
deepsparse package
217
==================
318

deepsparse/_sources/api/deepsparse.utils.rst.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
..
2+
Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
116
deepsparse.utils package
217
========================
318

0 commit comments

Comments
 (0)