Update documentation

CSHVienna · Sep 9, 2024 · 0d8506f · 0d8506f
1 parent 7701e66
commit 0d8506f
Show file tree

Hide file tree

Showing 21 changed files with 149 additions and 50 deletions.
diff --git a/docs/source/algorithms.rst → docs/source/algorithms/index.rst b/docs/source/algorithms.rst → docs/source/algorithms/index.rst
@@ -8,4 +8,4 @@ Algorithms
    :caption: Contents:
    :glob:
 
-   algorithms/*
+   sampling
diff --git a/docs/source/extensions/events.rst b/docs/source/extensions/events.rst
@@ -0,0 +1,8 @@
+Event Handling
+==============
+
+.. autoclass:: netin.utils.Event
+    :members:
+    :undoc-members:
+.. autoclass:: netin.utils.HasEvents
+    :members:
diff --git a/docs/source/extensions/filters.rst b/docs/source/extensions/filters.rst
@@ -0,0 +1,14 @@
+Filters
+==========
+
+.. autoclass:: netin.filters.Filter
+    :members:
+
+.. autoclass:: netin.filters.NoDoubleLinks
+    :members:
+
+.. autoclass:: netin.filters.NoSelfLinks
+    :members:
+
+.. autoclass:: netin.filters.ActiveNodes
+    :members:
diff --git a/docs/source/extensions/index.rst b/docs/source/extensions/index.rst
@@ -0,0 +1,29 @@
+Extending NetIn
+===============
+
+The package provides multiple interfaces to extend its functionalities.
+
+Several classes implement the :class:`.HasEvents` interface which can be used to inject your own code at runtime.
+
+.. toctree::
+   :maxdepth: 2
+
+   events
+
+Alternatively, you can extend the existing class structure to facilitate the existing simulation code, changing only specific modeling details.
+:class:`.Filter` and :class:`.LinkFormationMechanism` provide abstract classes that describe how target nodes are chosen during simulation.
+
+.. toctree::
+   :maxdepth: 2
+
+   filters
+   mechanisms
+
+Both custom and existing implementations (e.g., :class:`.Homophily`) can be used in custom models to reuse the existing simulation logic.
+In that case, only some of the simulation methods have to be reimplemented.
+For this purpose, several abstract base classes define varying levels of modelling abstractions.
+
+.. toctree::
+   :maxdepth: 2
+
+   models
diff --git a/docs/source/extensions/mechanisms.rst b/docs/source/extensions/mechanisms.rst
@@ -0,0 +1,20 @@
+Link Formation Mechanisms (LFM)
+===============================
+
+.. autoclass:: netin.link_formation_mechanisms.LinkFormationMechanism
+    :members:
+
+.. autoclass:: netin.link_formation_mechanisms.Uniform
+    :members:
+
+.. autoclass:: netin.link_formation_mechanisms.PreferentialAttachment
+    :members:
+
+.. autoclass:: netin.link_formation_mechanisms.InDegreePreferentialAttachment
+    :members:
+
+.. autoclass:: netin.link_formation_mechanisms.Homophily
+    :members:
+
+.. autoclass:: netin.link_formation_mechanisms.TriadicClosure
+    :members:
diff --git a/docs/source/extensions/models.rst b/docs/source/extensions/models.rst
@@ -0,0 +1,18 @@
+Model
+=====
+
+.. autoclass:: netin.models.Model
+    :members:
+    :private-members:
+
+.. autoclass:: netin.models.BinaryClassModel
+    :members:
+    :private-members:
+
+.. autoclass:: netin.models.UndirectedModel
+    :members:
+    :private-members:
+
+.. autoclass:: netin.models.DirectedModel
+    :members:
+    :private-members:
diff --git a/docs/source/generators/directed.rst b/docs/source/generators/directed.rst
diff --git a/docs/source/generators/undirected.rst b/docs/source/generators/undirected.rst
diff --git a/docs/source/graphs/directed.rst b/docs/source/graphs/directed.rst
@@ -0,0 +1,6 @@
+Directed Graphs
+=================
+
+.. autoclass:: netin.graphs.DiGraph
+   :members:
+   :inherited-members:
diff --git a/docs/source/graphs/index.rst b/docs/source/graphs/index.rst
@@ -0,0 +1,8 @@
+Graphs
+=======
+.. toctree::
+   :maxdepth: 1
+
+   undirected
+   directed
+
diff --git a/docs/source/graphs/undirected.rst b/docs/source/graphs/undirected.rst
@@ -0,0 +1,6 @@
+Undirected Graphs
+=================
+
+.. autoclass:: netin.graphs.Graph
+   :members:
+   :inherited-members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,13 +11,13 @@ Network Inequality
 .. toctree::
    :maxdepth: 3
    :caption: Contents:
-   :glob:
 
-   graphs
-   algorithms
-   mechanisms
+   models/index
+   graphs/index
+   algorithms/index
    statistics
    visualizations
+   extensions/index
 
 Indices and tables
 ==================

diff --git a/docs/source/logo_simple_dark_bg.png b/docs/source/logo_simple_dark_bg.png
diff --git a/docs/source/logo_twitter_v1_white_bg.png b/docs/source/logo_twitter_v1_white_bg.png
diff --git a/docs/source/logo_twitter_v2_white_bg.png b/docs/source/logo_twitter_v2_white_bg.png
diff --git a/docs/source/mechanisms.rst b/docs/source/mechanisms.rst
diff --git a/docs/source/models/directed.rst b/docs/source/models/directed.rst
@@ -0,0 +1,10 @@
+Directed Graph Models
+=====================
+
+.. autoclass:: netin.models.DPAModel
+    :members:
+    :inherited-members:
+
+.. autoclass:: netin.models.DPAHModel
+    :members:
+    :inherited-members:
diff --git a/docs/source/graphs.rst → docs/source/models/index.rst b/docs/source/graphs.rst → docs/source/models/index.rst
@@ -1,9 +1,9 @@
-Graphs
+Models
 =======
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
    :glob:
 
-   generators/*
+   directed
+   undirected
diff --git a/docs/source/models/undirected.rst b/docs/source/models/undirected.rst
@@ -0,0 +1,22 @@
+Undirected Graph Models
+=======================
+
+.. autoclass:: netin.models.BarabasiAlbertModel
+    :members:
+    :inherited-members:
+
+.. autoclass:: netin.models.HomophilyModel
+    :members:
+    :inherited-members:
+
+.. autoclass:: netin.models.PAHModel
+    :members:
+    :inherited-members:
+
+.. autoclass:: netin.models.PATCHModel
+    :members:
+    :inherited-members:
+
+.. autoclass:: netin.models.CompoundLFM
+    :members:
+    :inherited-members:
diff --git a/docs/source/netin-logo-bg-white.jpg b/docs/source/netin-logo-bg-white.jpg
diff --git a/docs/source/netin-logo-text-dark.png b/docs/source/netin-logo-text-dark.png