Change the way of setting backends (#87)

Thinklab-SJTU · Nov 13, 2023 · 0307736 · 0307736
1 parent 546bfd7
commit 0307736
Show file tree

Hide file tree

Showing 35 changed files with 191 additions and 118 deletions.
diff --git a/docs/guide/get_started.rst b/docs/guide/get_started.rst
@@ -46,7 +46,7 @@ Step 0: Import packages and set backend
 
     >>> import numpy as np
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'numpy'
+    >>> pygm.set_backend('numpy')
     >>> np.random.seed(1)
 
 Step 1: Generate a batch of isomorphic graphs

diff --git a/docs/guide/numerical_backends.rst b/docs/guide/numerical_backends.rst
@@ -16,7 +16,7 @@ Once the backend is ready, you may switch to the backend globally by the followi
 ::
 
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'pytorch'  # replace 'pytorch' by other backend names
+    >>> pygm.set_backend('pytorch')  # replace 'pytorch' by other backend names
 
 PyTorch Backend
 ------------------------
@@ -41,7 +41,7 @@ How to enable PyTorch backend:
 
     >>> import pygmtools as pygm
     >>> import torch
-    >>> pygm.BACKEND = 'pytorch'
+    >>> pygm.set_backend('pytorch')
 
 Example: Matching Isomorphic Graphs with ``pytorch`` backend
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -55,7 +55,7 @@ Step 0: Import packages and set backend
 
     >>> import torch # pytorch backend
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'pytorch'
+    >>> pygm.set_backend('pytorch')
     >>> torch.manual_seed(1) # fix random seed
 
 Step 1: Generate two isomorphic graphs
@@ -130,7 +130,7 @@ How to enable Jittor backend:
 
     >>> import pygmtools as pygm
     >>> import jittor
-    >>> pygm.BACKEND = 'jittor'
+    >>> pygm.set_backend('jittor')
 
 
 Example: Matching Isomorphic Graphs with ``jittor`` backend
@@ -145,7 +145,7 @@ Step 0: Import packages and set backend
 
     >>> import jittor as jt # jittor backend
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'jittor'
+    >>> pygm.set_backend('jittor')
     >>> jt.set_seed(1) # fix random seed
     >>> jt.flags.use_cuda = jt.has_cuda # detect cuda
 
@@ -221,7 +221,7 @@ How to enable Paddle backend:
 
     >>> import pygmtools as pygm
     >>> import paddle
-    >>> pygm.BACKEND = 'paddle'
+    >>> pygm.set_backend('paddle')
 
 Example: Matching Isomorphic Graphs with ``paddle`` backend
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -235,7 +235,7 @@ Step 0: Import packages and set backend
 
     >>> import paddle # paddle backend
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'paddle'
+    >>> pygm.set_backend('paddle')
     >>> paddle.seed(1) # fix random seed
     >>> paddle.device.set_device('cpu') # set cpu
 
@@ -312,7 +312,7 @@ How to enable Tensorflow backend:
 
     >>> import pygmtools as pygm
     >>> import tensorflow
-    >>> pygm.BACKEND = 'tensorflow'
+    >>> pygm.set_backend('tensorflow')
 
 Example: Matching Isomorphic Graphs with ``tensorflow`` backend
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -326,7 +326,7 @@ Step 0: Import packages and set backend
 
     >>> import tensorflow as tf # tensorflow backend
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'tensorflow'
+    >>> pygm.set_backend('tensorflow')
     >>> _ = tf.random.set_seed(1) # fix random seed
 
 Step 1: Generate two isomorphic graphs
@@ -401,7 +401,7 @@ How to enable Mindspore backend:
 
     >>> import pygmtools as pygm
     >>> import mindspore
-    >>> pygm.BACKEND = 'mindspore'
+    >>> pygm.set_backend('mindspore')
 
 Example: Matching Isomorphic Graphs with ``mindspore`` backend
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -415,7 +415,7 @@ Step 0: Import packages and set backend
 
     >>> import mindspore as ms # mindspore backend
     >>> import pygmtools as pygm
-    >>> pygm.BACKEND = 'mindspore'
+    >>> pygm.set_backend('mindspore')
     >>> _ = ms.set_seed(1) # fix random seed
 
 Step 1: Generate two isomorphic graphs

diff --git a/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_jittor.py b/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_jittor.py
@@ -31,7 +31,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'jittor' # set default backend for pygmtools
+pygm.set_backend('jittor') # set default backend for pygmtools
 _ = jt.set_seed(1) # fix random seed
 
 jt.flags.use_cuda = jt.has_cuda

diff --git a/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_numpy.py b/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_numpy.py
@@ -31,7 +31,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'numpy' # set default backend for pygmtools
+pygm.set_backend('numpy') # set default backend for pygmtools
 np.random.seed(1) # fix random seed
 
 ##############################################################################

diff --git a/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_paddle.py b/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_paddle.py
@@ -33,7 +33,7 @@
 import networkx as nx # for plotting graphs
 import warnings
 warnings.filterwarnings("ignore")
-pygm.BACKEND = 'paddle' # set default backend for pygmtools
+pygm.set_backend('paddle') # set default backend for pygmtools
 
 paddle.device.set_device('cpu')
 _ = paddle.seed(1) # fix random seed

diff --git a/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_pytorch.py b/examples/1.matching_isomorphic_graphs/plot_isomorphic_graphs_pytorch.py
@@ -30,7 +30,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'pytorch' # set default backend for pygmtools
+pygm.set_backend('pytorch') # set default backend for pygmtools
 _ = torch.manual_seed(1) # fix random seed
 
 ##############################################################################

diff --git a/examples/2.seeded_graph_matching/plot_seed_graph_match_jittor.py b/examples/2.seeded_graph_matching/plot_seed_graph_match_jittor.py
@@ -35,7 +35,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'jittor' # set default backend for pygmtools
+pygm.set_backend('jittor') # set default backend for pygmtools
 _ = jt.set_seed(1) # fix random seed
 
 jt.flags.use_cuda = jt.has_cuda

diff --git a/examples/2.seeded_graph_matching/plot_seed_graph_match_numpy.py b/examples/2.seeded_graph_matching/plot_seed_graph_match_numpy.py
@@ -35,7 +35,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'numpy' # set default backend for pygmtools
+pygm.set_backend('numpy') # set default backend for pygmtools
 np.random.seed(1) # fix random seed
 
 ##############################################################################

diff --git a/examples/2.seeded_graph_matching/plot_seed_graph_match_paddle.py b/examples/2.seeded_graph_matching/plot_seed_graph_match_paddle.py
@@ -38,7 +38,7 @@
 import warnings
 warnings.filterwarnings("ignore")
 
-pygm.BACKEND = 'paddle' # set default backend for pygmtools
+pygm.set_backend('paddle') # set default backend for pygmtools
 
 paddle.device.set_device('cpu')
 _ = paddle.seed(1) # fix random seed

diff --git a/examples/2.seeded_graph_matching/plot_seed_graph_match_pytorch.py b/examples/2.seeded_graph_matching/plot_seed_graph_match_pytorch.py
@@ -34,7 +34,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'pytorch' # set default backend for pygmtools
+pygm.set_backend('pytorch') # set default backend for pygmtools
 _ = torch.manual_seed(1) # fix random seed
 
 ##############################################################################

diff --git a/examples/3.discovering_subgraphs/plot_subgraphs_jittor.py b/examples/3.discovering_subgraphs/plot_subgraphs_jittor.py
@@ -30,7 +30,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'jittor' # set default backend for pygmtools
+pygm.set_backend('jittor') # set default backend for pygmtools
 _ = jt.set_seed(1) # fix random seed
 
 jt.flags.use_cuda = jt.has_cuda

diff --git a/examples/3.discovering_subgraphs/plot_subgraphs_numpy.py b/examples/3.discovering_subgraphs/plot_subgraphs_numpy.py
@@ -30,7 +30,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'numpy' # set default backend for pygmtools
+pygm.set_backend('numpy') # set default backend for pygmtools
 np.random.seed(1) # fix random seed
 
 ##############################################################################

diff --git a/examples/3.discovering_subgraphs/plot_subgraphs_paddle.py b/examples/3.discovering_subgraphs/plot_subgraphs_paddle.py
@@ -33,7 +33,7 @@
 import warnings
 warnings.filterwarnings("ignore")
 
-pygm.BACKEND = 'paddle' # set default backend for pygmtools
+pygm.set_backend('paddle') # set default backend for pygmtools
 
 paddle.device.set_device('cpu')
 _ = paddle.seed(1) # fix random seed

diff --git a/examples/3.discovering_subgraphs/plot_subgraphs_pytorch.py b/examples/3.discovering_subgraphs/plot_subgraphs_pytorch.py
@@ -29,7 +29,7 @@
 import matplotlib.pyplot as plt # for plotting
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 import networkx as nx # for plotting graphs
-pygm.BACKEND = 'pytorch' # set default backend for pygmtools
+pygm.set_backend('pytorch') # set default backend for pygmtools
 _ = torch.manual_seed(1) # fix random seed
 
 ##############################################################################

diff --git a/examples/4.multi-graph_matching/plot_multi_graph_match_jittor.py b/examples/4.multi-graph_matching/plot_multi_graph_match_jittor.py
@@ -41,7 +41,7 @@
 from PIL import Image
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 
-pygm.BACKEND = 'jittor'  # set default backend for pygmtools
+pygm.set_backend('jittor')  # set default backend for pygmtools
 jt.flags.use_cuda = True
 ##############################################################################
 # Load the images

diff --git a/examples/4.multi-graph_matching/plot_multi_graph_match_numpy.py b/examples/4.multi-graph_matching/plot_multi_graph_match_numpy.py
@@ -40,7 +40,7 @@
 from PIL import Image
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 
-pygm.BACKEND = 'numpy'  # set default backend for pygmtools
+pygm.set_backend('numpy')  # set default backend for pygmtools
 
 
 ##############################################################################

diff --git a/examples/4.multi-graph_matching/plot_multi_graph_match_paddle.py b/examples/4.multi-graph_matching/plot_multi_graph_match_paddle.py
@@ -41,7 +41,7 @@
 from PIL import Image
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 
-pygm.BACKEND = 'paddle'  # set default backend for pygmtools
+pygm.set_backend('paddle')  # set default backend for pygmtools
 
 ##############################################################################
 # Load the images

diff --git a/examples/4.multi-graph_matching/plot_multi_graph_match_pytorch.py b/examples/4.multi-graph_matching/plot_multi_graph_match_pytorch.py
@@ -40,7 +40,7 @@
 from PIL import Image
 from matplotlib.patches import ConnectionPatch # for plotting matching result
 
-pygm.BACKEND = 'pytorch'  # set default backend for pygmtools
+pygm.set_backend('pytorch')  # set default backend for pygmtools
 
 
 ##############################################################################

diff --git a/examples/5.model_fusion/plot_model_fusion_jittor.py b/examples/5.model_fusion/plot_model_fusion_jittor.py
@@ -40,7 +40,7 @@
 import matplotlib.pyplot as plt
 import pygmtools as pygm
 
-pygm.BACKEND = 'jittor'
+pygm.set_backend('jittor')
 jt.flags.use_cuda = jt.has_cuda
 
 ##############################################################################

diff --git a/examples/5.model_fusion/plot_model_fusion_paddle.py b/examples/5.model_fusion/plot_model_fusion_paddle.py
@@ -43,7 +43,7 @@
 import warnings
 warnings.filterwarnings("ignore")
 
-pygm.BACKEND = 'paddle'
+pygm.set_backend('paddle')
 device = paddle.device.get_device()
 paddle.device.set_device(device)
 

diff --git a/examples/5.model_fusion/plot_model_fusion_pytorch.py b/examples/5.model_fusion/plot_model_fusion_pytorch.py
@@ -41,7 +41,7 @@
 import matplotlib.pyplot as plt
 import pygmtools as pygm
 
-pygm.BACKEND = 'pytorch'
+pygm.set_backend('pytorch')
 device = torch.device('cuda:0' if torch.cuda.is_available() else 'cpu')
 
 

diff --git a/examples/6.image_matching_by_QAP/plot_image_matching_jittor.py b/examples/6.image_matching_by_QAP/plot_image_matching_jittor.py
@@ -38,7 +38,7 @@
 import itertools
 import numpy as np
 from PIL import Image
-pygm.BACKEND = 'jittor' # set default backend for pygmtools
+pygm.set_backend('jittor') # set default backend for pygmtools
 
 jt.flags.use_cuda = jt.has_cuda
 

diff --git a/examples/6.image_matching_by_QAP/plot_image_matching_numpy.py b/examples/6.image_matching_by_QAP/plot_image_matching_numpy.py
@@ -37,7 +37,7 @@
 from sklearn.decomposition import PCA as PCAdimReduc
 import itertools
 from PIL import Image
-pygm.BACKEND = 'numpy' # set numpy as backend for pygmtools
+pygm.set_backend('numpy') # set numpy as backend for pygmtools
 
 ##############################################################################
 # Load the images

diff --git a/examples/6.image_matching_by_QAP/plot_image_matching_paddle.py b/examples/6.image_matching_by_QAP/plot_image_matching_paddle.py
@@ -40,7 +40,7 @@
 from PIL import Image
 import warnings
 warnings.filterwarnings("ignore")
-pygm.BACKEND = 'paddle' # set default backend for pygmtools
+pygm.set_backend('paddle') # set default backend for pygmtools
 
 ##############################################################################
 # Load the images

diff --git a/examples/6.image_matching_by_QAP/plot_image_matching_pytorch.py b/examples/6.image_matching_by_QAP/plot_image_matching_pytorch.py
@@ -37,7 +37,7 @@
 import itertools
 import numpy as np
 from PIL import Image
-pygm.BACKEND = 'pytorch' # set default backend for pygmtools
+pygm.set_backend('pytorch') # set default backend for pygmtools
 
 ##############################################################################
 # Load the images

diff --git a/examples/7.image_matching_by_NN/plot_deep_image_matching_jittor.py b/examples/7.image_matching_by_NN/plot_deep_image_matching_jittor.py
@@ -36,7 +36,7 @@
 import itertools
 import numpy as np
 from PIL import Image
-pygm.BACKEND = 'jittor' # set default backend for pygmtools
+pygm.set_backend('jittor') # set default backend for pygmtools
 jt.flags.use_cuda = jt.has_cuda
 
 ##############################################################################

diff --git a/examples/7.image_matching_by_NN/plot_deep_image_matching_paddle.py b/examples/7.image_matching_by_NN/plot_deep_image_matching_paddle.py
@@ -38,7 +38,7 @@
 from PIL import Image
 import warnings
 warnings.filterwarnings("ignore")
-pygm.BACKEND = 'paddle' # set default backend for pygmtools
+pygm.set_backend('paddle') # set default backend for pygmtools
 
 device = paddle.device.get_device()
 paddle.device.set_device(device) # paddle sets device globally

diff --git a/examples/7.image_matching_by_NN/plot_deep_image_matching_pytorch.py b/examples/7.image_matching_by_NN/plot_deep_image_matching_pytorch.py
@@ -35,7 +35,7 @@
 import itertools
 import numpy as np
 from PIL import Image
-pygm.BACKEND = 'pytorch' # set default backend for pygmtools
+pygm.set_backend('pytorch') # set default backend for pygmtools
 
 ##############################################################################
 # Predicting Matching by Graph Matching Neural Networks

diff --git a/pygmtools/__init__.py b/pygmtools/__init__.py
@@ -15,10 +15,21 @@
 from .neural_solvers import pca_gm, ipca_gm, cie, ngm, genn_astar
 import pygmtools.utils as utils
 import importlib.util
+set_backend = utils.set_backend
+
 BACKEND = 'numpy'
 __version__ = '0.4.2a2'
 __author__ = 'ThinkLab at SJTU'
 
+SUPPORTED_BACKENDS = [
+    'numpy',
+    'pytorch',
+    'jittor',
+    'paddle',
+    'mindspore',
+    'tensorflow'
+]
+
 
 def env_report():
     """