[tor-commits] [torspec/master] Clarify Torflow's aggregation steps

[asn at torproject.org]

commit e6b05bf44888ba35735e5293e4faa79a3cbac66d
Author: Georg Koppen <gk at torproject.org>
Date:   Mon Mar 22 10:28:52 2021 +0000

    Clarify Torflow's aggregation steps
    
    Closes torspec#40.
---
 bandwidth-file-spec.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt
index fdb5bd5..924623e 100644
--- a/bandwidth-file-spec.txt
+++ b/bandwidth-file-spec.txt
@@ -1166,7 +1166,7 @@ B.3. Quota changes
   consensus diffs and compressed consensuses. But if the relay
   quota is too small, some relays may be over- or under-weighted.
 
-B.4. Torflow aggreation
+B.4. Torflow aggregation
 
   Torflow implements two methods to compute the bandwidth values from the
   (stream) bandwidth measurements: with and without PID control feedback.
@@ -1192,9 +1192,9 @@ B.4. Torflow aggreation
       measured (`n`), ie, calculate the mean average of the relays'
       filtered bandwidth.
     - calculate the stream average by dividing the sum of all the
-      relays' filtered bandwidth by the number of relays that have been
+      relays' measured bandwidth by the number of relays that have been
       measured (`n`), ie, calculate the mean average or the relays'
-     measured bandwidth.
+      measured bandwidth.
 
      In pseudocode:
 
@@ -1213,8 +1213,8 @@ B.4. Torflow aggreation
       r_strm_i = bw_i / bw_avg_strm
 
   4. Calculate the final ratio for each relay:
-    The final ratio is the larger between the filtered bandwidth and the
-    stream bandwidth.
+    The final ratio is the larger between the filtered bandwidth's and the
+    stream bandwidth's ratio.
 
     In pseudocode: