Improve some comments in PMDefaults.

diff --git a/program/PMDefaults.hs b/program/PMDefaults.hs
index 15908c6..aa68aac 100644 (file)
--- a/program/PMDefaults.hs
+++ b/program/PMDefaults.hs
@@ -7,7 +7,7 @@ import qualified CS2MinCostFlow
 
 pmDefaults = PMConfig {
 
--- Choose a min-cost flow implementation (timings on mattlaptop2):
+-- === Choose a min-cost flow implementation (timings on mattlaptop2) ===
 
 -- A naive implementation that is slow for all but the smallest instances
 -- (30s on a 20x50 example).
@@ -19,8 +19,11 @@ minCostFlow = NaiveMinCostFlow.minCostFlow,
 -- compile CS2 with -DPRINT_ANS, or this won't work!
 --minCostFlow = CS2MinCostFlow.minCostFlow,
 
+-- The number of reviews each proposal should get.
 reviewsEachProposal = 3,
 
+-- === Interpretation of the preference values ===
+
 prefIsExpert = \p -> p <= 10,
 prefIsKnowledgeable = \p -> p <= 20,
 
@@ -29,8 +32,12 @@ prefIsVeryBoring = \p -> p > 25,
 
 prefIsConflict = \p -> p >= 40,
 
--- For now this is absolute.  Later it might be proportional to a reviewer's
--- target load.
+-- === Tuning parameters for the matcher ===
+
+-- The number of reviews by which a reviewer's load may exceed his/her target
+-- load of (relativeLoad * ceiling(numProps * reviewsEachProposal /
+-- totalRelativeLoad)).  For now this is an additive constant; perhaps it should
+-- be proportional to the target load.
 loadTolerance = 1,
 
 -- Cost to overload by one review.
@@ -43,7 +50,7 @@ marginalBoringCost = \lx -> 1000 + lx*1000,
 -- Additional cost to review a very boring proposal.
 marginalVeryBoringCost = \lx -> 1000 + lx*1000,
 
--- Cost to make a review.
+-- Cost to make a review.  Used by the evaluator too.
 -- I'm using quadratic cost functions as a first attempt.
 assignmentCost = \pref -> (numAsWt 10 + pref) ^ 2,