Skip to content

Commit eace3f3

Browse files
PatReisPatReis
committed
redo docs
1 parent 05085ec commit eace3f3

19 files changed

+1154
-0
lines changed

‎docs/source/kgcnn.crystal.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
kgcnn.crystal package
2+
=====================
3+
4+
Submodules
5+
----------
6+
7+
kgcnn.crystal.base module
8+
-------------------------
9+
10+
.. automodule:: kgcnn.crystal.base
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
kgcnn.crystal.graph\_builder module
16+
-----------------------------------
17+
18+
.. automodule:: kgcnn.crystal.graph_builder
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
kgcnn.crystal.module\_pymatgen module
24+
-------------------------------------
25+
26+
.. automodule:: kgcnn.crystal.module_pymatgen
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
kgcnn.crystal.module\_pyxtal module
32+
-----------------------------------
33+
34+
.. automodule:: kgcnn.crystal.module_pyxtal
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: kgcnn.crystal
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/source/kgcnn.data.datasets.rst‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
kgcnn.data.datasets package
2+
===========================
3+
4+
Submodules
5+
----------
6+
7+
kgcnn.data.datasets.CoraDataset module
8+
--------------------------------------
9+
10+
.. automodule:: kgcnn.data.datasets.CoraDataset
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
kgcnn.data.datasets.CoraLuDataset module
16+
----------------------------------------
17+
18+
.. automodule:: kgcnn.data.datasets.CoraLuDataset
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
kgcnn.data.datasets.ESOLDataset module
24+
--------------------------------------
25+
26+
.. automodule:: kgcnn.data.datasets.ESOLDataset
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
kgcnn.data.datasets.GraphTUDataset2020 module
32+
---------------------------------------------
33+
34+
.. automodule:: kgcnn.data.datasets.GraphTUDataset2020
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
kgcnn.data.datasets.LipopDataset module
40+
---------------------------------------
41+
42+
.. automodule:: kgcnn.data.datasets.LipopDataset
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
kgcnn.data.datasets.MUTAGDataset module
48+
---------------------------------------
49+
50+
.. automodule:: kgcnn.data.datasets.MUTAGDataset
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
kgcnn.data.datasets.MatBenchDataset2020 module
56+
----------------------------------------------
57+
58+
.. automodule:: kgcnn.data.datasets.MatBenchDataset2020
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
kgcnn.data.datasets.MatProjectEFormDataset module
64+
-------------------------------------------------
65+
66+
.. automodule:: kgcnn.data.datasets.MatProjectEFormDataset
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
kgcnn.data.datasets.MoleculeNetDataset2018 module
72+
-------------------------------------------------
73+
74+
.. automodule:: kgcnn.data.datasets.MoleculeNetDataset2018
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
kgcnn.data.datasets.MutagenicityDataset module
80+
----------------------------------------------
81+
82+
.. automodule:: kgcnn.data.datasets.MutagenicityDataset
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
kgcnn.data.datasets.PROTEINSDataset module
88+
------------------------------------------
89+
90+
.. automodule:: kgcnn.data.datasets.PROTEINSDataset
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
kgcnn.data.datasets.QM9Dataset module
96+
-------------------------------------
97+
98+
.. automodule:: kgcnn.data.datasets.QM9Dataset
99+
:members:
100+
:undoc-members:
101+
:show-inheritance:
102+
103+
Module contents
104+
---------------
105+
106+
.. automodule:: kgcnn.data.datasets
107+
:members:
108+
:undoc-members:
109+
:show-inheritance:

‎docs/source/kgcnn.data.rst‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
kgcnn.data package
2+
==================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
kgcnn.data.datasets
11+
12+
Submodules
13+
----------
14+
15+
kgcnn.data.base module
16+
----------------------
17+
18+
.. automodule:: kgcnn.data.base
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
kgcnn.data.crystal module
24+
-------------------------
25+
26+
.. automodule:: kgcnn.data.crystal
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
kgcnn.data.download module
32+
--------------------------
33+
34+
.. automodule:: kgcnn.data.download
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
kgcnn.data.moleculenet module
40+
-----------------------------
41+
42+
.. automodule:: kgcnn.data.moleculenet
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
kgcnn.data.qm module
48+
--------------------
49+
50+
.. automodule:: kgcnn.data.qm
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
kgcnn.data.serial module
56+
------------------------
57+
58+
.. automodule:: kgcnn.data.serial
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
kgcnn.data.tudataset module
64+
---------------------------
65+
66+
.. automodule:: kgcnn.data.tudataset
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
kgcnn.data.utils module
72+
-----------------------
73+
74+
.. automodule:: kgcnn.data.utils
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
Module contents
80+
---------------
81+
82+
.. automodule:: kgcnn.data
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:

‎docs/source/kgcnn.graph.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
kgcnn.graph package
2+
===================
3+
4+
Submodules
5+
----------
6+
7+
kgcnn.graph.adapter module
8+
--------------------------
9+
10+
.. automodule:: kgcnn.graph.adapter
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
kgcnn.graph.adj module
16+
----------------------
17+
18+
.. automodule:: kgcnn.graph.adj
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
kgcnn.graph.base module
24+
-----------------------
25+
26+
.. automodule:: kgcnn.graph.base
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
kgcnn.graph.geom module
32+
-----------------------
33+
34+
.. automodule:: kgcnn.graph.geom
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: kgcnn.graph
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/source/kgcnn.hyper.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
kgcnn.hyper package
2+
===================
3+
4+
Submodules
5+
----------
6+
7+
kgcnn.hyper.hyper module
8+
------------------------
9+
10+
.. automodule:: kgcnn.hyper.hyper
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: kgcnn.hyper
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/kgcnn.io.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
kgcnn.io package
2+
================
3+
4+
Submodules
5+
----------
6+
7+
kgcnn.io.loader module
8+
----------------------
9+
10+
.. automodule:: kgcnn.io.loader
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: kgcnn.io
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

0 commit comments

Comments
 (0)