2.1.0 release (#2167)

* 2.1.0 release * update installation guide template
intel · Oct 19, 2023 · 290a6fa · 290a6fa
1 parent e4e6c8a
commit 290a6fa
Show file tree

Hide file tree

Showing 139 changed files with 25,867 additions and 16 deletions.
diff --git a/_css/custom.css b/_css/custom.css
@@ -5,8 +5,7 @@
 
 
 .menu {
-  /* display: flex; */
-  display: none;
+  display: flex;
   flex-wrap: wrap;
   width: 60%;
   margin: auto;

diff --git a/_scripts/actions.js b/_scripts/actions.js
@@ -164,14 +164,14 @@ $(document).ready(function() {
     if(data.system_requirements != null) {
       ret += "<div class=\"simple\">";
       ret += "<h2>" + $.secid_gen([indexa]) + "System Requirements</h2>";
+      ret += "<p>Make sure that your system complies with the following system requirements:</p>";
 
       var indexb = 1;
       if(data.system_requirements.hardware != null) {
         ret += "<div class=\"simple\">";
         ret += "<h3>" + $.secid_gen([indexa, indexb]) + "Hardware</h3>";
 
         if(data.system_requirements.hardware.support != null) { // Array of text
-          ret += "<p><strong>Support:</strong></p>";
           ret += $.ul_gen(data.system_requirements.hardware.support);
         }
         if(data.system_requirements.hardware.verified != null) { // Array of text
@@ -308,6 +308,9 @@ $(document).ready(function() {
           ret += $.notes_gen(data.installation.notes);
         var indexb = 0;
         if(data.installation.repos != null) {
+          if(data.installation.repos.length > 1) {
+            ret += "<p>Prebuilt wheel files are provided via multiple channels. You can choose either to install the packages.</p>";
+          }
           $.each(data.installation.repos, function(index, value) {
             ret += "<div class=\"simple\">";
             if(value.repo != null) {
@@ -351,10 +354,10 @@ $(document).ready(function() {
           ret += $.notes_gen(data.installation.notes);
         if(data.installation.aot != null)
           ret += $.notes_gen(["Refer to <a class=\"reference external\" href=\"" + data.installation.aot + "\">AOT documentation</a> for how to configure <cite>USE_AOT_DEVLIST</cite>. Without configuring AOT, the start-up time for processes using Intel® Extension for PyTorch* will be long, so this step is important."]);
-        ret += "<p>To ensure a smooth compilation, a script is provided in the Github repo. If you would like to compile the binaries from source, it is highly recommended to utilize this script.</p>";
+        ret += "<p>To ensure a smooth compilation, a script is provided. If you would like to compile the binaries from source, it is highly recommended to utilize this script.</p>";
         if(data.installation.commands != null)
           ret += $.code_gen(data.installation.commands);
-        ret += "<p>When compilation succeeds, directory structure should look like what is shown below.</p>";
+        ret += "<p>An example usage flow of this script is shown as below. After a successful compilation, you should see similar directory structure.</p>";
         if(data.installation.outputs != null)
           ret += $.code_gen(data.installation.outputs);
       } else if(data.package == "docker") {
@@ -446,16 +449,15 @@ $(document).ready(function() {
             });
             ret += "</div>";
           }
-
-        }
-        if(data.installation.commands != null) {
-          $.each(data.installation.commands, function(index, value) {
-            var cmds = [];
-            $.each(value.commands, function(index, v) {
-              cmds.push(v);
+          if(data.installation.commands != null) {
+            $.each(data.installation.commands, function(index, value) {
+              var cmds = [];
+              $.each(value.commands, function(index, v) {
+                cmds.push(v);
+              });
+              ret += $.notes_gen([value.usage + $.code_gen(cmds)], "Usage");
             });
-            ret += $.notes_gen([value.usage + $.code_gen(cmds)], "Usage");
-          });
+          }
         }
       } else {
         // Do nothing
@@ -472,15 +474,19 @@ $(document).ready(function() {
       if(data.system_requirements.software.basekit != null &&
          data.preparation.basekit.install != null &&
          !$.pkgInArray(data.package, ["docker"])) {
-        ret += "<p>You can run a simple sanity test to double confirm if the correct version is installed, and if the software stack can get correct hardware information onboard your system.</p>";
+        ret += "<p>You can run a simple sanity test to double confirm if the correct version is installed, and if the software stack can get correct hardware information onboard your system. The command should return PyTorch* and Intel® Extension for PyTorch* versions installed, as well as GPU card(s) information detected.</p>";
         $.each(data.preparation.basekit.install, function(index, value) {
           commands.push(value.env);
         });
       } else {
-        ret += "<p>You can run a simple sanity test to double confirm if the correct version is installed.</p>";
+        ret += "<p>You can run a simple sanity test to double confirm if the correct version is installed. The command should return PyTorch* and Intel® Extension for PyTorch* versions installed.</p>";
       }
       commands.push(data.sanity_test);
       ret += $.code_gen(commands);
+      m = data.version.match("v([0-9\\.]+\\+([a-zA-Z]+))");
+      if(m != null && m.length == 3) {
+        ret += "<p>Once installation succeeds, visit <a href=\"./" + m[2] + "/" + m[1] + "/tutorials/getting_started.html\">Get Started</a> and <a href=\"./" + m[2] + "/" + m[1] + "/tutorials/examples.html\">Examples</a> sections to start using the extension in your code.</p>";
+      }
       ret += "</div>";
       indexa += 1;
     } else {

diff --git a/cpu/2.1.0+cpu/.buildinfo b/cpu/2.1.0+cpu/.buildinfo
@@ -0,0 +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: 56e85e30933cbaea619a52972723ac47
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/cpu/2.1.0+cpu/_images/1ins_cus.gif b/cpu/2.1.0+cpu/_images/1ins_cus.gif
diff --git a/cpu/2.1.0+cpu/_images/1ins_log.gif b/cpu/2.1.0+cpu/_images/1ins_log.gif
diff --git a/cpu/2.1.0+cpu/_images/1ins_phy.gif b/cpu/2.1.0+cpu/_images/1ins_phy.gif
diff --git a/cpu/2.1.0+cpu/_images/1ins_soc.gif b/cpu/2.1.0+cpu/_images/1ins_soc.gif
diff --git a/cpu/2.1.0+cpu/_images/GenAI-bf16.gif b/cpu/2.1.0+cpu/_images/GenAI-bf16.gif
diff --git a/cpu/2.1.0+cpu/_images/GenAI-int8.gif b/cpu/2.1.0+cpu/_images/GenAI-int8.gif
diff --git a/cpu/2.1.0+cpu/_images/autotp_bf16_llama.gif b/cpu/2.1.0+cpu/_images/autotp_bf16_llama.gif
diff --git a/cpu/2.1.0+cpu/_images/autotp_woq_int8_llama.gif b/cpu/2.1.0+cpu/_images/autotp_woq_int8_llama.gif
diff --git a/cpu/2.1.0+cpu/_images/bf16_llama.gif b/cpu/2.1.0+cpu/_images/bf16_llama.gif
diff --git a/cpu/2.1.0+cpu/_images/figure1_memory_layout.png b/cpu/2.1.0+cpu/_images/figure1_memory_layout.png
diff --git a/cpu/2.1.0+cpu/_images/figure2_dispatch.png b/cpu/2.1.0+cpu/_images/figure2_dispatch.png
diff --git a/cpu/2.1.0+cpu/_images/figure3_strided_layout.png b/cpu/2.1.0+cpu/_images/figure3_strided_layout.png
diff --git a/cpu/2.1.0+cpu/_images/hypertune.png b/cpu/2.1.0+cpu/_images/hypertune.png
diff --git a/cpu/2.1.0+cpu/_images/int8_pattern.png b/cpu/2.1.0+cpu/_images/int8_pattern.png
diff --git a/cpu/2.1.0+cpu/_images/intel_extension_for_pytorch_structure.png b/cpu/2.1.0+cpu/_images/intel_extension_for_pytorch_structure.png
diff --git a/cpu/2.1.0+cpu/_images/kmp_affinity.jpg b/cpu/2.1.0+cpu/_images/kmp_affinity.jpg
diff --git a/cpu/2.1.0+cpu/_images/llm_iakv_1.png b/cpu/2.1.0+cpu/_images/llm_iakv_1.png
diff --git a/cpu/2.1.0+cpu/_images/llm_iakv_2.png b/cpu/2.1.0+cpu/_images/llm_iakv_2.png
diff --git a/cpu/2.1.0+cpu/_images/nins_cus.gif b/cpu/2.1.0+cpu/_images/nins_cus.gif
diff --git a/cpu/2.1.0+cpu/_images/nins_lat.gif b/cpu/2.1.0+cpu/_images/nins_lat.gif
diff --git a/cpu/2.1.0+cpu/_images/nins_thr.gif b/cpu/2.1.0+cpu/_images/nins_thr.gif
diff --git a/cpu/2.1.0+cpu/_images/smoothquant_int8_llama.gif b/cpu/2.1.0+cpu/_images/smoothquant_int8_llama.gif
diff --git a/cpu/2.1.0+cpu/_images/split_sgd.png b/cpu/2.1.0+cpu/_images/split_sgd.png
diff --git a/cpu/2.1.0+cpu/_images/woq_int4_gptj.gif b/cpu/2.1.0+cpu/_images/woq_int4_gptj.gif
diff --git a/cpu/2.1.0+cpu/_images/woq_int8_llama.gif b/cpu/2.1.0+cpu/_images/woq_int8_llama.gif