From 90e14e2bcfa037e6d1aeb091799c2fa1b9a7185d Mon Sep 17 00:00:00 2001 From: Joseph Viviano Date: Thu, 14 Nov 2024 19:33:14 -0500 Subject: [PATCH] updated docstrings --- src/gfn/modules.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/gfn/modules.py b/src/gfn/modules.py index 5dd36d5..bf64983 100644 --- a/src/gfn/modules.py +++ b/src/gfn/modules.py @@ -142,7 +142,7 @@ def to_probability_distribution( class ScalarEstimator(GFNModule): - r"""Class for estimating scalars such as LogZ. + r"""Class for estimating scalars such as LogZ or state flow functions of DB/SubTB. Training a GFlowNet requires sometimes requires the estimation of precise scalar values, such as the partition function of flows on the DAG. This Estimator is @@ -371,7 +371,7 @@ def forward(self, states: States, conditioning: torch.tensor) -> torch.Tensor: class ConditionalScalarEstimator(ConditionalDiscretePolicyEstimator): - r"""Class for conditionally estimating scalars such as LogZ. + r"""Class for conditionally estimating scalars (LogZ, DB/SubTB state logF). Training a GFlowNet requires sometimes requires the estimation of precise scalar values, such as the partition function of flows on the DAG. In the case of a