Skip to content

Commit

Permalink
Add docs/source/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mihaeladuta committed Dec 2, 2024
1 parent 7a2e4fa commit 8d40e3d
Show file tree
Hide file tree
Showing 15 changed files with 482 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
.DS_Store
__pycache__/
.venv/
docs/source/reference/
docs/build/
10 changes: 10 additions & 0 deletions docs/source/reference/l2gv2.datasets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
l2gv2.datasets package
======================

Module contents
---------------

.. automodule:: l2gv2.datasets
:members:
:undoc-members:
:show-inheritance:
37 changes: 37 additions & 0 deletions docs/source/reference/l2gv2.embedding.dgi.layers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
l2gv2.embedding.dgi.layers package
==================================

Submodules
----------

l2gv2.embedding.dgi.layers.discriminator module
-----------------------------------------------

.. automodule:: l2gv2.embedding.dgi.layers.discriminator
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.dgi.layers.gcn module
-------------------------------------

.. automodule:: l2gv2.embedding.dgi.layers.gcn
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.dgi.layers.readout module
-----------------------------------------

.. automodule:: l2gv2.embedding.dgi.layers.readout
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.dgi.layers
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions docs/source/reference/l2gv2.embedding.dgi.models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
l2gv2.embedding.dgi.models package
==================================

Submodules
----------

l2gv2.embedding.dgi.models.dgi module
-------------------------------------

.. automodule:: l2gv2.embedding.dgi.models.dgi
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.dgi.models.logreg module
----------------------------------------

.. automodule:: l2gv2.embedding.dgi.models.logreg
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.dgi.models
:members:
:undoc-members:
:show-inheritance:
31 changes: 31 additions & 0 deletions docs/source/reference/l2gv2.embedding.dgi.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
l2gv2.embedding.dgi package
===========================

Subpackages
-----------

.. toctree::
:maxdepth: 4

l2gv2.embedding.dgi.layers
l2gv2.embedding.dgi.models
l2gv2.embedding.dgi.utils

Submodules
----------

l2gv2.embedding.dgi.execute module
----------------------------------

.. automodule:: l2gv2.embedding.dgi.execute
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.dgi
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions docs/source/reference/l2gv2.embedding.dgi.utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
l2gv2.embedding.dgi.utils package
=================================

Submodules
----------

l2gv2.embedding.dgi.utils.loss module
-------------------------------------

.. automodule:: l2gv2.embedding.dgi.utils.loss
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.dgi.utils
:members:
:undoc-members:
:show-inheritance:
37 changes: 37 additions & 0 deletions docs/source/reference/l2gv2.embedding.gae.layers.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
l2gv2.embedding.gae.layers package
==================================

Submodules
----------

l2gv2.embedding.gae.layers.GAEconv module
-----------------------------------------

.. automodule:: l2gv2.embedding.gae.layers.GAEconv
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.gae.layers.VGAEconv module
------------------------------------------

.. automodule:: l2gv2.embedding.gae.layers.VGAEconv
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.gae.layers.decoders module
------------------------------------------

.. automodule:: l2gv2.embedding.gae.layers.decoders
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.gae.layers
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions docs/source/reference/l2gv2.embedding.gae.models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
l2gv2.embedding.gae.models package
==================================

Submodules
----------

l2gv2.embedding.gae.models.gae module
-------------------------------------

.. automodule:: l2gv2.embedding.gae.models.gae
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.gae.models.vgae module
--------------------------------------

.. automodule:: l2gv2.embedding.gae.models.vgae
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.gae.models
:members:
:undoc-members:
:show-inheritance:
20 changes: 20 additions & 0 deletions docs/source/reference/l2gv2.embedding.gae.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
l2gv2.embedding.gae package
===========================

Subpackages
-----------

.. toctree::
:maxdepth: 4

l2gv2.embedding.gae.layers
l2gv2.embedding.gae.models
l2gv2.embedding.gae.utils

Module contents
---------------

.. automodule:: l2gv2.embedding.gae
:members:
:undoc-members:
:show-inheritance:
29 changes: 29 additions & 0 deletions docs/source/reference/l2gv2.embedding.gae.utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
l2gv2.embedding.gae.utils package
=================================

Submodules
----------

l2gv2.embedding.gae.utils.loss module
-------------------------------------

.. automodule:: l2gv2.embedding.gae.utils.loss
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.gae.utils.mixins module
---------------------------------------

.. automodule:: l2gv2.embedding.gae.utils.mixins
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding.gae.utils
:members:
:undoc-members:
:show-inheritance:
46 changes: 46 additions & 0 deletions docs/source/reference/l2gv2.embedding.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
l2gv2.embedding package
=======================

Subpackages
-----------

.. toctree::
:maxdepth: 4

l2gv2.embedding.dgi
l2gv2.embedding.gae

Submodules
----------

l2gv2.embedding.eval module
---------------------------

.. automodule:: l2gv2.embedding.eval
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.svd module
--------------------------

.. automodule:: l2gv2.embedding.svd
:members:
:undoc-members:
:show-inheritance:

l2gv2.embedding.train module
----------------------------

.. automodule:: l2gv2.embedding.train
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.embedding
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions docs/source/reference/l2gv2.network.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
l2gv2.network package
=====================

Submodules
----------

l2gv2.network.graph module
--------------------------

.. automodule:: l2gv2.network.graph
:members:
:undoc-members:
:show-inheritance:

l2gv2.network.npgraph module
----------------------------

.. automodule:: l2gv2.network.npgraph
:members:
:undoc-members:
:show-inheritance:

l2gv2.network.tgraph module
---------------------------

.. automodule:: l2gv2.network.tgraph
:members:
:undoc-members:
:show-inheritance:

l2gv2.network.utils module
--------------------------

.. automodule:: l2gv2.network.utils
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.network
:members:
:undoc-members:
:show-inheritance:
45 changes: 45 additions & 0 deletions docs/source/reference/l2gv2.patch.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
l2gv2.patch package
===================

Submodules
----------

l2gv2.patch.lazy module
-----------------------

.. automodule:: l2gv2.patch.lazy
:members:
:undoc-members:
:show-inheritance:

l2gv2.patch.patch module
------------------------

.. automodule:: l2gv2.patch.patch
:members:
:undoc-members:
:show-inheritance:

l2gv2.patch.patches module
--------------------------

.. automodule:: l2gv2.patch.patches
:members:
:undoc-members:
:show-inheritance:

l2gv2.patch.utils module
------------------------

.. automodule:: l2gv2.patch.utils
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: l2gv2.patch
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit 8d40e3d

Please sign in to comment.