Skip to content

Commit 0110770

Browse files
SherylHYXSherylHYX
committed
docs
1 parent 6ee9134 commit 0110770

3 files changed

Lines changed: 91 additions & 105 deletions

File tree

‎docs/source/modules/data.rst‎

Lines changed: 18 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,74 +7,58 @@ PyTorch Geometric Signed Directed Data Generators and Data Loaders
77
Data Classes
88
-----------------------
99

10-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SignedData
10+
.. autoapiclass:: torch_geometric_signed_directed.data.signed.SignedData.SignedData
1111
:members:
1212
:exclude-members: sqrtinvdiag
1313

1414

15-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.DirectedData
15+
.. autoapiclass:: torch_geometric_signed_directed.data.directed.DirectedData.DirectedData
1616
:members:
1717
:exclude-members:
1818

1919
Data Generators
2020
-----------------------
2121

22-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SSBM
23-
:members:
24-
:exclude-members: fill
22+
.. autoapifunction:: torch_geometric_signed_directed.data.signed.SSBM.SSBM
2523

26-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.polarized_SSBM
27-
:members:
28-
:exclude-members:
24+
.. autoapifunction:: torch_geometric_signed_directed.data.signed.polarized_SSBM.polarized_SSBM
2925

30-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.DSBM
31-
:members:
32-
:exclude-members:
26+
.. autoapifunction:: torch_geometric_signed_directed.data.directed.DSBM.DSBM
3327

34-
.. autoapimodule:: torch_geometric_signed_directed.data.general.SDSBM
35-
:members:
36-
:exclude-members:
28+
.. autoapifunction:: torch_geometric_signed_directed.data.general.SDSBM.SDSBM
3729

3830
Data Loaders
3931
-----------------------
4032

41-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.load_directed_real_data
42-
:members:
43-
:exclude-members:
33+
.. autofunction:: torch_geometric_signed_directed.data.directed.load_directed_real_data.load_directed_real_data
4434

45-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.load_signed_real_data
46-
:members:
47-
:exclude-members:
35+
.. autoapifunction:: torch_geometric_signed_directed.data.signed.load_signed_real_data.load_signed_real_data
4836

49-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.DIGRAC_real_data
50-
:members:
51-
:exclude-members:
37+
.. autoapifunction:: torch_geometric_signed_directed.data.directed.DIGRAC_real_data.DIGRAC_real_data
5238

53-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SSSNET_real_data
54-
:members:
55-
:exclude-members:
39+
.. autoapifunction:: torch_geometric_signed_directed.data.signed.SSSNET_real_data.SSSNET_real_data
5640

57-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SDGNN_real_data
58-
:members:
59-
:exclude-members:
41+
.. autoapifunction:: torch_geometric_signed_directed.data.signed.SDGNN_real_data.SDGNN_real_data
42+
43+
.. autoapifunction:: torch_geometric_signed_directed.data.signed.MSGNN_real_data.MSGNN_real_data
6044

61-
.. autoapimodule:: torch_geometric_signed_directed.data.signed.MSGNN_real_data
45+
.. autoapiclass:: torch_geometric_signed_directed.data.directed.Telegram.Telegram
6246
:members:
6347
:exclude-members:
6448

65-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.Telegram
49+
.. autoapiclass:: torch_geometric_signed_directed.data.directed.WikiCS.WikiCS
6650
:members:
6751
:exclude-members:
6852

69-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.WikiCS
53+
.. autoapiclass:: torch_geometric_signed_directed.data.directed.citation.Cora_ml
7054
:members:
7155
:exclude-members:
7256

73-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.citation
57+
.. autoapiclass:: torch_geometric_signed_directed.data.directed.citation.Citeseer
7458
:members:
7559
:exclude-members:
7660

77-
.. autoapimodule:: torch_geometric_signed_directed.data.directed.WikipediaNetwork
61+
.. autoapiclass:: torch_geometric_signed_directed.data.directed.WikipediaNetwork.WikipediaNetwork
7862
:members:
7963
:exclude-members:
8064

‎docs/source/modules/model.rst‎

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,63 +12,63 @@ layers available in PyTorch Geometric Signed Directed. Each entry includes the
1212
class/function signature and parameter documentation extracted from source
1313
docstrings.
1414

15-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNet_node_classification
15+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.MagNet_node_classification.MagNet_node_classification
1616
:members:
1717
:exclude-members:
1818

19-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_node_classification
19+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCN_node_classification.DiGCN_node_classification
2020
:members:
2121
:exclude-members:
2222

23-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_node_classification
23+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_node_classification.DiGCN_Inception_Block_node_classification
2424
:members:
2525
:exclude-members:
2626

27-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DIGRAC_node_clustering
27+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DIGRAC_node_clustering.DIGRAC_node_clustering
2828
:members:
2929
:exclude-members:
3030

31-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DGCN_node_classification
31+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DGCN_node_classification.DGCN_node_classification
3232
:members:
3333
:exclude-members:
3434

35-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCL
35+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCL.DiGCL
3636
:members:
3737
:exclude-members: DiGCL_Encoder
3838

39-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNet_link_prediction
39+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.MagNet_link_prediction.MagNet_link_prediction
4040
:members:
4141
:exclude-members:
4242

43-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_link_prediction
43+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCN_link_prediction.DiGCN_link_prediction
4444
:members:
4545
:exclude-members:
4646

47-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_link_prediction
47+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_link_prediction.DiGCN_Inception_Block_link_prediction
4848
:members:
4949
:exclude-members:
5050

51-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DGCN_link_prediction
51+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DGCN_link_prediction.DGCN_link_prediction
5252
:members:
5353
:exclude-members:
5454

55-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNetConv
55+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.MagNetConv.MagNetConv
5656
:members:
5757
:exclude-members:
5858

59-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCNConv
59+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCNConv.DiGCNConv
6060
:members:
6161
:exclude-members:
6262

63-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block
63+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block.DiGCN_InceptionBlock
6464
:members:
6565
:exclude-members:
6666

67-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DIMPA
67+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DIMPA.DIMPA
6868
:members:
6969
:exclude-members:
7070

71-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DGCNConv
71+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.DGCNConv.DGCNConv
7272
:members:
7373
:exclude-members:
7474

@@ -78,47 +78,51 @@ Signed (Directed) Network Models and Layers
7878
This section covers methods tailored to signed graphs (including signed
7979
directed settings), with links to model and layer level APIs.
8080

81-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SSSNET_node_clustering
81+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SSSNET_node_clustering.SSSNET_node_clustering
8282
:members:
8383
:exclude-members:
8484

85-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SSSNET_link_prediction
85+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SSSNET_link_prediction.SSSNET_link_prediction
8686
:members:
8787
:exclude-members:
8888

89-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SIMPA
89+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SIMPA.SIMPA
9090
:members:
9191
:exclude-members:
9292

93-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SDGNN
93+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SDGNN.SDGNN
9494
:members:
9595
:exclude-members: SDRLayer
9696

97-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SiGAT
97+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SiGAT.SiGAT
9898
:members:
9999
:exclude-members:
100100

101-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SGCN
101+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SGCN.SGCN
102102
:members:
103103
:exclude-members:
104104

105-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SNEA
105+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SNEA.SNEA
106106
:members:
107107
:exclude-members:
108108

109-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SNEAConv
109+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SNEAConv.SNEAConv
110110
:members:
111111
:exclude-members:
112112

113-
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SGCNConv
113+
.. autoapiclass:: torch_geometric_signed_directed.nn.signed.SGCNConv.SGCNConv
114114
:members:
115115
:exclude-members:
116116

117-
.. autoapimodule:: torch_geometric_signed_directed.nn.general.MSGNN
117+
.. autoapiclass:: torch_geometric_signed_directed.nn.general.MSGNN.MSGNN_link_prediction
118118
:members:
119119
:exclude-members:
120120

121-
.. autoapimodule:: torch_geometric_signed_directed.nn.general.MSConv
121+
.. autoapiclass:: torch_geometric_signed_directed.nn.general.MSGNN.MSGNN_node_classification
122+
:members:
123+
:exclude-members:
124+
125+
.. autoapiclass:: torch_geometric_signed_directed.nn.general.MSConv.MSConv
122126
:members:
123127
:exclude-members:
124128

@@ -130,6 +134,6 @@ Auxiliary Methods and Layers
130134
This section contains supporting layers and helper operations used by the
131135
directed and signed model families.
132136

133-
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.complex_relu
137+
.. autoapiclass:: torch_geometric_signed_directed.nn.directed.complex_relu.complex_relu_layer
134138
:members:
135139
:exclude-members:

‎docs/source/modules/utils.rst‎

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -7,86 +7,84 @@ PyTorch Geometric Signed Directed Utils
77
Task-Specific Objectives and Evaluation Methods
88
--------------
99

10-
.. autoapimodule:: torch_geometric_signed_directed.utils.signed.prob_balanced_normalized_loss
10+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.prob_balanced_normalized_loss.Prob_Balanced_Normalized_Loss
1111
:members:
1212
:exclude-members:
1313

14-
.. autoapimodule:: torch_geometric_signed_directed.utils.signed.prob_balanced_ratio_loss
14+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.prob_balanced_ratio_loss.Prob_Balanced_Ratio_Loss
1515
:members:
1616
:exclude-members:
1717

18-
.. autoapimodule:: torch_geometric_signed_directed.utils.signed.unhappy_ratio
18+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.unhappy_ratio.Unhappy_Ratio
1919
:members:
2020
:exclude-members:
2121

22-
.. autoapimodule:: torch_geometric_signed_directed.utils.signed.link_sign_loss
22+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.link_sign_loss.Sign_Triangle_Loss
2323
:members:
2424
:exclude-members:
2525

26-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.triplet_loss
26+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.link_sign_loss.Sign_Direction_Loss
2727
:members:
2828
:exclude-members:
2929

30+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.link_sign_loss.Sign_Product_Entropy_Loss
31+
:members:
32+
:exclude-members:
3033

31-
.. autoapimodule:: torch_geometric_signed_directed.utils.signed.link_sign_prediction_logistic_function
34+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.link_sign_loss.Link_Sign_Product_Loss
3235
:members:
3336
:exclude-members:
3437

35-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.link_sign_direction_prediction_logistic_function
38+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.link_sign_loss.Link_Sign_Entropy_Loss
3639
:members:
3740
:exclude-members:
3841

39-
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.prob_imbalance_loss
42+
.. autoapiclass:: torch_geometric_signed_directed.utils.signed.link_sign_loss.Sign_Structure_Loss
4043
:members:
4144
:exclude-members:
4245

43-
Utilities and Preprocessing Methods
44-
--------------
46+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.triplet_loss.triplet_loss_node_classification
4547

46-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.link_split
47-
:members:
48-
:exclude-members: undirected_label2directed_label
4948

50-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.node_split
51-
:members:
52-
:exclude-members: get_train_val_test_seed_split, sample_per_class
49+
.. autoapifunction:: torch_geometric_signed_directed.utils.signed.link_sign_prediction_logistic_function.link_sign_prediction_logistic_function
5350

54-
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.features_in_out
55-
:members:
56-
:exclude-members:
51+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.link_sign_direction_prediction_logistic_function.link_sign_direction_prediction_logistic_function
5752

58-
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.get_magnetic_Laplacian
53+
.. autoapiclass:: torch_geometric_signed_directed.utils.directed.prob_imbalance_loss.Prob_Imbalance_Loss
5954
:members:
6055
:exclude-members:
6156

62-
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.DiGCL_utils
63-
:members:
64-
:exclude-members:
57+
Utilities and Preprocessing Methods
58+
--------------
6559

66-
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.get_adjs_DiGCN
67-
:members:
68-
:exclude-members: fast_appr_power
60+
.. autofunction:: torch_geometric_signed_directed.utils.general.link_split.link_class_split
6961

70-
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.meta_graph_generation
71-
:members:
72-
:exclude-members:
62+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.node_split.node_class_split
7363

74-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.extract_network
75-
:members:
76-
:exclude-members:
64+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.features_in_out.directed_features_in_out
7765

78-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.scipy_sparse_to_torch_sparse
79-
:members:
80-
:exclude-members:
66+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.get_magnetic_Laplacian.get_magnetic_Laplacian
8167

82-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.in_out_degree
83-
:members:
84-
:exclude-members:
68+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.DiGCL_utils.drop_feature
8569

86-
.. autoapimodule:: torch_geometric_signed_directed.utils.general.get_magnetic_signed_Laplacian
87-
:members:
88-
:exclude-members:
70+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.DiGCL_utils.pred_digcl_node
8971

90-
.. autoapimodule:: torch_geometric_signed_directed.signed.create_spectral_features
91-
:members:
92-
:exclude-members:
72+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.DiGCL_utils.pred_digcl_link
73+
74+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.get_adjs_DiGCN.cal_fast_appr
75+
76+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.get_adjs_DiGCN.get_appr_directed_adj
77+
78+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.get_adjs_DiGCN.get_second_directed_adj
79+
80+
.. autoapifunction:: torch_geometric_signed_directed.utils.directed.meta_graph_generation.meta_graph_generation
81+
82+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.extract_network.extract_network
83+
84+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.scipy_sparse_to_torch_sparse.scipy_sparse_to_torch_sparse
85+
86+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.in_out_degree.in_out_degree
87+
88+
.. autoapifunction:: torch_geometric_signed_directed.utils.general.get_magnetic_signed_Laplacian.get_magnetic_signed_Laplacian
89+
90+
.. autofunction:: torch_geometric_signed_directed.utils.signed.create_spectral_features.create_spectral_features

0 commit comments

Comments
 (0)
⚡