intel · chensuyue · Nov 30, 2022 · Nov 29, 2022 · Nov 29, 2022 · Nov 29, 2022
diff --git a/README.md b/README.md
@@ -208,7 +208,7 @@ Intel® Neural Compressor validated 420+ [examples](./examples) for quantization
     </tr>
     <tr>
         <td colspan="4" align="center"><a href="./docs/source/distillation_quantization.md">Distillation for Quantization</a></td>
-        <td colspan="5" align="center"><a href="neural_coder">Neural Coder</a></td>
+        <td colspan="5" align="center"><a href="https://github.com/intel/neural-compressor/tree/master/neural_coder">Neural Coder</a></td>
     </tr>    
 
   </tbody>
@@ -219,9 +219,8 @@ Intel® Neural Compressor validated 420+ [examples](./examples) for quantization
   </thead>
   <tbody>
       <tr>
-          <td colspan="3" align="center"><a href="./docs/source/adaptor.md">Adaptor</a></td>
-          <td colspan="3" align="center"><a href="./docs/source/tuning_strategies.md">Strategy</a></td>
-          <td colspan="3" align="center"><a href="./docs/source/reference_examples.md">Reference Example</a></td>
+          <td colspan="6" align="center"><a href="./docs/source/adaptor.md">Adaptor</a></td>
+          <td colspan="6" align="center"><a href="./docs/source/tuning_strategies.md">Strategy</a></td>
       </tr>
   </tbody>
 </table>

diff --git a/docs/Makefile b/docs/Makefile
@@ -19,11 +19,11 @@ help:
 
 html:
 	# cp README.md to docs, modify response-link
-	cp -f "../README.md" "./source/getting_started.md"
+	cp -f "../README.md" "./source/Welcome.md"
 	cp -f "../SECURITY.md" "./source/SECURITY.md"
-	cp -f "./source/getting_started.md" "./source/getting_started.md.tmp"
-	sed 's/.md/.html/g; s/.\/docs\/source\//.\//g; s/.\/neural_coder\/extensions\/screenshots/imgs/g; s/.\/docs\/source\/_static/..\/\/_static/g; s/.\/examples/https:\/\/github.com\/intel\/neural-compressor\/tree\/master\/examples/g; s/.md/.html/g; ' "./source/getting_started.md.tmp" > "./source/getting_started.md"
-	rm -f "./source/getting_started.md.tmp"
+	cp -f "./source/Welcome.md" "./source/Welcome.md.tmp"
+	sed 's/.md/.html/g; s/.\/docs\/source\//.\//g; s/.\/neural_coder\/extensions\/screenshots/imgs/g; s/.\/docs\/source\/_static/..\/\/_static/g; ' "./source/Welcome.md.tmp" > "./source/Welcome.md"
+	rm -f "./source/Welcome.md.tmp"
 
 	# make sure other png can display normal
 	$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)

diff --git a/docs/source/SECURITY.md b/docs/source/SECURITY.md
@@ -0,0 +1,13 @@
+Security Policy
+===============
+
+## Report a Vulnerability
+
+Please report security issues or vulnerabilities to the [Intel® Security Center].
+
+For more information on how Intel® works to resolve security issues, see
+[Vulnerability Handling Guidelines].
+
+[Intel® Security Center]:https://www.intel.com/security
+
+[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html
diff --git a/docs/source/Welcome.md b/docs/source/Welcome.md
@@ -0,0 +1,249 @@
+<div align="center">
+
+Intel® Neural Compressor
+===========================
+<h3> An open-source Python library supporting popular model compression techniques on all mainstream deep learning frameworks (TensorFlow, PyTorch, ONNX Runtime, and MXNet)</h3>
+
+[![python](https://img.shields.io/badge/python-3.7%2B-blue)](https://github.com/intel/neural-compressor)
+[![version](https://img.shields.io/badge/release-1.14-green)](https://github.com/intel/neural-compressor/releases)
+[![license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/intel/neural-compressor/blob/master/LICENSE)
+[![coverage](https://img.shields.io/badge/coverage-90%25-green)](https://github.com/intel/neural-compressor)
+[![Downloads](https://static.pepy.tech/personalized-badge/neural-compressor?period=total&units=international_system&left_color=grey&right_color=green&left_text=downloads)](https://pepy.tech/project/neural-compressor)
+</div>
+
+---
+<div align="left">
+
+Intel® Neural Compressor, formerly known as Intel® Low Precision Optimization Tool, is an open-source Python library that runs on Intel CPUs and GPUs, which delivers unified interfaces across multiple deep-learning frameworks for popular network compression technologies such as quantization, pruning, and knowledge distillation. This tool supports automatic accuracy-driven tuning strategies to help the user quickly find out the best quantized model. It also implements different weight-pruning algorithms to generate a pruned model with predefined sparsity goal. It also supports knowledge distillation to distill the knowledge from the teacher model to the student model. 
+Intel® Neural Compressor is a critical AI software component in the [Intel® oneAPI AI Analytics Toolkit](https://software.intel.com/content/www/us/en/develop/tools/oneapi/ai-analytics-toolkit.html).
+
+
+**Visit the Intel® Neural Compressor online document website at: <https://intel.github.io/neural-compressor>.**   
+
+## Installation
+
+### Prerequisites
+
+Python version: 3.7, 3.8, 3.9, 3.10
+
+### Install on Linux
+- Release binary install 
+  ```Shell
+  # install stable basic version from pip
+  pip install neural-compressor
+  # Or install stable full version from pip (including GUI)
+  pip install neural-compressor-full
+  ```
+- Nightly binary install
+  ```Shell
+  git clone https://github.com/intel/neural-compressor.git
+  cd neural-compressor
+  pip install -r requirements.txt
+  # install nightly basic version from pip
+  pip install -i https://test.pypi.org/simple/ neural-compressor
+  # Or install nightly full version from pip (including GUI)
+  pip install -i https://test.pypi.org/simple/ neural-compressor-full
+  ```
+More installation methods can be found at [Installation Guide](./installation_guide.html). Please check out our [FAQ](./faq.html) for more details.
+
+## Getting Started
+### Quantization with Python API    
+
+```shell
+# A TensorFlow Example
+pip install tensorflow
+# Prepare fp32 model
+wget https://storage.googleapis.com/intel-optimized-tensorflow/models/v1_6/mobilenet_v1_1.0_224_frozen.pb
+```
+```python
+import tensorflow as tf
+from neural_compressor.experimental import Quantization, common
+quantizer = Quantization()
+quantizer.model = './mobilenet_v1_1.0_224_frozen.pb'
+dataset = quantizer.dataset('dummy', shape=(1, 224, 224, 3))
+quantizer.calib_dataloader = common.DataLoader(dataset)
+quantizer.fit()
+```
+### Quantization with [JupyterLab Extension](./neural_coder/extensions/neural_compressor_ext_lab/README.html)
+Search for ```jupyter-lab-neural-compressor``` in the Extension Manager in JupyterLab and install with one click:
+
+<a target="_blank" href="imgs/extmanager.png">
+  <img src="imgs/extmanager.png" alt="Extension" width="35%" height="35%">
+</a>
+
+### Quantization with [GUI](./bench.html)
+```shell
+# An ONNX Example
+pip install onnx==1.12.0 onnxruntime==1.12.1 onnxruntime-extensions
+# Prepare fp32 model
+wget https://github.com/onnx/models/raw/main/vision/classification/resnet/model/resnet50-v1-12.onnx
+# Start GUI
+inc_bench
+```
+<a target="_blank" href="./_static/imgs/INC_GUI.gif">
+  <img src="./_static/imgs/INC_GUI.gif" alt="Architecture">
+</a>
+
+## System Requirements
+
+### Validated Hardware Environment
+#### Intel® Neural Compressor supports CPUs based on [Intel 64 architecture or compatible processors](https://en.wikipedia.org/wiki/X86-64):
+
+* Intel Xeon Scalable processor (formerly Skylake, Cascade Lake, Cooper Lake, and Icelake)
+* Future Intel Xeon Scalable processor (code name Sapphire Rapids)
+
+#### Intel® Neural Compressor supports GPUs built on Intel's Xe architecture:
+
+* [Intel® Data Center GPU Flex Series](https://www.intel.com/content/www/us/en/products/docs/discrete-gpus/data-center-gpu/flex-series/overview.html)
+
+#### Intel® Neural Compressor quantized ONNX models support multiple hardware vendors through ONNX Runtime:
+
+* Intel CPU, AMD/ARM CPU, and NVidia GPU. Please refer to the validated model [list](./validated_model_list.html#Validated-ONNX-QDQ-INT8-models-on-multiple-hardware-through-ONNX-Runtime).
+
+### Validated Software Environment
+
+* OS version: CentOS 8.4, Ubuntu 20.04  
+* Python version: 3.7, 3.8, 3.9, 3.10  
+
+<table class="docutils">
+<thead>
+  <tr>
+    <th>Framework</th>
+    <th>TensorFlow</th>
+    <th>Intel TensorFlow</th>
+    <th>PyTorch</th>
+    <th>Intel® Extension for PyTorch*</th>
+    <th>ONNX Runtime</th>
+    <th>MXNet</th>
+  </tr>
+</thead>
+<tbody>
+  <tr align="center">
+    <th>Version</th>
+    <td class="tg-7zrl"><a href=https://github.com/tensorflow/tensorflow/tree/v2.10.0>2.10.0</a><br>
+    <a href=https://github.com/tensorflow/tensorflow/tree/v2.9.1>2.9.1</a><br>
+    <a href=https://github.com/tensorflow/tensorflow/tree/v2.8.2>2.8.2</a><br>
+    <td class="tg-7zrl"><a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.10.0>2.10.0</a><br>
+    <a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.9.1>2.9.1</a><br>
+    <a href=https://github.com/Intel-tensorflow/tensorflow/tree/v2.8.0>2.8.0</a><br>
+    <td class="tg-7zrl"><a href=https://download.pytorch.org/whl/torch_stable.html>1.12.1+cpu</a><br>
+    <a href=https://download.pytorch.org/whl/torch_stable.html>1.11.0+cpu</a><br>
+    <a href=https://download.pytorch.org/whl/torch_stable.html>1.10.0+cpu</a></td>
+    <td class="tg-7zrl"><a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.12.0>1.12.0</a><br>
+    <a href=https://github.com/intel/intel-extension-for-pytorch/tree/1.11.0>1.11.0</a><br>
+    <a href=https://github.com/intel/intel-extension-for-pytorch/tree/v1.10.0>1.10.0</a></td>
+    <td class="tg-7zrl"><a href=https://github.com/microsoft/onnxruntime/tree/v1.12.1>1.12.1</a><br>
+    <a href=https://github.com/microsoft/onnxruntime/tree/v1.11.0>1.11.0</a><br>
+    <a href=https://github.com/microsoft/onnxruntime/tree/v1.10.0>1.10.0</a></td>
+    <td class="tg-7zrl"><a href=https://github.com/apache/incubator-mxnet/tree/1.8.0>1.8.0</a><br>
+    <a href=https://github.com/apache/incubator-mxnet/tree/1.7.0>1.7.0</a><br>
+    <a href=https://github.com/apache/incubator-mxnet/tree/1.6.0>1.6.0</a></td>
+  </tr>
+</tbody>
+</table>
+
+> **Note:**
+> Set the environment variable ``TF_ENABLE_ONEDNN_OPTS=1`` to enable oneDNN optimizations if you are using TensorFlow v2.6 to v2.8. oneDNN is the default for TensorFlow v2.9.
+
+### Validated Models
+Intel® Neural Compressor validated 420+ [examples](./examples) for quantization with a performance speedup geomean of 2.2x and up to 4.2x on VNNI while minimizing accuracy loss. Over 30 pruning and knowledge distillation samples are also available. More details for validated models are available [here](./validated_model_list.html).
+
+<div style = "width: 77%; margin-bottom: 2%;">
+  <a target="_blank" href="./_static/imgs/release_data.png">
+    <img src="./_static/imgs/release_data.png" alt="Architecture" width=800 height=500>
+  </a>
+</div>
+
+## Documentation
+
+<table class="docutils">
+  <thead>
+  <tr>
+    <th colspan="9">Overview</th>
+  </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td colspan="3" align="center"><a href="./design.html">Architecture</a></td>
+      <td colspan="2" align="center"><a href="https://github.com/intel/neural-compressor/tree/master/examples">Examples</a></td>
+      <td colspan="2" align="center"><a href="./bench.html">GUI</a></td>
+      <td colspan="2" align="center"><a href="https://intel.github.io/neural-compressor/api-documentation/apis.html">APIs</a></td>
+    </tr>
+    <tr>
+      <td colspan="5" align="center"><a href="https://software.intel.com/content/www/us/en/develop/documentation/get-started-with-ai-linux/top.html">Intel oneAPI AI Analytics Toolkit</a></td>
+      <td colspan="4" align="center"><a href="https://github.com/oneapi-src/oneAPI-samples/tree/master/AI-and-Analytics">AI and Analytics Samples</a></td>
+    </tr>
+  </tbody>
+  <thead>
+  <tr>
+    <th colspan="9">Basic API</th>
+  </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td colspan="2" align="center"><a href="./transform.html">Transform</a></td>
+      <td colspan="2" align="center"><a href="./dataset.html">Dataset</a></td>
+      <td colspan="2" align="center"><a href="./metric.html">Metric</a></td>
+      <td colspan="3" align="center"><a href="./objective.html">Objective</a></td>
+    </tr>
+  </tbody>
+  <thead>
+    <tr>
+      <th colspan="9">Deep Dive</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+        <td colspan="2" align="center"><a href="./quantization.html">Quantization</a></td>
+        <td colspan="1" align="center"><a href="./pruning.html">Pruning(Sparsity)</a></td> 
+        <td colspan="2" align="center"><a href="./distillation.html">Knowledge Distillation</a></td>
+        <td colspan="2" align="center"><a href="./mixed_precision.html">Mixed Precision</a></td>
+        <td colspan="2" align="center"><a href="./orchestration.html">Orchestration</a></td>
+    </tr>
+    <tr>
+        <td colspan="2" align="center"><a href="./benchmark.html">Benchmarking</a></td>
+        <td colspan="3" align="center"><a href="./distributed.html">Distributed Training</a></td>
+        <td colspan="2" align="center"><a href="./model_conversion.html">Model Conversion</a></td>
+        <td colspan="2" align="center"><a href="./tensorboard.html">TensorBoard</a></td>
+    </tr>
+    <tr>
+        <td colspan="4" align="center"><a href="./distillation_quantization.html">Distillation for Quantization</a></td>
+        <td colspan="5" align="center"><a href="https://github.com/intel/neural-compressor/tree/master/neural_coder">Neural Coder</a></td>
+    </tr>    
+
+  </tbody>
+  <thead>
+      <tr>
+        <th colspan="9">Advanced Topics</th>
+      </tr>
+  </thead>
+  <tbody>
+      <tr>
+          <td colspan="6" align="center"><a href="./adaptor.html">Adaptor</a></td>
+          <td colspan="6" align="center"><a href="./tuning_strategies.html">Strategy</a></td>
+      </tr>
+  </tbody>
+</table>
+
+## Selected Publications/Events
+* [Neural Compressor: an open-source Python library for network compression](https://cloud.tencent.com/developer/article/2165895) (Nov 2022)
+* [Running Fast Transformers on CPUs: Intel Approach Achieves Significant Speed Ups and SOTA Performance](https://medium.com/syncedreview/running-fast-transformers-on-cpus-intel-approach-achieves-significant-speed-ups-and-sota-448521704c5e) (Nov 2022)
+* [Personalized Stable Diffusion with Few-Shot Fine-Tuning](https://medium.com/intel-analytics-software/personalized-stable-diffusion-with-few-shot-fine-tuning-on-a-single-cpu-f01a3316b13) (Nov 2022)
+* [Meet the Innovation of Intel AI Software: Intel® Extension for TensorFlow*](https://www.intel.com/content/www/us/en/developer/articles/technical/innovation-of-ai-software-extension-tensorflow.html) (Oct 2022)
+* [PyTorch* Inference Acceleration with Intel® Neural Compressor](https://www.intel.com/content/www/us/en/developer/articles/technical/pytorch-inference-with-intel-neural-compressor.html#gs.gnq0cj) (Oct 2022)
+* Neural Coder, a new plug-in for Intel Neural Compressor was covered by [Twitter](https://twitter.com/IntelDevTools/status/1583629213697212416), [LinkedIn](https://www.linkedin.com/posts/intel-software_oneapi-ai-deeplearning-activity-6989377309917007872-Dbzg?utm_source=share&utm_medium=member_desktop), and [Intel Developer Zone](https://mp.weixin.qq.com/s/LL-4eD-R0YagFgODM23oQA) from Intel, and [Twitter](https://twitter.com/IntelDevTools/status/1583629213697212416/retweets) and [LinkedIn](https://www.linkedin.com/feed/update/urn:li:share:6990377841435574272/) from Hugging Face. (Oct 2022)
+* Intel Neural Compressor successfully landed on [GCP](https://console.cloud.google.com/marketplace/product/bitnami-launchpad/inc-tensorflow-intel?project=verdant-sensor-286207), [AWS](https://aws.amazon.com/marketplace/pp/prodview-yjyh2xmggbmga#pdp-support), and [Azure](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/bitnami.inc-tensorflow-intel) marketplace. (Oct 2022)
+
+> View our [full publication list](./publication_list.html).
+
+## Additional Content
+
+* [Release Information](./releases_info.html)
+* [Contribution Guidelines](./contributions.html)
+* [Legal Information](./legal_information.html)
+* [Security Policy](SECURITY.html)
+* [Intel® Neural Compressor Website](https://intel.github.io/neural-compressor)
+
+## Hiring
+
+We are actively hiring. Send your resume to [email protected] if you are interested in model compression techniques.
diff --git a/docs/source/_static/index.html b/docs/source/_static/index.html
@@ -1 +1 @@
-<meta http-equiv="refresh" content="0; URL='getting_started.html'" />
+<meta http-equiv="refresh" content="0; URL='Welcome.html'" />
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -7,7 +7,7 @@
   <div class="container">
     <div class="header-container">
       <div class="navbar-logo">
-        <a href="https://intel.github.io/neural-compressor/README.html" alt="Intel homepage" class="intel-logo-rebrand">
+        <a href="https://intel.github.io/neural-compressor/Welcome.html" alt="Intel homepage" class="intel-logo-rebrand">
             <span class="headTitleStyle"> Intel® Neural Compressor</span> 
           </a>
     </div>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<meta http-equiv="refresh" content="0; URL='getting_started.html'" />
		<meta http-equiv="refresh" content="0; URL='Welcome.html'" />