updated docstrings

GFNOrg · Nov 15, 2024 · 90e14e2 · 90e14e2
1 parent 9f0140e
commit 90e14e2
Showing 1 changed file with 2 additions and 2 deletions.
diff --git 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