Merge branch 'dev' into standardize-docs

graspologic-org · Nov 6, 2020 · facdcc3 · facdcc3
2 parents db49d01 + 35eeb90
commit facdcc3
Show file tree

Hide file tree

Showing 11 changed files with 796 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -69,6 +69,7 @@
     "anytree": ("https://anytree.readthedocs.io/en/latest/", None),
     "hyppo": ("https://hyppo.neurodata.io", None),
     "matplotlib": ("https://matplotlib.org", None),
+    "networkx": ("https://networkx.org/documentation/stable", None),
     "numpy": ("https://numpy.org/doc/stable", None),
     "python": ("https://docs.python.org/3", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),

diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -17,3 +17,4 @@ Reference
    match
    subgraph
    align
+   preprocessing
diff --git a/docs/reference/preprocessing.rst b/docs/reference/preprocessing.rst
@@ -0,0 +1,43 @@
+Preprocessing
+=============
+
+.. currentmodule:: graspologic.preprocessing
+
+Graph Cuts
+----------
+
+Constants
+^^^^^^^^^
+.. py:data:: LARGER_THAN_INCLUSIVE
+
+Cut any edge or node > the ``cut_threshold``
+
+.. py:data:: LARGER_THAN_EXCLUSIVE
+
+Cut any edge or node >= the ``cut_threshold``
+
+.. py:data:: SMALLER_THAN_INCLUSIVE
+
+Cut any edge or node < the ``cut_threshold``
+
+.. py:data:: SMALLER_THAN_EXCLUSIVE
+
+Cut any edge or node <= the ``cut_threshold``
+
+Classes
+^^^^^^^
+.. autoclass:: DefinedHistogram
+
+Functions
+^^^^^^^^^
+.. autofunction:: cut_edges_by_weight
+
+.. autofunction:: cut_vertices_by_betweenness_centrality
+
+.. autofunction:: cut_vertices_by_degree_centrality
+
+.. autofunction:: histogram_betweenness_centrality
+
+.. autofunction:: histogram_degree_centrality
+
+.. autofunction:: histogram_edge_weight
diff --git a/graspologic/__init__.py b/graspologic/__init__.py
@@ -11,6 +11,7 @@
 import graspologic.embed
 import graspologic.inference
 import graspologic.models
+import graspologic.preprocessing
 import graspologic.plot
 import graspologic.simulations
 import graspologic.subgraph

diff --git a/graspologic/preprocessing/__init__.py b/graspologic/preprocessing/__init__.py
@@ -0,0 +1,23 @@
+# Copyright (c) Microsoft Corporation and contributors.
+# Licensed under the MIT License.
+
+from .graph_cuts import (
+    DefinedHistogram,
+    histogram_betweenness_centrality,
+    histogram_degree_centrality,
+    histogram_edge_weight,
+    cut_edges_by_weight,
+    cut_vertices_by_betweenness_centrality,
+    cut_vertices_by_degree_centrality,
+)
+
+
+__all__ = [
+    "DefinedHistogram",
+    "histogram_betweenness_centrality",
+    "histogram_degree_centrality",
+    "histogram_edge_weight",
+    "cut_edges_by_weight",
+    "cut_vertices_by_betweenness_centrality",
+    "cut_vertices_by_degree_centrality",
+]
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,3 +17,4 @@ Reference @@
        match
        subgraph
        align
+       preprocessing