update docstring

cvs-health · Jan 9, 2025 · 877b6b3 · 877b6b3
1 parent cf3aeb6
commit 877b6b3
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/langfair/generator/counterfactual.py b/langfair/generator/counterfactual.py
@@ -433,16 +433,22 @@ def check_ftu(
         -------
         dict
             A dictionary with two keys: 'data' and 'metadata'.
+
             'data' : dict
-                A dictionary containing the prompts and responses.
+                A dictionary containing the prompts and the attribute words they contain.
+
                 'prompt' : list
                     A list of prompts.
+
                 'attribute_words' : list
                     A list of attribute_words in each prompt.
+
             'metadata' : dict
                 A dictionary containing metadata related to FTU.
+
                 'ftu_satisfied' : boolean
                     Boolean indicator of whether or not prompts satisfy FTU
+               
                 'filtered_prompt_count' : int
                     The number of prompts that satisfy FTU.
         """