From bae89e4c4b7a2156db2bba168fa5e9e1d73eb774 Mon Sep 17 00:00:00 2001 From: elseml <60779710+elseml@users.noreply.github.com> Date: Tue, 11 Jul 2023 16:52:19 +0200 Subject: [PATCH] Update HierarchicalNetwork documentation --- bayesflow/summary_networks.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/bayesflow/summary_networks.py b/bayesflow/summary_networks.py index a3d69b18a..b616b043e 100644 --- a/bayesflow/summary_networks.py +++ b/bayesflow/summary_networks.py @@ -550,7 +550,8 @@ def __init__(self, networks_list, **kwargs): that are aligned with the probabilistic structure of the processed data. Note: The networks will start processing from the lowest hierarchical level (e.g., observational level) - up to the highest hierarchical level. + up to the highest hierarchical level. It is recommended to provide higher-level networks with more + expressive power to allow for an adequate compression of lower-level data. Example: For two-level hierarchical models with the assumption of temporal dependencies on the lowest 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): ---------- data : tf.Tensor of shape (batch_size, ..., data_dim) Example, hierarchical data sets with two levels: - (batch_size, D, L, x_dim) -> reduces to + (batch_size, D, L, x_dim) -> reduces to (batch_size, out_dim). return_all : boolean, optional, default: False Whether to return all intermediate outputs (True) or just the final one (False).