rename examples in graphical_simulator.example_simulators

Author: daniel-habermann

bayesflow/experimental/graphical_simulator/example_simulators/__init__.py

@@ -1,4 +1,3 @@
-from .single_level import single_level
-from .two_level import two_level
-from .two_level_repeated_roots import two_level_repeated_roots
-from .irt import irt
+from .single_level_simulator import single_level_simulator
+from .two_level_simulator import two_level_simulator
+from .crossed_design_irt_simulator import crossed_design_irt_simulator

bayesflow/experimental/graphical_simulator/example_simulators/irt.py renamed to bayesflow/experimental/graphical_simulator/example_simulators/crossed_design_irt_simulator.py

@@ -3,9 +3,9 @@
 from ..graphical_simulator import GraphicalSimulator
 
 
-def irt():
+def crossed_design_irt_simulator():
     r"""
-    Item Response Theory (IRT) model implemented as a graphical simultor.
+    Item Response Theory (IRT) model implemented as a graphical simulator.
 
       schools
        /     \

bayesflow/experimental/graphical_simulator/example_simulators/single_level.py renamed to bayesflow/experimental/graphical_simulator/example_simulators/single_level_simulator.py

@@ -3,7 +3,7 @@
 from ..graphical_simulator import GraphicalSimulator
 
 
-def single_level():
+def single_level_simulator():
     """
     Simple single-level simulator that implements the same model as in
     https://bayesflow.org/main/_examples/Linear_Regression_Starter.html

bayesflow/experimental/graphical_simulator/example_simulators/two_level_repeated_roots.py

@@ -3,7 +3,7 @@
 from ..graphical_simulator import GraphicalSimulator
 
 
-def two_level():
+def two_level_simulator(repeated_roots=False):
     r"""
     Simple hierarchical model with two levels of parameters: hyperparameters
     and local parameters, along with a shared parameter:
@@ -15,6 +15,10 @@ def two_level():
          \  /
           y
 
+    Parameters
+    ----------
+    repeated_roots : bool, default false.
+
     """
 
     def sample_hypers():
@@ -39,7 +43,11 @@ def sample_y(local_mean, shared_std):
         return {"y": y}
 
     simulator = GraphicalSimulator()
-    simulator.add_node("hypers", sample_fn=sample_hypers)
+
+    if not repeated_roots:
+        simulator.add_node("hypers", sample_fn=sample_hypers)
+    else:
+        simulator.add_node("hypers", sample_fn=sample_hypers, reps=5)
 
     simulator.add_node(
         "locals",

bayesflow/experimental/graphical_simulator/example_simulators/two_level.py renamed to bayesflow/experimental/graphical_simulator/example_simulators/two_level_simulator.py

@@ -251,27 +251,27 @@ def simulator(request):
 
 @pytest.fixture()
 def single_level_simulator():
-    from bayesflow.experimental.graphical_simulator.example_simulators import single_level
+    from bayesflow.experimental.graphical_simulator.example_simulators import single_level_simulator
 
-    return single_level()
+    return single_level_simulator()
 
 
 @pytest.fixture()
 def two_level_simulator():
-    from bayesflow.experimental.graphical_simulator.example_simulators import two_level
+    from bayesflow.experimental.graphical_simulator.example_simulators import two_level_simulator
 
-    return two_level()
+    return two_level_simulator()
 
 
 @pytest.fixture()
 def two_level_repeated_roots_simulator():
-    from bayesflow.experimental.graphical_simulator.example_simulators import two_level_repeated_roots
+    from bayesflow.experimental.graphical_simulator.example_simulators import two_level_simulator
 
-    return two_level_repeated_roots()
+    return two_level_simulator(repeated_roots=True)
 
 
 @pytest.fixture()
-def irt_simulator():
-    from bayesflow.experimental.graphical_simulator.example_simulators import irt
+def crossed_design_irt_simulator():
+    from bayesflow.experimental.graphical_simulator.example_simulators import crossed_design_irt_simulator
 
-    return irt()
+    return crossed_design_irt_simulator()

tests/test_simulators/conftest.py

@@ -5,10 +5,12 @@
 
 def test_single_level_simulator(single_level_simulator):
     # prior -> likelihood
-    assert isinstance(single_level_simulator, bf.experimental.graphical_simulator.GraphicalSimulator)
-    assert isinstance(single_level_simulator.sample(5), dict)
 
-    samples = single_level_simulator.sample(12)
+    simulator = single_level_simulator
+    assert isinstance(simulator, bf.experimental.graphical_simulator.GraphicalSimulator)
+    assert isinstance(simulator.sample(5), dict)
+
+    samples = simulator.sample(12)
     expected_keys = ["N", "beta", "sigma", "x", "y"]
 
     assert set(samples.keys()) == set(expected_keys)
@@ -31,10 +33,11 @@ def test_two_level_simulator(two_level_simulator):
     #      \  /
     #       y
 
-    assert isinstance(two_level_simulator, bf.experimental.graphical_simulator.GraphicalSimulator)
-    assert isinstance(two_level_simulator.sample(5), dict)
+    simulator = two_level_simulator
+    assert isinstance(simulator, bf.experimental.graphical_simulator.GraphicalSimulator)
+    assert isinstance(simulator.sample(5), dict)
 
-    samples = two_level_simulator.sample(15)
+    samples = simulator.sample(15)
     expected_keys = ["hyper_mean", "hyper_std", "local_mean", "shared_std", "y"]
 
     assert set(samples.keys()) == set(expected_keys)
@@ -84,7 +87,7 @@ def test_two_level_repeated_roots_simulator(two_level_repeated_roots_simulator):
     assert np.shape(samples["y"]) == (15, 5, 6, 10, 1)
 
 
-def test_irt_simulator(irt_simulator):
+def test_crossed_design_irt_simulator(crossed_design_irt_simulator):
     #  schools
     #   /     \
     # exams  students
@@ -93,10 +96,11 @@ def test_irt_simulator(irt_simulator):
     #    \     /
     #  observations
 
-    assert isinstance(irt_simulator, bf.experimental.graphical_simulator.GraphicalSimulator)
-    assert isinstance(irt_simulator.sample(5), dict)
+    simulator = crossed_design_irt_simulator
+    assert isinstance(simulator, bf.experimental.graphical_simulator.GraphicalSimulator)
+    assert isinstance(simulator.sample(5), dict)
 
-    samples = irt_simulator.sample(22)
+    samples = simulator.sample(22)
     expected_keys = [
         "mu_exam_mean",
         "sigma_exam_mean",