Skip to content

Commit 3f10c9a

Browse files
SherylHYXSherylHYX
committed
doc
1 parent cf3fb84 commit 3f10c9a

5 files changed

Lines changed: 64 additions & 93 deletions

File tree

‎docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'sphinx.ext.githubpages',
2020
]
2121

22-
master_doc = 'modules/root'
22+
master_doc = 'index'
2323
source_suffix = '.rst'
2424

2525
html_theme = 'sphinx_rtd_theme'

‎docs/source/modules/data.rst‎

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

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

1414

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

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

22-
.. automodule:: torch_geometric_signed_directed.data.signed.SSBM
22+
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SSBM
2323
:members:
2424
:exclude-members: fill
2525

26-
.. automodule:: torch_geometric_signed_directed.data.signed.polarized_SSBM
26+
.. autoapimodule:: torch_geometric_signed_directed.data.signed.polarized_SSBM
2727
:members:
2828
:exclude-members:
2929

30-
.. automodule:: torch_geometric_signed_directed.data.directed.DSBM
30+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.DSBM
3131
:members:
3232
:exclude-members:
3333

34-
.. automodule:: torch_geometric_signed_directed.data.general.SDSBM
34+
.. autoapimodule:: torch_geometric_signed_directed.data.general.SDSBM
3535
:members:
3636
:exclude-members:
3737

3838
Data Loaders
3939
-----------------------
4040

41-
.. automodule:: torch_geometric_signed_directed.data.directed.load_directed_real_data
41+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.load_directed_real_data
4242
:members:
4343
:exclude-members:
4444

45-
.. automodule:: torch_geometric_signed_directed.data.signed.load_signed_real_data
45+
.. autoapimodule:: torch_geometric_signed_directed.data.signed.load_signed_real_data
4646
:members:
4747
:exclude-members:
4848

49-
.. automodule:: torch_geometric_signed_directed.data.directed.DIGRAC_real_data
49+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.DIGRAC_real_data
5050
:members:
5151
:exclude-members:
5252

53-
.. automodule:: torch_geometric_signed_directed.data.signed.SSSNET_real_data
53+
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SSSNET_real_data
5454
:members:
5555
:exclude-members:
5656

57-
.. automodule:: torch_geometric_signed_directed.data.signed.SDGNN_real_data
57+
.. autoapimodule:: torch_geometric_signed_directed.data.signed.SDGNN_real_data
5858
:members:
5959
:exclude-members:
6060

61-
.. automodule:: torch_geometric_signed_directed.data.signed.MSGNN_real_data
61+
.. autoapimodule:: torch_geometric_signed_directed.data.signed.MSGNN_real_data
6262
:members:
6363
:exclude-members:
6464

65-
.. automodule:: torch_geometric_signed_directed.data.directed.Telegram
65+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.Telegram
6666
:members:
6767
:exclude-members:
6868

69-
.. automodule:: torch_geometric_signed_directed.data.directed.WikiCS
69+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.WikiCS
7070
:members:
7171
:exclude-members:
7272

73-
.. automodule:: torch_geometric_signed_directed.data.directed.citation
73+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.citation
7474
:members:
7575
:exclude-members:
7676

77-
.. automodule:: torch_geometric_signed_directed.data.directed.WikipediaNetwork
77+
.. autoapimodule:: torch_geometric_signed_directed.data.directed.WikipediaNetwork
7878
:members:
7979
:exclude-members:
8080

‎docs/source/modules/model.rst‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,110 +7,110 @@ PyTorch Geometric Signed Directed Models
77
Directed Undirected Network Models and Layers
88
--------------
99

10-
.. automodule:: torch_geometric_signed_directed.nn.directed.MagNet_node_classification
10+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNet_node_classification
1111
:members:
1212
:exclude-members:
1313

14-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCN_node_classification
14+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_node_classification
1515
:members:
1616
:exclude-members:
1717

18-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_node_classification
18+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_node_classification
1919
:members:
2020
:exclude-members:
2121

22-
.. automodule:: torch_geometric_signed_directed.nn.directed.DIGRAC_node_clustering
22+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DIGRAC_node_clustering
2323
:members:
2424
:exclude-members:
2525

26-
.. automodule:: torch_geometric_signed_directed.nn.directed.DGCN_node_classification
26+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DGCN_node_classification
2727
:members:
2828
:exclude-members:
2929

30-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCL
30+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCL
3131
:members:
3232
:exclude-members: DiGCL_Encoder
3333

34-
.. automodule:: torch_geometric_signed_directed.nn.directed.MagNet_link_prediction
34+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNet_link_prediction
3535
:members:
3636
:exclude-members:
3737

38-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCN_link_prediction
38+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_link_prediction
3939
:members:
4040
:exclude-members:
4141

42-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_link_prediction
42+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block_link_prediction
4343
:members:
4444
:exclude-members:
4545

46-
.. automodule:: torch_geometric_signed_directed.nn.directed.DGCN_link_prediction
46+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DGCN_link_prediction
4747
:members:
4848
:exclude-members:
4949

50-
.. automodule:: torch_geometric_signed_directed.nn.directed.MagNetConv
50+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.MagNetConv
5151
:members:
5252
:exclude-members:
5353

54-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCNConv
54+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCNConv
5555
:members:
5656
:exclude-members:
5757

58-
.. automodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block
58+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DiGCN_Inception_Block
5959
:members:
6060
:exclude-members:
6161

62-
.. automodule:: torch_geometric_signed_directed.nn.directed.DIMPA
62+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DIMPA
6363
:members:
6464
:exclude-members:
6565

66-
.. automodule:: torch_geometric_signed_directed.nn.directed.DGCNConv
66+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.DGCNConv
6767
:members:
6868
:exclude-members:
6969

7070
Signed (Directed) Network Models and Layers
7171
--------------
7272

73-
.. automodule:: torch_geometric_signed_directed.nn.signed.SSSNET_node_clustering
73+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SSSNET_node_clustering
7474
:members:
7575
:exclude-members:
7676

77-
.. automodule:: torch_geometric_signed_directed.nn.signed.SSSNET_link_prediction
77+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SSSNET_link_prediction
7878
:members:
7979
:exclude-members:
8080

81-
.. automodule:: torch_geometric_signed_directed.nn.signed.SIMPA
81+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SIMPA
8282
:members:
8383
:exclude-members:
8484

85-
.. automodule:: torch_geometric_signed_directed.nn.signed.SDGNN
85+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SDGNN
8686
:members:
8787
:exclude-members: SDRLayer
8888

89-
.. automodule:: torch_geometric_signed_directed.nn.signed.SiGAT
89+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SiGAT
9090
:members:
9191
:exclude-members:
9292

93-
.. automodule:: torch_geometric_signed_directed.nn.signed.SGCN
93+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SGCN
9494
:members:
9595
:exclude-members:
9696

97-
.. automodule:: torch_geometric_signed_directed.nn.signed.SNEA
97+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SNEA
9898
:members:
9999
:exclude-members:
100100

101-
.. automodule:: torch_geometric_signed_directed.nn.signed.SNEAConv
101+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SNEAConv
102102
:members:
103103
:exclude-members:
104104

105-
.. automodule:: torch_geometric_signed_directed.nn.signed.SGCNConv
105+
.. autoapimodule:: torch_geometric_signed_directed.nn.signed.SGCNConv
106106
:members:
107107
:exclude-members:
108108

109-
.. automodule:: torch_geometric_signed_directed.nn.general.MSGNN
109+
.. autoapimodule:: torch_geometric_signed_directed.nn.general.MSGNN
110110
:members:
111111
:exclude-members:
112112

113-
.. automodule:: torch_geometric_signed_directed.nn.general.MSConv
113+
.. autoapimodule:: torch_geometric_signed_directed.nn.general.MSConv
114114
:members:
115115
:exclude-members:
116116

@@ -119,6 +119,6 @@ Signed (Directed) Network Models and Layers
119119
Auxiliary Methods and Layers
120120
--------------
121121

122-
.. automodule:: torch_geometric_signed_directed.nn.directed.complex_relu
122+
.. autoapimodule:: torch_geometric_signed_directed.nn.directed.complex_relu
123123
:members:
124124
:exclude-members:

‎docs/source/modules/root.rst‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎docs/source/modules/utils.rst‎

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

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

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

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

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

26-
.. automodule:: torch_geometric_signed_directed.utils.general.triplet_loss
26+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.triplet_loss
2727
:members:
2828
:exclude-members:
2929

3030

31-
.. automodule:: torch_geometric_signed_directed.utils.signed.link_sign_prediction_logistic_function
31+
.. autoapimodule:: torch_geometric_signed_directed.utils.signed.link_sign_prediction_logistic_function
3232
:members:
3333
:exclude-members:
3434

35-
.. automodule:: torch_geometric_signed_directed.utils.general.link_sign_direction_prediction_logistic_function
35+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.link_sign_direction_prediction_logistic_function
3636
:members:
3737
:exclude-members:
3838

39-
.. automodule:: torch_geometric_signed_directed.utils.directed.prob_imbalance_loss
39+
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.prob_imbalance_loss
4040
:members:
4141
:exclude-members:
4242

4343
Utilities and Preprocessing Methods
4444
--------------
4545

46-
.. automodule:: torch_geometric_signed_directed.utils.general.link_split
46+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.link_split
4747
:members:
4848
:exclude-members: undirected_label2directed_label
4949

50-
.. automodule:: torch_geometric_signed_directed.utils.general.node_split
50+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.node_split
5151
:members:
5252
:exclude-members: get_train_val_test_seed_split, sample_per_class
5353

54-
.. automodule:: torch_geometric_signed_directed.utils.directed.features_in_out
54+
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.features_in_out
5555
:members:
5656
:exclude-members:
5757

58-
.. automodule:: torch_geometric_signed_directed.utils.directed.get_magnetic_Laplacian
58+
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.get_magnetic_Laplacian
5959
:members:
6060
:exclude-members:
6161

62-
.. automodule:: torch_geometric_signed_directed.utils.directed.DiGCL_utils
62+
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.DiGCL_utils
6363
:members:
6464
:exclude-members:
6565

66-
.. automodule:: torch_geometric_signed_directed.utils.directed.get_adjs_DiGCN
66+
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.get_adjs_DiGCN
6767
:members:
6868
:exclude-members: fast_appr_power
6969

70-
.. automodule:: torch_geometric_signed_directed.utils.directed.meta_graph_generation
70+
.. autoapimodule:: torch_geometric_signed_directed.utils.directed.meta_graph_generation
7171
:members:
7272
:exclude-members:
7373

74-
.. automodule:: torch_geometric_signed_directed.utils.general.extract_network
74+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.extract_network
7575
:members:
7676
:exclude-members:
7777

78-
.. automodule:: torch_geometric_signed_directed.utils.general.scipy_sparse_to_torch_sparse
78+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.scipy_sparse_to_torch_sparse
7979
:members:
8080
:exclude-members:
8181

82-
.. automodule:: torch_geometric_signed_directed.utils.general.in_out_degree
82+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.in_out_degree
8383
:members:
8484
:exclude-members:
8585

86-
.. automodule:: torch_geometric_signed_directed.utils.general.get_magnetic_signed_Laplacian
86+
.. autoapimodule:: torch_geometric_signed_directed.utils.general.get_magnetic_signed_Laplacian
8787
:members:
8888
:exclude-members:
8989

90-
.. automodule:: torch_geometric_signed_directed.signed.create_spectral_features
90+
.. autoapimodule:: torch_geometric_signed_directed.signed.create_spectral_features
9191
:members:
9292
:exclude-members:

0 commit comments

Comments
 (0)
⚡