From acd8f4f182eaccf03b221f765ec0ddb451be3415 Mon Sep 17 00:00:00 2001
From: "Huang, Tai" <tai.huang@intel.com>
Date: Fri, 9 Aug 2024 15:24:14 +0800
Subject: [PATCH] Add version mapping between INC and Gaudi SW Stack (#1967)

Signed-off-by: Huang, Tai <tai.huang@intel.com>
---
 README.md                           |  3 +++
 docs/source/3x/gaudi_version_map.md | 16 ++++++++++++++++
 2 files changed, 19 insertions(+)
 create mode 100644 docs/source/3x/gaudi_version_map.md

diff --git a/README.md b/README.md
index 734e7f69592..bcc9c2fcc96 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,9 @@ pip install torch --index-url https://download.pytorch.org/whl/cpu
 #### Use Docker Image with torch installed for HPU
 https://docs.habana.ai/en/latest/Installation_Guide/Bare_Metal_Fresh_OS.html#bare-metal-fresh-os-single-click
 
+> **Note**:
+> There is a version mapping between Intel Neural Compressor and Gaudi Software Stack, please refer to this [table](./docs/source/3x/gaudi_version_map.md) and make sure to use a matched combination.
+
 #### Install torch/intel_extension_for_pytorch for Intel GPU
 https://intel.github.io/intel-extension-for-pytorch/index.html#installation
 
diff --git a/docs/source/3x/gaudi_version_map.md b/docs/source/3x/gaudi_version_map.md
new file mode 100644
index 00000000000..65695479acb
--- /dev/null
+++ b/docs/source/3x/gaudi_version_map.md
@@ -0,0 +1,16 @@
+
+### Version mapping between Intel Neural Compressor to Gaudi Software Stack ###
+<table>
+    <thead>
+        <tr>
+            <th>Intel Neural Compressor</th>
+            <th>Gaudi Software Stack</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>v3.0</td>
+            <td>v1.17</td>
+        </tr>
+    </tbody>
+</table>