From 31e99e9f5b896d59086e21befb4b5e3fdf369e3b Mon Sep 17 00:00:00 2001
From: Bobholamovic <bob1998425@hotmail.com>
Date: Mon, 27 Apr 2020 18:00:15 +0800
Subject: [PATCH] Add comment in metrics.py

---
 src/utils/metrics.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/utils/metrics.py b/src/utils/metrics.py
index 6610bfb..9c71f97 100644
--- a/src/utils/metrics.py
+++ b/src/utils/metrics.py
@@ -66,9 +66,12 @@ class Metric(AverageMeter):
             return self._compute(cm)[1]
 
     def update(self, pred, true, n=1):
-        # Note that this is no thread-safe
         self._cm.update(true.ravel(), pred.ravel())
         if self.mode == 'accum':
+            # Note that accumulation mode is special in that metric.val saves historical information.
+            # Therefore, metric.avg IS USUALLY NOT THE "AVERAGE" VALUE YOU WANT!!! 
+            # Instead, metric.val is the averaged result in the sense of metric.avg in separ mode, 
+            # while metric.avg can be considered as some average of average.
             cm = self._cm.sum
         elif self.mode == 'separ':
             cm = self._cm.val
-- 
GitLab