Merge pull request #142 from bfGraph/develop

📦 STGraph v1.1.0

Author: nithinmanoj10

.github/workflows/pytest.yaml

@@ -0,0 +1,28 @@
+name: Run Unit Test via Pytest  
+  
+on: [push]  
+  
+jobs:  
+  build:  
+    runs-on: ubuntu-latest  
+    strategy:  
+      matrix:  
+        python-version: ["3.8"]  
+  
+    steps:  
+      - uses: actions/checkout@v3  
+      - name: Set up Python ${{ matrix.python-version }}  
+        uses: actions/setup-python@v4  
+        with:  
+          python-version: ${{ matrix.python-version }}  
+      - name: Install dependencies  
+        run: |  
+          python -m pip install --upgrade pip  
+          pip install -e .[dev]
+          pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
+      - name: Test with pytest  
+        run: |  
+          coverage run -m pytest  -v -s -p no:warnings
+      - name: Generate Coverage Report  
+        run: |  
+          coverage report -m

.github/workflows/ruff.yaml

@@ -0,0 +1,34 @@
+name: Ruff Linting
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install ruff
+    - name: Analysing the code with ruff
+      run: |
+        cd stgraph/dataset/
+        ruff check .
+        cd ../../
+        cd stgraph/graph
+        ruff check .
+        cd ../../
+        cd stgraph/utils
+        ruff check .
+        cd ../../
+        cd stgraph/nn/pytorch/static
+        ruff check gcn_conv.py
+        cd ../../../../

.gitignore

@@ -13,7 +13,10 @@ benchmarking/results/
 *.egg-info/
 stgraph/build/
 stgraph/dist/
+dev-stgraph/
 docs/_build
+docs_old/
+docs_v2/
 __pycache__/
 .DS_Store
 build
@@ -25,4 +28,9 @@ dist
 *.svg
 *.json
 *.npy
-dev-stgraph/
+.coverage
+dev-stgraph/
+htmlconv/
+*.txt
+egl_kernel.cu
+egl_kernel.ptx

.idea/STGraph.iml

@@ -0,0 +1,15 @@
+[FORMAT]
+
+# Set the maximum line length to a value that suits your project
+max-line-length = 120
+
+[MESSAGES CONTROL]
+
+# Disable specific messages by adding them to the "disable" option
+disable=
+    line-too-long,
+    too-many-instance-attributes,
+    too-many-arguments,
+    import-error,
+    too-few-public-methods,
+    # Add more disabled messages here if needed

.idea/inspectionProfiles/profiles_settings.xml

@@ -13,13 +13,13 @@ build:
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+   configuration: docs/source/conf.py
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
    install:
-   - requirements: requirements.txt
+   - requirements: docs/requirements.txt
    - method: pip
      path: .

.idea/modules.xml

@@ -7,6 +7,7 @@
 
 [![Documentation Status](https://readthedocs.org/projects/stgraph/badge/?version=latest)](https://stgraph.readthedocs.io/en/latest/?badge=latest)
 [![TGL Workshop - @ NeurIPS'23](https://img.shields.io/badge/TGL_Workshop-%40_NeurIPS'23-6d4a8f)](https://neurips.cc/virtual/2023/76335)
+[![GrAPL - @IPDPS'24](https://img.shields.io/badge/GrAPL-%40IPDPS'24-282792)](https://hpc.pnl.gov/grapl/index.html)
 [![PyPI - 1.0.0](https://img.shields.io/static/v1?label=PyPI&message=1.0.0&color=%23ffdf76&logo=Python)](https://pypi.org/project/stgraph/)
 
 <div align="center">
@@ -104,68 +105,7 @@ With this you have successfully installed STGraph locally to make development ch
 
 ## Running your first STGraph Program
 
-In this is quick mini tutorial, we will show you how to train a simple GCN model on the Cora dataset. After installing STGraph and entering the STGraph directory, enter the following commands to reach the GCN `benchmarking` folder
-
-```
-cd benchmarking/gcn/stgraph
-```
-
-Run the `train.py`, with 100 epochs and specify the dataset name. For this example, we shall use Cora
-
-```
-python3 train.py --num_epochs 100 --dataset cora
-```
-
-You should get an output like this. The initial prints are truncated.
-
-```
-.
-.
-.
-Epoch 00090 | Time(s) 0.0048 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00091 | Time(s) 0.0024 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00092 | Time(s) 0.0029 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00093 | Time(s) 0.0029 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00094 | Time(s) 0.0027 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00095 | Time(s) 0.0030 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00096 | Time(s) 0.0024 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00097 | Time(s) 0.0022 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00098 | Time(s) 0.0022 | train_acc 0.303791 | Used_Memory 32.975098 mb
-Epoch 00099 | Time(s) 0.0036 | train_acc 0.303791 | Used_Memory 32.975098 mb
-
-^^^0.032202^^^0.003098
-```
-
-If you don't get this output and have followed every single step in the setting up and installation section, please raise an issue we will look into it.
-
-## How to build STGraph
-
-This is for users who want to make changes to the STGraph codebase and get it build each time. Follow the steps mentioned to properly build STGraph.
-
-### Compiling the CUDA code
-
-The following steps need to be done if you made any changes to any CUDA files within the `stgraph/graph` directory for each graph representation.
-
-STGraph supports training dynamic and static graphs. To handle all the graph representations logic, it is written as a PyBind11 module over a CUDA file. As of now the following CUDA code for different graph representations exists
-
-1. `csr.cu`
-2. `pcsr.cu`
-3. `gpma.cu`
-
-To compile the `[name].cu` file, run the following command
-
-```
-/usr/local/cuda-11.7/bin/nvcc $(python3 -m pybind11 --includes) -shared -rdc=true --compiler-options '-fPIC' -D__CDPRT_SUPPRESS_SYNC_DEPRECATION_WARNING -o [name].so [name].cu
-```
-This would generate the [name].so shared object file, that is used in the STGraph module. 
-
-### Building STGraph
-
-Make sure to go back to the root directory and run the following to build and install STGraph
-
-```
- python3 -m build && pip uninstall stgraph -y && pip install dist/stgraph-1.0.0-py3-none-any.whl
-```
+Please have a look inside the `tutorials/` directory to write and train your own GNNs using STGraph
 
 ## Contributing
 

.idea/vcs.xml

@@ -9,7 +9,7 @@
 import os
 from model import PyGT_TGCN
 from stgraph.dataset.LinkPredDataLoader import LinkPredDataLoader
-from stgraph.benchmark_tools.table import BenchmarkTable
+from stgraph.utils import DataTable
 from utils import to_default_device, get_default_device
 
 def main(args):
@@ -71,7 +71,7 @@ def main(args):
     # metrics
     dur = []
     max_gpu = []
-    table = BenchmarkTable(f"(PyGT Dynamic-Temporal) TGCN on {dataloader.name} dataset", ["Epoch", "Time(s)", "MSE", "Used GPU Memory (Max MB)"])
+    table = DataTable(f"(PyGT Dynamic-Temporal) TGCN on {dataloader.name} dataset", ["Epoch", "Time(s)", "MSE", "Used GPU Memory (Max MB)"])
 
     try:
         # train