Explain how to obtain the model graphviz in a non-Ipython environment

pymc/distributions/shape_utils.py

@@ -109,22 +109,27 @@ def broadcast_dist_samples_shape(shapes, size=None):
     Examples
     --------
     .. code-block:: python
+
         size = 100
         shape0 = (size,)
         shape1 = (size, 5)
         shape2 = (size, 4, 5)
         out = broadcast_dist_samples_shape([shape0, shape1, shape2],
                                            size=size)
         assert out == (size, 4, 5)
+
     .. code-block:: python
+
         size = 100
         shape0 = (size,)
         shape1 = (5,)
         shape2 = (4, 5)
         out = broadcast_dist_samples_shape([shape0, shape1, shape2],
                                            size=size)
         assert out == (size, 4, 5)
+
     .. code-block:: python
+
         size = 100
         shape0 = (1,)
         shape1 = (5,)

pymc/model/core.py

@@ -1873,7 +1873,7 @@ def to_graphviz(
         .. code-block:: python
 
             import numpy as np
-            from pymc import HalfCauchy, Model, Normal, model_to_graphviz
+            from pymc import HalfCauchy, Model, Normal
 
             J = 8
             y = np.array([28, 8, -3, 7, -1, 1, 18, 12])
@@ -1890,6 +1890,15 @@ def to_graphviz(
                 obs = Normal("obs", theta, sigma=sigma, observed=y)
 
             schools.to_graphviz()
+
+        Note that this code automatically plots the graph if executed in a Jupyter notebook.
+        If executed non-interactively, such as in a script or python console, the graph
+        needs to be rendered explicitly:
+
+        .. code-block:: python
+
+            # creates the file `schools.pdf`
+            schools.to_graphviz().render("schools")
         """
         return model_to_graphviz(
             model=self,

pymc/model_graph.py

@@ -474,6 +474,15 @@ def model_to_graphviz(
             obs = Normal("obs", theta, sigma=sigma, observed=y)
 
         model_to_graphviz(schools)
+
+    Note that this code automatically plots the graph if executed in a Jupyter notebook.
+    If executed non-interactively, such as in a script or python console, the graph
+    needs to be rendered explicitly:
+
+    .. code-block:: python
+
+        # creates the file `schools.pdf`
+        model_to_graphviz(schools).render("schools")
     """
     if "plain" not in formatting:
         raise ValueError(f"Unsupported formatting for graph nodes: '{formatting}'. See docstring.")

pymc/pytensorf.py

@@ -808,6 +808,7 @@ def collect_default_updates(
     Examples
     --------
     .. code:: python
+
         import pymc as pm
         from pytensor.scan import scan
         from pymc.pytensorf import collect_default_updates