rebuild docs based on latest repos (#36)

Co-authored-by: Jenkins <jenkins@neuralmagic.com>
neuralmagic · May 3, 2021 · d5e3fde · d5e3fde
1 parent a291051
commit d5e3fde
Show file tree

Hide file tree

Showing 1,870 changed files with 508,808 additions and 11,158 deletions.
diff --git a/_sources/source/faqs.md.txt b/_sources/source/faqs.md.txt
@@ -46,7 +46,7 @@ Our inference engine supports all versions of TensorFlow 1.x.; support for Tenso
 
 **Do you run on AMD hardware?**
 
-The DeepSparse Engine is validated to work on x86 Intel (Haswell generation and later)  and AMD CPUs running Linux. It is highly recommended to run on a CPU with AVX-512 instructions available for optimal algorithms to be enabled. Specific support details for some algorithms over different microarchitectures [is available](https://docs.neuralmagic.com/deepsparse/hardware.html).
+The DeepSparse Engine is validated to work on x86 Intel (Haswell generation and later)  and AMD CPUs running Linux. It is highly recommended to run on a CPU with AVX-512 instructions available for optimal algorithms to be enabled. Specific support details for some algorithms over different microarchitectures [is available](https://docs.neuralmagic.com/deepsparse/source/hardware.html).
 
 We are open to opportunities to expand our support footprint for different CPU-based processor architectures, based on market adoption and deep learning use cases.
 

diff --git a/deepsparse/.buildinfo b/deepsparse/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 64995755ebcbcada2659fe028186509c
+config: 50b9e32325921adbf7c8385d5b6d5297
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/deepsparse/.doctrees/api/deepsparse.doctree b/deepsparse/.doctrees/api/deepsparse.doctree
diff --git a/deepsparse/.doctrees/api/deepsparse.utils.doctree b/deepsparse/.doctrees/api/deepsparse.utils.doctree
diff --git a/deepsparse/.doctrees/api/modules.doctree b/deepsparse/.doctrees/api/modules.doctree
diff --git a/deepsparse/.doctrees/debugging-optimizing/diagnostics-debugging.doctree b/deepsparse/.doctrees/debugging-optimizing/diagnostics-debugging.doctree
diff --git a/deepsparse/.doctrees/debugging-optimizing/example-log.doctree b/deepsparse/.doctrees/debugging-optimizing/example-log.doctree
diff --git a/deepsparse/.doctrees/debugging-optimizing/index.doctree b/deepsparse/.doctrees/debugging-optimizing/index.doctree
diff --git a/deepsparse/.doctrees/debugging-optimizing/numactl-utility.doctree b/deepsparse/.doctrees/debugging-optimizing/numactl-utility.doctree
diff --git a/deepsparse/.doctrees/environment.pickle b/deepsparse/.doctrees/environment.pickle
diff --git a/deepsparse/.doctrees/index.doctree b/deepsparse/.doctrees/index.doctree
diff --git a/deepsparse/.doctrees/source/hardware.doctree b/deepsparse/.doctrees/source/hardware.doctree
diff --git a/deepsparse/.doctrees/source/installation.doctree b/deepsparse/.doctrees/source/installation.doctree
diff --git a/deepsparse/.doctrees/source/quicktour.doctree b/deepsparse/.doctrees/source/quicktour.doctree
diff --git a/deepsparse/.doctrees/source/scheduler.doctree b/deepsparse/.doctrees/source/scheduler.doctree
diff --git a/deepsparse/_images/multi-stream.png b/deepsparse/_images/multi-stream.png
diff --git a/deepsparse/_images/single-stream.png b/deepsparse/_images/single-stream.png
diff --git a/deepsparse/_modules/deepsparse/benchmark.html b/deepsparse/_modules/deepsparse/benchmark.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   deepsparse.benchmark — DeepSparse 0.2.0 documentation
+   deepsparse.benchmark — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -519,17 +519,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="benchmark.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_modules/deepsparse/cpu.html b/deepsparse/_modules/deepsparse/cpu.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   deepsparse.cpu — DeepSparse 0.2.0 documentation
+   deepsparse.cpu — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -413,17 +413,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="cpu.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_modules/deepsparse/engine.html b/deepsparse/_modules/deepsparse/engine.html
diff --git a/deepsparse/_modules/deepsparse/lib.html b/deepsparse/_modules/deepsparse/lib.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   deepsparse.lib — DeepSparse 0.2.0 documentation
+   deepsparse.lib — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -243,17 +243,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="lib.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_modules/deepsparse/utils/data.html b/deepsparse/_modules/deepsparse/utils/data.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   deepsparse.utils.data — DeepSparse 0.2.0 documentation
+   deepsparse.utils.data — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../../../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../../../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../../../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -310,17 +310,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="data.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../../../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_modules/deepsparse/utils/log.html b/deepsparse/_modules/deepsparse/utils/log.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   deepsparse.utils.log — DeepSparse 0.2.0 documentation
+   deepsparse.utils.log — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../../../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../../../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../../../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -227,17 +227,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="log.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../../../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_modules/deepsparse/utils/onnx.html b/deepsparse/_modules/deepsparse/utils/onnx.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   deepsparse.utils.onnx — DeepSparse 0.2.0 documentation
+   deepsparse.utils.onnx — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../../../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../../../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../../../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -356,17 +356,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="onnx.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../../../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_modules/index.html b/deepsparse/_modules/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8"/>
   <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
   <title>
-   Overview: module code — DeepSparse 0.2.0 documentation
+   Overview: module code — DeepSparse 0.3.0.20210502 documentation
   </title>
   <link href="../_static/css/theme.css" rel="stylesheet" type="text/css"/>
   <link href="../_static/pygments.css" rel="stylesheet" type="text/css"/>
@@ -41,7 +41,7 @@
        <img alt="Logo" class="logo" src="../_static/icon-deepsparse.png"/>
       </a>
       <div class="version">
-       0.2
+       0.3
       </div>
       <div role="search">
        <form action="../search.html" class="wy-form" id="rtd-search-form" method="get">
@@ -222,17 +222,27 @@ <h1>
     <span class="fa fa-book">
      Other Versions
     </span>
-    v: main
+    v: v0.3.0
     <span class="fa fa-caret-down">
     </span>
    </span>
    <div class="rst-other-versions">
     <dl>
      <dt>
-      Branches
+      Tags
      </dt>
      <dd>
       <a href="index.html">
+       v0.3.0
+      </a>
+     </dd>
+    </dl>
+    <dl>
+     <dt>
+      Branches
+     </dt>
+     <dd>
+      <a href="../main/index.html">
        main
       </a>
      </dd>

diff --git a/deepsparse/_sources/api/deepsparse.rst.txt b/deepsparse/_sources/api/deepsparse.rst.txt
@@ -51,6 +51,22 @@ deepsparse.engine module
    :undoc-members:
    :show-inheritance:
 
+deepsparse.generated\-version module
+------------------------------------
+
+.. automodule:: deepsparse.generated-version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+deepsparse.generated\_version module
+------------------------------------
+
+.. automodule:: deepsparse.generated_version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 deepsparse.lib module
 ---------------------
 

diff --git a/deepsparse/_sources/source/quicktour.md.txt b/deepsparse/_sources/source/quicktour.md.txt
@@ -50,7 +50,7 @@ from sparsezoo import Zoo
 from sparsezoo.models import classification
 
 model = classification.resnet_50()
-print(Zoo.search_optimized_models(model))
+print(Zoo.search_sparse_models(model))
 ```
 
 Output: