Skip to content

Commit bae89e4

Browse files
committed
Update HierarchicalNetwork documentation
1 parent 632ed3f commit bae89e4

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

bayesflow/summary_networks.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,8 @@ def __init__(self, networks_list, **kwargs):
550550
that are aligned with the probabilistic structure of the processed data.
551551
552552
Note: The networks will start processing from the lowest hierarchical level (e.g., observational level)
553-
up to the highest hierarchical level.
553+
up to the highest hierarchical level. It is recommended to provide higher-level networks with more
554+
expressive power to allow for an adequate compression of lower-level data.
554555
555556
Example: For two-level hierarchical models with the assumption of temporal dependencies on the lowest
556557
hierarchical level (e.g., observational level) and exchangeable units at the higher level
@@ -574,7 +575,7 @@ def call(self, x, return_all=False, **kwargs):
574575
----------
575576
data : tf.Tensor of shape (batch_size, ..., data_dim)
576577
Example, hierarchical data sets with two levels:
577-
(batch_size, D, L, x_dim) -> reduces to
578+
(batch_size, D, L, x_dim) -> reduces to (batch_size, out_dim).
578579
return_all : boolean, optional, default: False
579580
Whether to return all intermediate outputs (True) or just
580581
the final one (False).

0 commit comments

Comments
 (0)