From 83fd195ca828633b7fe70474788b5db9c1ead141 Mon Sep 17 00:00:00 2001
From: gyzhou2000 <zhougy@bupt.edu.cn>
Date: Tue, 23 Jul 2024 19:36:42 +0800
Subject: [PATCH] update docs

---
 docs/source/notes/installation.rst | 15 +++++++--------
 docs/source/notes/quick-start.html | 29 ++++++-----------------------
 2 files changed, 13 insertions(+), 31 deletions(-)

diff --git a/docs/source/notes/installation.rst b/docs/source/notes/installation.rst
index 0f07b0be..a3f9943a 100644
--- a/docs/source/notes/installation.rst
+++ b/docs/source/notes/installation.rst
@@ -6,15 +6,14 @@ System requrements
 GammaGL works with the following operating systems:
 
 * Linux
-* Windows (Currently, we only support python 3.9, pytorch 2.1 and CPU on Windows)
 
-GammaGL requires Python version 3.9, 3.10, 3.11.
+GammaGL requires Python version 3.9, 3.10, 3.11, 3.12.
 
 Backend
 -------
 
 - `tensorflow <https://www.tensorflow.org/api_docs/>`_ : We recommend tensorflow version under 2.12.0
-- `pytorch <https://pytorch.org/get-started/locally/>`_ : Support version from 1.9 to 2.1, the defalut backend
+- `pytorch <https://pytorch.org/get-started/locally/>`_ : Support version from 2.1 to 2.3, the defalut backend
 - `paddlepaddle <https://www.paddlepaddle.org.cn/>`_ : We recommend paddlepaddle version under 2.3.2
 - `mindspore <https://www.mindspore.cn/install>`_ : Support version to 2.2.10
 
@@ -33,7 +32,7 @@ Install from pip
 
 .. code:: bash
 
-   conda create -n gammagl python=3.9
+   conda create -n gammagl python=3.10
    source activate gammagl
 
 **2. Backend:** Select and Install your favorite deep learning backend. For example:
@@ -60,7 +59,7 @@ Install from pip
 
 .. code:: bash
 
-    pip install gammagl
+    pip install gammagl-pt23==0.5.0
 
 Install from source
 -------------------
@@ -69,7 +68,7 @@ Install from source
 
 .. code:: bash
 
-   conda create -n gammagl python=3.8
+   conda create -n gammagl python=3.10
    source activate gammagl
 
 **2. Backend:** Select and Install your favorite deep learning backend. For example:
@@ -88,7 +87,7 @@ Install from source
 
 .. note::
    * For tensorflow, we recommend you to use version under 2.11.0 (For Windows users, please install version 2.10.1 as 2.11 is not supported on Windows).
-   * For pytorch, we support the latest version, e.g. pytorch 2.1.0+cu118.
+   * For pytorch, we support the latest version, e.g. pytorch 2.3.0+cu118.
    * For paddlepaddle, we recommend you to use version under 2.3.2.
    * For mindspore, we support the latest version, e.g. mindspore 2.2.0+cu116.
 
@@ -105,7 +104,7 @@ Install from source
    pip install pybind11 pyparsing
    git clone --recursive https://github.com/BUPT-GAMMA/GammaGL.git
    cd GammaGL
-   python setup.py install
+   python setup.py install build_ext --inplace
 
 .. note::
    * ``pybind11`` and ``pyparsing`` is required, otherwise, you cannot install ``GammaGL`` properly.
diff --git a/docs/source/notes/quick-start.html b/docs/source/notes/quick-start.html
index 834e9c10..c5522cb6 100644
--- a/docs/source/notes/quick-start.html
+++ b/docs/source/notes/quick-start.html
@@ -75,18 +75,17 @@
    <script>
       var torchList = [
          ['pt21', 'PyTorch 2.1.*'],
-         ['pt20', 'PyTorch 2.0.*'],
-         ['pt113', 'PyTorch 1.13.*'],
+         ['pt22', 'PyTorch 2.2.*'],
+         ['pt23', 'PyTorch 2.3.*'],
       ];
    
       var osList = [
          ['linux', 'Linux'],
-         ['windows', 'Windows'],
       ];
    
       var cudaList = [
-         ['post116', '11.6'],
          ['post118', '11.8'],
+         ['post121', '12.1'],
          ['cpu', 'CPU'],
       ];
    
@@ -98,29 +97,13 @@
          var torch = $("#command").attr("torch");
          var os = $("#command").attr("os");
          var cuda = $("#command").attr("cuda");
-   
-         if (os == "windows" && torch != "pt21" && cuda != "cpu") {
-         $("#command pre").text('# Currently, we only support PyTorch 2.1.* and CPU on Windows');
-         }
-   
-         else if (torch == "pt20" && cuda == "post116") {
-         $("#command pre").text('# PyTorch 2.0.* binaries do not support CUDA 11.6');
-         }
-
-         else if (torch == "pt21" && cuda == "post116") {
-         $("#command pre").text('# PyTorch 2.1.* binaries do not support CUDA 11.6');
-         }
-   
-         else if (torch == "pt113" && cuda == "post118") {
-         $("#command pre").text('# PyTorch 1.13.* binaries do not support CUDA 11.8');
-         }
 
-         else if (cuda == "cpu") {
-            $("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.4.0`);
+         if (cuda == "cpu") {
+            $("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.5.0`);
          }
  
          else {
-         $("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.4.0.${$("#command").attr("cuda")}`);
+         $("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.5.0.${$("#command").attr("cuda")}`);
          }
       }