nbansal commited on
Commit
923c652
1 Parent(s): bcb2272

Add doc strings

Browse files
Files changed (1) hide show
  1. utils.py +8 -0
utils.py CHANGED
@@ -222,6 +222,14 @@ def compute_f1(p: float, r: float, eps=sys.float_info.epsilon) -> float:
222
 
223
  @dataclass
224
  class Scores:
 
 
 
 
 
 
 
 
225
  precision: float
226
  recall: List[float]
227
 
 
222
 
223
  @dataclass
224
  class Scores:
225
+ """
226
+ Data class representing evaluation scores including precision, recall, and computed F1 score.
227
+
228
+ Attributes:
229
+ - precision (float): The precision score for the evaluation.
230
+ - recall (List[float]): List of recall scores for each reference
231
+ - f1 (float): Computed F1 score based on the precision and mean recall values.
232
+ """
233
  precision: float
234
  recall: List[float]
235