[Test] add regression tests for graph partitioning. (dmlc#1561)

* add tests.

* 111

* fix

* Update asv.conf.json

* fix.

* benchmark partition with livejournal.

* fix benchmark

* fix.

* fix.

* remove ogb

* Revert "Update asv.conf.json"

This reverts commit dd327a5.

* change branch

* depend pandas

* Revert "change branch"

This reverts commit 1d4f937.

* Update README.md

Co-authored-by: VoVAllen <[email protected]>
Co-authored-by: Jinjing Zhou <[email protected]>

Author: zheng-da

asv.conf.json

@@ -142,4 +142,4 @@
     //    "some_benchmark": 0.01,     // Threshold of 1%
     //    "another_benchmark": 0.5,   // Threshold of 50%
     // },
-}
+}

tests/regression/README.md

@@ -21,12 +21,7 @@ The basic use is execute a script, and get the needed results out of the printed
 The default regression branch in asv is `master`. If you need to run on other branch on your fork, please change the `branches` value in the `asv.conf.json` at the root of your repo.
 
 ```bash
-docker run --name dgl-reg --rm --hostname=reg-machine --runtime=nvidia -dit dgllib/dgl-ci-gpu:conda /bin/bash
-docker cp ./asv_data dgl-reg:/root/asv_data/
-docker cp ./run.sh dgl-reg:/root/run.sh <repo> <branch>
-docker exec dgl-reg bash /root/asv_data/run.sh
-docker cp dgl-reg:/root/regression/dgl/asv/. ./asv_data/  # Change /home/ubuntu/asv to the path you want to put the result
-docker stop dgl-reg
+bash ./publish.sh <repo> <branch>
 ```
 
 The running result will be at `./asv_data/`. You can use `python -m http.server` inside the `html` folder to start a server to see the result

tests/regression/bench_partition.py

@@ -0,0 +1,49 @@
+# Write the benchmarking functions here.
+# See "Writing benchmarks" in the asv docs for more information.
+
+import subprocess
+import os
+from pathlib import Path
+import numpy as np
+import tempfile
+
+base_path = Path("~/regression/dgl/")
+
+class PartitionBenchmark:
+
+    params = [['pytorch'], ['livejournal']]
+    param_names = ['backend', 'dataset']
+    timeout = 600
+
+    def __init__(self):
+        self.std_log = {}
+
+    def setup(self, backend, dataset):
+        key_name = "{}_{}".format(backend, dataset)
+        if key_name in self.std_log:
+            return
+        bench_path = base_path / "tests/regression/benchmarks/partition.py"
+        bashCommand = "/opt/conda/envs/{}-ci/bin/python {} --dataset {}".format(
+            backend, bench_path.expanduser(), dataset)
+        process = subprocess.Popen(bashCommand.split(), stdout=subprocess.PIPE,env=dict(os.environ, DGLBACKEND=backend))
+        output, error = process.communicate()
+        print(str(error))
+        self.std_log[key_name] = str(output)
+
+
+    def track_partition_time(self, backend, dataset):
+        key_name = "{}_{}".format(backend, dataset)
+        lines = self.std_log[key_name].split("\\n")
+
+        time_list = []
+        for line in lines:
+            # print(line)
+            if 'Time:' in line:
+                time_str = line.strip().split(' ')[1]
+                time = float(time_str)
+                time_list.append(time)
+        return np.array(time_list).mean()
+
+
+PartitionBenchmark.track_partition_time.unit = 's'
+

tests/regression/benchmarks/partition.py

@@ -0,0 +1,17 @@
+import dgl
+from dgl import distributed as dgl_distributed
+import argparse, time
+from utils import get_graph
+
+parser = argparse.ArgumentParser(description='partition')
+parser.add_argument("--dataset", type=str, default='livejournal',
+                    help="specify the graph for partitioning")
+parser.add_argument("--num_parts", type=int, default=16,
+                    help="the number of partitions")
+args = parser.parse_args()
+
+g = get_graph(args.dataset)
+print('{}: |V|={}, |E|={}'.format(args.dataset, g.number_of_nodes(), g.number_of_edges()))
+start = time.time()
+dgl_distributed.partition_graph(g, args.dataset, args.num_parts, '/tmp', num_hops=1, part_method="metis")
+print('Time: {} seconds'.format(time.time() - start))

tests/regression/benchmarks/utils.py

@@ -0,0 +1,37 @@
+import os
+import shutil, zipfile
+import requests
+import numpy as np
+import pandas
+import dgl
+
+def _download(url, path, filename):
+    fn = os.path.join(path, filename)
+    if os.path.exists(fn):
+        return
+
+    os.makedirs(path, exist_ok=True)
+    f_remote = requests.get(url, stream=True)
+    sz = f_remote.headers.get('content-length')
+    assert f_remote.status_code == 200, 'fail to open {}'.format(url)
+    with open(fn, 'wb') as writer:
+        for chunk in f_remote.iter_content(chunk_size=1024*1024):
+            writer.write(chunk)
+    print('Download finished.')
+
+def get_livejournal():
+    _download('https://snap.stanford.edu/data/soc-LiveJournal1.txt.gz',
+              '/tmp', 'soc-LiveJournal1.txt.gz')
+    df = pandas.read_csv('/tmp/soc-LiveJournal1.txt.gz', sep='\t', skiprows=4, header=None,
+                         names=['src', 'dst'], compression='gzip')
+    src = np.array(df['src'])
+    dst = np.array(df['dst'])
+    print('construct the graph')
+    return dgl.DGLGraph((src, dst), readonly=True)
+
+def get_graph(name):
+    if name == 'livejournal':
+        return get_livejournal()
+    else:
+        print(name + " doesn't exist")
+        return None

tests/regression/install_dgl_asv.sh

@@ -16,6 +16,7 @@ pip uninstall -y dgl
 python3 setup.py install
 # test inplace build (for cython)
 python3 setup.py build_ext --inplace
+python3 -m pip install -r /root/requirement.txt
 done
 popd
 conda deactivate

tests/regression/publish.sh

@@ -10,9 +10,10 @@ else
     BRANCH=$2
 fi
 
-docker run --name dgl-reg --rm --hostname=reg-machine --runtime=nvidia -dit dgllib/dgl-ci-gpu:conda /bin/bash
+docker run --name dgl-reg --rm --runtime=nvidia --hostname=reg-machine -dit dgllib/dgl-ci-gpu:conda /bin/bash
 docker cp ./asv_data dgl-reg:/root/asv_data/
 docker cp ./run.sh dgl-reg:/root/run.sh
+docker cp ./requirement.txt dgl-reg:/root/requirement.txt
 docker exec dgl-reg bash /root/run.sh $REPO $BRANCH
 docker cp dgl-reg:/root/regression/dgl/asv/. ./asv_data/
 docker stop dgl-reg

tests/regression/requirement.txt

@@ -0,0 +1 @@
+pandas