From 98db10f7a6a095036416df4f991bbdd816127e17 Mon Sep 17 00:00:00 2001 From: Csaba Kiraly Date: Thu, 30 Mar 2023 00:01:06 +0200 Subject: [PATCH] Add more documentation Signed-off-by: Csaba Kiraly --- DAS/observer.py | 12 ++++++++++++ DAS/results.py | 1 + 2 files changed, 13 insertions(+) diff --git a/DAS/observer.py b/DAS/observer.py index 18c0461..235ed60 100644 --- a/DAS/observer.py +++ b/DAS/observer.py @@ -58,6 +58,17 @@ class Observer: return (arrived, expected, ready, validated) def getProgress(self, validators): + """Calculate current simulation progress with different metrics. + + Returns: + - missingSamples: overall number of sample instances missing in nodes. + Sample are counted on both rows and columns, so intersections of interest are counted twice. + - sampleProgress: previous expressed as progress ratio + - nodeProgress: ratio of nodes having all segments interested in + - validatorProgress: same as above, but vpn weighted average. I.e. it counts per validator, + but counts a validator only if its support node's all validators see all interesting segments + TODO: add real per validator progress counter + """ arrived, expected, ready, validated = self.checkStatus(validators) missingSamples = expected - arrived sampleProgress = arrived / expected @@ -68,6 +79,7 @@ class Observer: return missingSamples, sampleProgress, nodeProgress, validatorProgress def getTrafficStats(self, validators): + """Summary statistics of traffic measurements in a timestep.""" def maxOrNan(l): return np.max(l) if l else np.NaN def meanOrNan(l): diff --git a/DAS/results.py b/DAS/results.py index 61f4f04..c5687a5 100644 --- a/DAS/results.py +++ b/DAS/results.py @@ -28,6 +28,7 @@ class Result: self.tta = -1 def addMetric(self, name, metric): + """Generic function to add a metric to the results.""" self.metrics[name] = metric def dump(self, execID):