rename the network submodule to utils (#190)

ComputationalPsychiatry · May 24, 2024 · 646a0c3 · 646a0c3
1 parent 9742d20
commit 646a0c3
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -203,15 +203,15 @@ least the HGF instance as input after observation and returning surprise.
    binary_softmax
    binary_softmax_inverse_temperature
 
-Networks
-********
+Utils
+*****
 
-Utilities for manipulating networks of probabilistic nodes.
+Utilities for manipulating neural networks.
 
-.. currentmodule:: pyhgf.networks
+.. currentmodule:: pyhgf.utils
 
 .. autosummary::
-   :toctree: generated/pyhgf.networks
+   :toctree: generated/pyhgf.utils
 
    beliefs_propagation
    trim_sequence

diff --git a/docs/source/notebooks/0.3-Generalised_filtering.ipynb b/docs/source/notebooks/0.3-Generalised_filtering.ipynb
@@ -38,7 +38,7 @@
     "from matplotlib.ticker import MultipleLocator\n",
     "from pyhgf.math import MultivariateNormal, Normal, gaussian_predictive_distribution\n",
     "from pyhgf.model import HGF\n",
-    "from pyhgf.networks import beliefs_propagation\n",
+    "from pyhgf.utils import beliefs_propagation\n",
     "from scipy.special import gammaln\n",
     "from scipy.stats import norm, t\n",
     "\n",

diff --git a/docs/source/notebooks/Example_3_Multi_armed_bandit.ipynb b/docs/source/notebooks/Example_3_Multi_armed_bandit.ipynb
@@ -942,7 +942,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pyhgf.networks import beliefs_propagation"
+    "from pyhgf.utils import beliefs_propagation"
    ]
   },
   {

diff --git a/src/pyhgf/model/network.py b/src/pyhgf/model/network.py
@@ -9,12 +9,6 @@
 from jax.tree_util import Partial
 from jax.typing import ArrayLike
 
-from pyhgf.networks import (
-    beliefs_propagation,
-    fill_categorical_state_node,
-    get_update_sequence,
-    to_pandas,
-)
 from pyhgf.plots import plot_correlations, plot_network, plot_nodes, plot_trajectories
 from pyhgf.typing import (
     AdjacencyLists,
@@ -25,6 +19,12 @@
     UpdateSequence,
     input_types,
 )
+from pyhgf.utils import (
+    beliefs_propagation,
+    fill_categorical_state_node,
+    get_update_sequence,
+    to_pandas,
+)
 
 
 class Network:

diff --git a/src/pyhgf/networks.py → src/pyhgf/utils.py b/src/pyhgf/networks.py → src/pyhgf/utils.py
diff --git a/tests/test_binary.py b/tests/test_binary.py
@@ -9,7 +9,6 @@
 
 from pyhgf import load_data
 from pyhgf.math import binary_surprise, gaussian_density, sigmoid
-from pyhgf.networks import beliefs_propagation
 from pyhgf.typing import AdjacencyLists, Inputs
 from pyhgf.updates.posterior.binary import binary_node_update_infinite
 from pyhgf.updates.posterior.continuous import continuous_node_update
@@ -24,6 +23,7 @@
 from pyhgf.updates.prediction_error.nodes.continuous import (
     continuous_node_prediction_error,
 )
+from pyhgf.utils import beliefs_propagation
 
 
 class Testbinary(TestCase):

diff --git a/tests/test_continuous.py b/tests/test_continuous.py
@@ -9,7 +9,6 @@
 
 from pyhgf import load_data
 from pyhgf.math import gaussian_surprise
-from pyhgf.networks import beliefs_propagation
 from pyhgf.typing import AdjacencyLists, Inputs
 from pyhgf.updates.posterior.continuous import (
     continuous_node_update,
@@ -22,6 +21,7 @@
 from pyhgf.updates.prediction_error.nodes.continuous import (
     continuous_node_prediction_error,
 )
+from pyhgf.utils import beliefs_propagation
 
 
 @pytest.fixture(scope="module")

diff --git a/tests/test_networks.py b/tests/test_networks.py
@@ -5,7 +5,6 @@
 
 import jax.numpy as jnp
 
-from pyhgf.networks import beliefs_propagation, list_branches
 from pyhgf.typing import AdjacencyLists, Inputs
 from pyhgf.updates.posterior.continuous import (
     continuous_node_update,
@@ -14,6 +13,7 @@
 from pyhgf.updates.prediction_error.inputs.continuous import (
     continuous_input_prediction_error,
 )
+from pyhgf.utils import beliefs_propagation, list_branches
 
 
 class TestStructure(TestCase):