update alternative compiler

Author: ZhaoqiongZ

prototype_source/inductor_windows_cpu.rst

@@ -4,70 +4,72 @@ How to use TorchInductor on Windows CPU
 **Author**: `Zhaoqiong Zheng <https://github.com/ZhaoqiongZ>`_, `Xu, Han <https://github.com/xuhancn>`_
 
 
+Introduction
+------------
 
-TorchInductor is a new compiler backend that compiles FX Graphs generated by TorchDynamo into optimized C++/Triton kernels.
-This tutorial will guide you through the process of using TorchInductor on a Windows CPU.
+TorchInductor is the new compiler backend that compiles the FX Graphs generated by TorchDynamo into optimized C++/Triton kernels.
 
-.. grid:: 2
+This tutorial introduces the steps for utilizing TorchInductor on Windows CPU.
 
-    .. grid-item-card:: :octicon:`mortar-board;1em;` What you will learn
-       :class-card: card-prerequisites
 
-       * How to compile and execute a Python function with PyTorch, optimized for Windows CPU
-       * Basics of TorchInductor's optimization using C++/Triton kernels.
 
-    .. grid-item-card:: :octicon:`list-unordered;1em;` Prerequisites
-       :class-card: card-prerequisites
+Software Installation
+---------------------
 
-       * PyTorch v2.5 or later
-       * Microsoft Visual C++ (MSVC)
-       * Miniforge for Windows
+Now, we will walk you through a step-by-step tutorial for how to use torchinductor on Windows CPU.
 
-Install the Required Software
--------------------------------------------
+Install a Compiler
+^^^^^^^^^^^^^^^^^^
 
-First, let's install the required software. C++ compiler is required for TorchInductor optimization.
-We will use Microsoft Visual C++ (MSVC) for this example. 
+C++ compiler is required for torchinductor optimization, let's take Microsoft Visual C++ (MSVC) as an example.
 
-1. Download and install `MSVC <https://visualstudio.microsoft.com/downloads/>`_.
+Download and install `MSVC <https://visualstudio.microsoft.com/downloads/>`_.
 
-2. During the installation, choose **Desktop Development with C++** in the **Desktop & Mobile** section. Then install the software
+During Installation, chosse `Desktop Development with C++` in the `Desktop & Mobile` Section and then install.
 
 .. note::
 
-     We recommend C++ compiler `Clang <https://github.com/llvm/llvm-project/releases>`_ and `Intel Compiler <https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html>`_.
+    Windows inductor also support C++ compiler `LLVM Compiler <https://github.com/llvm/llvm-project/releases>`_ and `Intel Compiler <https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler-download.html>`_ for better performance.
+    Please check Alternative Compiler for better performance:`my-reference-label`.
 
+.. _my-reference-label:
 
-3. Download and install `Miniforge3-Windows-x86_64.exe <https://github.com/conda-forge/miniforge/releases/latest/>`__.
+Alternative Compiler for better performance
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Set Up the Environment
-------------------------------
+To enhance performance on Windows inductor, you can use the Intel Compiler or LLVM Compiler. However, windows inductor rely on the runtime libraries from Microsoft Visual C++ (MSVC). Therefore, your first step should be to install MSVC.
 
-#. Open the command line environment via ``cmd.exe``.
-#. Activate `MSVC` with the following command::
+Intel Compiler
+~~~~~~~~~~~~~~
+#. Download and install `Intel Compiler <https://www.intel.com/content/www/us/en/developer/tools/oneapi/dpc-compiler-download.html>`_ with Windows version.
+#. Set environment variable for compiler `CXX=icx-cl`
 
-    "C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Auxiliary/Build/vcvars64.bat"
-#. Activate `conda` with the following command:
-
-   .. code-block:: sh
+LLVM Compiler
+~~~~~~~~~~~~~
+#. Download and install `LLVM Compiler <https://github.com/llvm/llvm-project/releases>`_ and choose Windows version.
+#. Set environment variable for compiler `CXX=clang-cl` 
 
-    "C:/ProgramData/miniforge3/Scripts/activate.bat"
-#. Create and activate a customer conda environment:
- 
-    .. code-block:: sh
+Install Miniforge
+^^^^^^^^^^^^^^^^^
 
-      conda create -n inductor_cpu_windows python=3.10 -y 
-      conda activate inductor_cpu_windows
+Download and install `Miniforge <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe>`_.
 
-#. Install `PyTorch 2.5 <https://pytorch.org/get-started/locally/>`_ or later.
+Set Up Environment
+^^^^^^^^^^^^^^^^^^
 
-Using TorchInductor on Windows CPU
-----------------------------------------
+#. Open a command line environment via cmd.exe.
+#. Activate `MSVC` via below command::
 
-Here’s a simple example to demonstrate how to use TorchInductor:
+    "C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Auxiliary/Build/vcvars64.bat"
+#. Activate `conda` via below command::
 
-.. code-block:: python
+    "C:/ProgramData/miniforge3/Scripts/activate.bat"
+#. Create and activate customer conda environment::
 
+    conda create -n inductor_cpu_windows python=3.10 -y 
+    conda activate inductor_cpu_windows
+#. Install `PyTorch 2.5 <https://pytorch.org/get-started/locally/>`_ or later.
+#. Use torchinductor on Windows CPU::
 
     import torch
     def foo(x, y):
@@ -77,9 +79,7 @@ Here’s a simple example to demonstrate how to use TorchInductor:
     opt_foo1 = torch.compile(foo)
     print(opt_foo1(torch.randn(10, 10), torch.randn(10, 10)))
 
-The code above returns the following output: 
-
-.. code-block:: sh
+#. Output of the above example::
 
     tensor([[-3.9074e-02,  1.3994e+00,  1.3894e+00,  3.2630e-01,  8.3060e-01,
             1.1833e+00,  1.4016e+00,  7.1905e-01,  9.0637e-01, -1.3648e+00],
@@ -105,4 +105,4 @@ The code above returns the following output:
 Conclusion
 ----------
 
-In this tutorial, we have learned how to use Inductor on Windows CPU with PyTorch 2.5 or later.
+With this tutorial, we introduce how to use Inductor on Windows CPU with PyTorch 2.5 or later.