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

Commit c47d826

Browse files
markurtzmarkurtz
committed
update docs for release 0.1.0
1 parent 1a2cfcc commit c47d826

File tree

333 files changed

+5947
-1070
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

333 files changed

+5947
-1070
lines changed

‎Makefile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
BUILDDIR := $(PWD)
44
PYCHECKDIRS := utils
55
PYCHECKGLOBS := 'utils/**/*.py'
6-
DOCDIR := docs-sphinx
6+
DOCDIR := docs
77
MDCHECKGLOBS := 'docs/**/*.md' 'docs/**/*.rst'
88
MDCHECKFILES := CODE_OF_CONDUCT.md CONTRIBUTING.md DEVELOPING.md README.md
99

@@ -31,7 +31,9 @@ docs:
3131
# creates wheel file
3232
build:
3333
make docs;
34-
mv -v docs-sphinx/build/html/* docs/;
34+
rm -rf _sources;
35+
rm -rf _static;
36+
mv -v docs/build/html/* ./;
3537

3638
# clean package
3739
clean:

‎_sources/index.rst.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@ Neural Magic’s Deep Sparse Platform provides a suite of software components to
2222
.. raw:: html
2323

2424
<div style="margin-bottom:16px;">
25-
<a href="https://docs.neuralmagic.com/">
26-
<img alt="Documentation" src="https://img.shields.io/website/http/neuralmagic.com/sparseml/index.html.svg?down_color=red&down_message=offline&up_message=online&style=for-the-badge" height=25 style="margin-bottom:4px;">
27-
</a>
28-
<a href="https://github.com/neuralmagic/docs/blob/main/LICENSE"></a>
25+
2926
<a href="https://github.com/neuralmagic/docs/blob/main/CODE_OF_CONDUCT.md">
3027
<img alt="Contributor Covenant" src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?color=yellow&style=for-the-badge" height=25 style="margin-bottom:4px;">
3128
</a>
@@ -61,3 +58,6 @@ To contribute to Neural Magic documentation, please:
6158
- Open a `GitHub issue <https://github.com/neuralmagic/docs/issues/ />`_ and give it the `documentation` label.
6259
- Submit a `pull request <https://github.com/neuralmagic/docs/pulls/ />`_ with your proposed documentation changes.
6360
- Get started with `writing and formatting on GitHub <https://help.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github />`_
61+
62+
To learn more about Neural Magic, `check our website <https://www.neuralmagic.com/ />`_.
63+

‎deepsparse/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: a8c64c8871bf38d2cf61becc168e65ef
3+
config: 2ea6ec815620279e254a771fb06700d8
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎deepsparse/_modules/deepsparse/benchmark.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -513,7 +508,7 @@ <h1>Source code for deepsparse.benchmark</h1><div class="highlight"><pre>
513508

514509
<div role="contentinfo">
515510
<p>
516-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
511+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
517512

518513
</p>
519514
</div>
@@ -544,19 +539,6 @@ <h1>Source code for deepsparse.benchmark</h1><div class="highlight"><pre>
544539

545540

546541

547-
<!-- Theme Analytics -->
548-
<script>
549-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
550-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
551-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
552-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
553-
554-
ga('create', 'UA-128364174-1', 'auto');
555-
556-
ga('send', 'pageview');
557-
</script>
558-
559-
560542

561543

562544
</body>

‎deepsparse/_modules/deepsparse/cpu.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -354,7 +349,7 @@ <h1>Source code for deepsparse.cpu</h1><div class="highlight"><pre>
354349

355350
<div role="contentinfo">
356351
<p>
357-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
352+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
358353

359354
</p>
360355
</div>
@@ -385,19 +380,6 @@ <h1>Source code for deepsparse.cpu</h1><div class="highlight"><pre>
385380

386381

387382

388-
<!-- Theme Analytics -->
389-
<script>
390-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
391-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
392-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
393-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
394-
395-
ga('create', 'UA-128364174-1', 'auto');
396-
397-
ga('send', 'pageview');
398-
</script>
399-
400-
401383

402384

403385
</body>

‎deepsparse/_modules/deepsparse/engine.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -754,7 +749,7 @@ <h1>Source code for deepsparse.engine</h1><div class="highlight"><pre>
754749

755750
<div role="contentinfo">
756751
<p>
757-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
752+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
758753

759754
</p>
760755
</div>
@@ -785,19 +780,6 @@ <h1>Source code for deepsparse.engine</h1><div class="highlight"><pre>
785780

786781

787782

788-
<!-- Theme Analytics -->
789-
<script>
790-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
791-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
792-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
793-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
794-
795-
ga('create', 'UA-128364174-1', 'auto');
796-
797-
ga('send', 'pageview');
798-
</script>
799-
800-
801783

802784

803785
</body>

‎deepsparse/_modules/deepsparse/lib.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -237,7 +232,7 @@ <h1>Source code for deepsparse.lib</h1><div class="highlight"><pre>
237232

238233
<div role="contentinfo">
239234
<p>
240-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
235+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
241236

242237
</p>
243238
</div>
@@ -268,19 +263,6 @@ <h1>Source code for deepsparse.lib</h1><div class="highlight"><pre>
268263

269264

270265

271-
<!-- Theme Analytics -->
272-
<script>
273-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
274-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
275-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
276-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
277-
278-
ga('create', 'UA-128364174-1', 'auto');
279-
280-
ga('send', 'pageview');
281-
</script>
282-
283-
284266

285267

286268
</body>

‎deepsparse/_modules/deepsparse/utils/data.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -261,7 +256,7 @@ <h1>Source code for deepsparse.utils.data</h1><div class="highlight"><pre>
261256

262257
<div role="contentinfo">
263258
<p>
264-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
259+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
265260

266261
</p>
267262
</div>
@@ -292,19 +287,6 @@ <h1>Source code for deepsparse.utils.data</h1><div class="highlight"><pre>
292287

293288

294289

295-
<!-- Theme Analytics -->
296-
<script>
297-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
298-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
299-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
300-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
301-
302-
ga('create', 'UA-128364174-1', 'auto');
303-
304-
ga('send', 'pageview');
305-
</script>
306-
307-
308290

309291

310292
</body>

‎deepsparse/_modules/deepsparse/utils/log.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -221,7 +216,7 @@ <h1>Source code for deepsparse.utils.log</h1><div class="highlight"><pre>
221216

222217
<div role="contentinfo">
223218
<p>
224-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
219+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
225220

226221
</p>
227222
</div>
@@ -252,19 +247,6 @@ <h1>Source code for deepsparse.utils.log</h1><div class="highlight"><pre>
252247

253248

254249

255-
<!-- Theme Analytics -->
256-
<script>
257-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
258-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
259-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
260-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
261-
262-
ga('create', 'UA-128364174-1', 'auto');
263-
264-
ga('send', 'pageview');
265-
</script>
266-
267-
268250

269251

270252
</body>

‎deepsparse/_modules/deepsparse/utils/onnx.html

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,6 @@
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>
112-
<ul>
113-
<li class="toctree-l1"><a class="reference external" href="`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_">`Bugs, Feature Requests &lt;https://github.com/neuralmagic/deepsparse/discussions&gt;`_</a></li>
114-
<li class="toctree-l1"><a class="reference external" href="`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_">`Support, General Q&amp;A &lt;https://github.com/neuralmagic/deepsparse/issues&gt;`_</a></li>
115-
</ul>
116111

117112

118113

@@ -350,7 +345,7 @@ <h1>Source code for deepsparse.utils.onnx</h1><div class="highlight"><pre>
350345

351346
<div role="contentinfo">
352347
<p>
353-
&#169; Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
348+
&#169; Copyright Copyright (c) 2021 - present / Neuralmagic, Inc. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the &#34;License&#34;).
354349

355350
</p>
356351
</div>
@@ -381,19 +376,6 @@ <h1>Source code for deepsparse.utils.onnx</h1><div class="highlight"><pre>
381376

382377

383378

384-
<!-- Theme Analytics -->
385-
<script>
386-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
387-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
388-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
389-
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
390-
391-
ga('create', 'UA-128364174-1', 'auto');
392-
393-
ga('send', 'pageview');
394-
</script>
395-
396-
397379

398380

399381
</body>

0 commit comments

Comments
 (0)