Skip to content

Commit 83fd195

Browse files
committed
update docs
1 parent 7a64e76 commit 83fd195

File tree

2 files changed

+13
-31
lines changed

2 files changed

+13
-31
lines changed

docs/source/notes/installation.rst

+7-8
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,14 @@ System requrements
66
GammaGL works with the following operating systems:
77

88
* Linux
9-
* Windows (Currently, we only support python 3.9, pytorch 2.1 and CPU on Windows)
109

11-
GammaGL requires Python version 3.9, 3.10, 3.11.
10+
GammaGL requires Python version 3.9, 3.10, 3.11, 3.12.
1211

1312
Backend
1413
-------
1514

1615
- `tensorflow <https://www.tensorflow.org/api_docs/>`_ : We recommend tensorflow version under 2.12.0
17-
- `pytorch <https://pytorch.org/get-started/locally/>`_ : Support version from 1.9 to 2.1, the defalut backend
16+
- `pytorch <https://pytorch.org/get-started/locally/>`_ : Support version from 2.1 to 2.3, the defalut backend
1817
- `paddlepaddle <https://www.paddlepaddle.org.cn/>`_ : We recommend paddlepaddle version under 2.3.2
1918
- `mindspore <https://www.mindspore.cn/install>`_ : Support version to 2.2.10
2019

@@ -33,7 +32,7 @@ Install from pip
3332

3433
.. code:: bash
3534
36-
conda create -n gammagl python=3.9
35+
conda create -n gammagl python=3.10
3736
source activate gammagl
3837
3938
**2. Backend:** Select and Install your favorite deep learning backend. For example:
@@ -60,7 +59,7 @@ Install from pip
6059

6160
.. code:: bash
6261
63-
pip install gammagl
62+
pip install gammagl-pt23==0.5.0
6463
6564
Install from source
6665
-------------------
@@ -69,7 +68,7 @@ Install from source
6968

7069
.. code:: bash
7170
72-
conda create -n gammagl python=3.8
71+
conda create -n gammagl python=3.10
7372
source activate gammagl
7473
7574
**2. Backend:** Select and Install your favorite deep learning backend. For example:
@@ -88,7 +87,7 @@ Install from source
8887
8988
.. note::
9089
* 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).
91-
* For pytorch, we support the latest version, e.g. pytorch 2.1.0+cu118.
90+
* For pytorch, we support the latest version, e.g. pytorch 2.3.0+cu118.
9291
* For paddlepaddle, we recommend you to use version under 2.3.2.
9392
* For mindspore, we support the latest version, e.g. mindspore 2.2.0+cu116.
9493

@@ -105,7 +104,7 @@ Install from source
105104
pip install pybind11 pyparsing
106105
git clone --recursive https://github.com/BUPT-GAMMA/GammaGL.git
107106
cd GammaGL
108-
python setup.py install
107+
python setup.py install build_ext --inplace
109108
110109
.. note::
111110
* ``pybind11`` and ``pyparsing`` is required, otherwise, you cannot install ``GammaGL`` properly.

docs/source/notes/quick-start.html

+6-23
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,17 @@
7575
<script>
7676
var torchList = [
7777
['pt21', 'PyTorch 2.1.*'],
78-
['pt20', 'PyTorch 2.0.*'],
79-
['pt113', 'PyTorch 1.13.*'],
78+
['pt22', 'PyTorch 2.2.*'],
79+
['pt23', 'PyTorch 2.3.*'],
8080
];
8181

8282
var osList = [
8383
['linux', 'Linux'],
84-
['windows', 'Windows'],
8584
];
8685

8786
var cudaList = [
88-
['post116', '11.6'],
8987
['post118', '11.8'],
88+
['post121', '12.1'],
9089
['cpu', 'CPU'],
9190
];
9291

@@ -98,29 +97,13 @@
9897
var torch = $("#command").attr("torch");
9998
var os = $("#command").attr("os");
10099
var cuda = $("#command").attr("cuda");
101-
102-
if (os == "windows" && torch != "pt21" && cuda != "cpu") {
103-
$("#command pre").text('# Currently, we only support PyTorch 2.1.* and CPU on Windows');
104-
}
105-
106-
else if (torch == "pt20" && cuda == "post116") {
107-
$("#command pre").text('# PyTorch 2.0.* binaries do not support CUDA 11.6');
108-
}
109-
110-
else if (torch == "pt21" && cuda == "post116") {
111-
$("#command pre").text('# PyTorch 2.1.* binaries do not support CUDA 11.6');
112-
}
113-
114-
else if (torch == "pt113" && cuda == "post118") {
115-
$("#command pre").text('# PyTorch 1.13.* binaries do not support CUDA 11.8');
116-
}
117100

118-
else if (cuda == "cpu") {
119-
$("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.4.0`);
101+
if (cuda == "cpu") {
102+
$("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.5.0`);
120103
}
121104

122105
else {
123-
$("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.4.0.${$("#command").attr("cuda")}`);
106+
$("#command pre").text(`pip install gammagl-${$("#command").attr("torch")}==0.5.0.${$("#command").attr("cuda")}`);
124107
}
125108
}
126109

0 commit comments

Comments
 (0)