xonstat/glicko.py

   1 import logging
   2 import math
   3 import sys
   4
   5 from xonstat.models import PlayerGlicko, Game, PlayerGameStat
   6
   7 log = logging.getLogger(__name__)
   8
   9 # DEBUG
  10 # log.addHandler(logging.StreamHandler())
  11 # log.setLevel(logging.DEBUG)
  12
  13 # the default system volatility constant
  14 TAU = 0.3
  15
  16 # how much ping influences results
  17 LATENCY_TREND_FACTOR = 0.2
  18
  19
  20 def calc_g(phi):
  21     return 1 / math.sqrt(1 + (3 * phi ** 2) / (math.pi ** 2))
  22
  23
  24 def calc_e(mu, mu_j, phi_j):
  25     return 1. / (1 + math.exp(-calc_g(phi_j) * (mu - mu_j)))
  26
  27
  28 def calc_v(gs, es):
  29     """ Estimated variance of the team or player's ratings based only on game outcomes. """
  30     total = 0.0
  31     for i in range(len(gs)):
  32         total += (gs[i] ** 2) * es[i] * (1-es[i])
  33
  34     return 1. / total
  35
  36
  37 def calc_delta(v, gs, es, results):
  38     """
  39     Compute the estimated improvement in rating by comparing the pre-period rating to the
  40     performance rating based only on game outcomes.
  41     """
  42     total = 0.0
  43     for i in range(len(gs)):
  44         total += gs[i] * (results[i] - es[i])
  45
  46     return v * total
  47
  48
  49 def calc_sigma_bar(sigma, delta, phi, v, tau=TAU):
  50     """ Compute the new volatility. """
  51     epsilon = 0.000001
  52     A = a = math.log(sigma**2)
  53
  54     # pre-compute some terms
  55     delta_sq = delta ** 2
  56     phi_sq = phi ** 2
  57
  58     def f(x):
  59         e_up_x = math.e ** x
  60         term_a = (e_up_x * (delta_sq - phi_sq - v - e_up_x)) / (2 * (phi_sq + v + e_up_x) ** 2)
  61         term_b = (x - a) / tau ** 2
  62         return term_a - term_b
  63
  64     if delta_sq > (phi_sq + v):
  65         B = math.log(delta_sq - phi_sq - v)
  66     else:
  67         k = 1
  68         while f(a - k * tau) < 0:
  69             k += 1
  70         B = a - k * tau
  71
  72     fa, fb = f(A), f(B)
  73     while abs(B - A) > epsilon:
  74         C = A + (A - B) * (fa / (fb - fa))
  75         fc = f(C)
  76
  77         if fc * fb < 0:
  78             A, fa = B, fb
  79         else:
  80             fa /= 2
  81
  82         B, fb = C, fc
  83
  84         # DEBUG
  85         # log.debug("A={}, B={}, C={}, fA={}, fB={}, fC={}".format(A, B, C, fa, fb, fc))
  86
  87     return math.e ** (A / 2)
  88
  89
  90 def rate(player, opponents, results):
  91     """
  92     Calculate the ratings improvement for a given player, provided their opponents and
  93     corresponding results versus them.
  94     """
  95     p_g2 = player.to_glicko2()
  96
  97     gs = []
  98     es = []
  99     for i in range(len(opponents)):
 100         o_g2 = opponents[i].to_glicko2()
 101         gs.append(calc_g(o_g2.phi))
 102         es.append(calc_e(p_g2.mu, o_g2.mu, o_g2.phi))
 103
 104         # DEBUG
 105         # log.debug("j={} muj={} phij={} g={} e={} s={}"
 106                   # .format(i+1, o_g2.mu, o_g2.phi, gs[i], es[i], results[i]))
 107
 108     v = calc_v(gs, es)
 109     delta = calc_delta(v, gs, es, results)
 110     sigma_bar = calc_sigma_bar(p_g2.sigma, delta, p_g2.phi, v)
 111
 112     phi_tmp = math.sqrt(p_g2.phi ** 2 + sigma_bar ** 2)
 113     phi_bar = 1/math.sqrt((1/phi_tmp**2) + (1/v))
 114
 115     sum_terms = 0.0
 116     for i in range(len(opponents)):
 117         sum_terms += gs[i] * (results[i] - es[i])
 118
 119     mu_bar = p_g2.mu + phi_bar**2 * sum_terms
 120
 121     new_rating = PlayerGlicko(player.player_id, player.game_type_cd, player.category, mu_bar,
 122                               phi_bar, sigma_bar).from_glicko2()
 123
 124     # DEBUG
 125     # log.debug("v={}".format(v))
 126     # log.debug("delta={}".format(delta))
 127     # log.debug("sigma_temp={}".format(sigma_temp))
 128     # log.debug("sigma_bar={}".format(sigma_bar))
 129     # log.debug("phi_bar={}".format(phi_bar))
 130     # log.debug("mu_bar={}".format(mu_bar))
 131     # log.debug("new_rating: {} {} {}".format(new_rating.mu, new_rating.phi, new_rating.sigma))
 132
 133     return new_rating
 134
 135
 136 class KReduction:
 137     """
 138     Scale the points gained or lost for players based on time played in the given game.
 139     """
 140     def __init__(self, full_time=600, min_time=120, min_ratio=0.5):
 141         # full time is the time played to count the player in a game
 142         self.full_time = full_time
 143
 144         # min time is the time played to count the player at all in a game
 145         self.min_time = min_time
 146
 147         # min_ratio is the ratio of the game's time to be played to be counted fully (provided
 148         # they went past `full_time` and `min_time` above.
 149         self.min_ratio = min_ratio
 150
 151     def eval(self, my_time, match_time):
 152         # kick out players who didn't play enough of the match
 153         if my_time < self.min_time:
 154             return 0.0
 155
 156         if my_time < self.min_ratio * match_time:
 157             return 0.0
 158
 159         # scale based on time played versus what is defined as `full_time`
 160         if my_time < self.full_time:
 161             k = my_time / float(self.full_time)
 162         else:
 163             k = 1.0
 164
 165         return k
 166
 167
 168 # Parameters for reduction of points
 169 KREDUCTION = KReduction()
 170
 171
 172 class GlickoWIP(object):
 173     """ A work-in-progress Glicko value. """
 174     def __init__(self, pg):
 175         """
 176         Initialize a GlickoWIP instance.
 177         :param pg: the player's PlayerGlicko record.
 178         """
 179         # the player's current (or base) PlayerGlicko record
 180         self.pg = pg
 181
 182         # the list of k factors for each game in the ranking period
 183         self.k_factors = []
 184
 185         # the list of ping factors for each game in the ranking period
 186         self.ping_factors = []
 187
 188         # the list of opponents (PlayerGlicko or PlayerGlickoBase) in the ranking period
 189         self.opponents = []
 190
 191         # the list of results for those games in the ranking period
 192         self.results = []
 193
 194
 195 class GlickoProcessor(object):
 196     """
 197     Processes an arbitrary list games using the Glicko2 algorithm.
 198     """
 199     def __init__(self, session):
 200         """
 201         Create a GlickoProcessor instance.
 202
 203         :param session: the SQLAlchemy session to use for fetching/saving records.
 204         """
 205         self.session = session
 206         self.wips = {}
 207
 208     def _pingratio(self, pi, pj):
 209         """
 210         Calculate the ping differences between the two players, but only if both have them.
 211
 212         :param pi: the latency of player I
 213         :param pj: the latency of player J
 214         :return: float
 215         """
 216         if pi is None or pj is None or pi < 0 or pj < 0:
 217             # default to a draw
 218             return 0.5
 219
 220         else:
 221             return float(pi)/(pi+pj)
 222
 223     def _load_game(self, game_id):
 224         try:
 225             game = self.session.query(Game).filter(Game.game_id==game_id).one()
 226             return game
 227         except Exception as e:
 228             log.error("Game ID {} not found.".format(game_id))
 229             log.error(e)
 230             raise e
 231
 232     def _load_pgstats(self, game):
 233         """
 234         Retrieve the game stats from the database for the game in question.
 235
 236         :param game: the game record whose player stats will be retrieved
 237         :return: list of PlayerGameStat
 238         """
 239         try:
 240             pgstats_raw = self.session.query(PlayerGameStat)\
 241                 .filter(PlayerGameStat.game_id==game.game_id)\
 242                 .filter(PlayerGameStat.player_id > 2)\
 243                 .all()
 244
 245         except Exception as e:
 246             log.error("Error fetching player_game_stat records for game {}".format(game.game_id))
 247             log.error(e)
 248             raise e
 249
 250         pgstats = []
 251         for pgstat in pgstats_raw:
 252             # ensure warmup isn't included in the pgstat records
 253             if pgstat.alivetime > game.duration:
 254                 pgstat.alivetime = game.duration
 255
 256             # ensure players played enough of the match to be included
 257             k = KREDUCTION.eval(pgstat.alivetime.total_seconds(), game.duration.total_seconds())
 258             if k <= 0.0:
 259                 continue
 260             else:
 261                 pgstats.append(pgstat)
 262
 263         return pgstats
 264
 265     def _load_glicko_wip(self, player_id, game_type_cd, category):
 266         """
 267         Retrieve a PlayerGlicko record from the database.
 268
 269         :param player_id: the player ID to fetch
 270         :param game_type_cd: the game type code
 271         :param category: the category of glicko to retrieve
 272         :return: PlayerGlicko
 273         """
 274         if (player_id, game_type_cd, category) in self.wips:
 275             return self.wips[(player_id, game_type_cd, category)]
 276
 277         try:
 278             pg = self.session.query(PlayerGlicko)\
 279                      .filter(PlayerGlicko.player_id==player_id)\
 280                      .filter(PlayerGlicko.game_type_cd==game_type_cd)\
 281                      .filter(PlayerGlicko.category==category)\
 282                      .one()
 283
 284         except:
 285             pg = PlayerGlicko(player_id, game_type_cd, category)
 286
 287         # cache this in the wips dict
 288         wip = GlickoWIP(pg)
 289         self.wips[(player_id, game_type_cd, category)] = wip
 290
 291         return wip
 292
 293     def load(self, game_id):
 294         """
 295         Load all of the needed information from the database. Compute results for each player pair.
 296         """
 297         game = self._load_game(game_id)
 298         pgstats = self._load_pgstats(game)
 299         game_type_cd = game.game_type_cd
 300         category = game.category
 301
 302         # calculate results:
 303         #   wipi/j => work in progress record for player i/j
 304         #   ki/j   => k reduction value for player i/j
 305         #   si/j   => score per second for player i/j
 306         #   pi/j   => ping ratio for player i/j
 307         for i in xrange(0, len(pgstats)):
 308             wipi = self._load_glicko_wip(pgstats[i].player_id, game_type_cd, category)
 309             ki = KREDUCTION.eval(pgstats[i].alivetime.total_seconds(),
 310                                  game.duration.total_seconds())
 311             si = pgstats[i].score/float(game.duration.total_seconds())
 312
 313             for j in xrange(i+1, len(pgstats)):
 314                 # ping factor is opponent-specific
 315                 pi = self._pingratio(pgstats[i].avg_latency, pgstats[j].avg_latency)
 316                 pj = 1.0 - pi
 317
 318                 wipj = self._load_glicko_wip(pgstats[j].player_id, game_type_cd, category)
 319                 kj = KREDUCTION.eval(pgstats[j].alivetime.total_seconds(),
 320                                      game.duration.total_seconds())
 321                 sj = pgstats[j].score/float(game.duration.seconds)
 322
 323                 # normalize scores
 324                 ofs = min(0.0, si, sj)
 325                 si -= ofs
 326                 sj -= ofs
 327                 if si + sj == 0:
 328                     si, sj = 1, 1 # a draw
 329
 330                 scorefactor_i = si / float(si + sj)
 331                 scorefactor_j = 1.0 - si
 332
 333                 wipi.k_factors.append(ki)
 334                 wipi.ping_factors.append(pi)
 335                 wipi.opponents.append(wipj.pg)
 336                 wipi.results.append(scorefactor_i)
 337
 338                 wipj.k_factors.append(kj)
 339                 wipj.ping_factors.append(pj)
 340                 wipj.opponents.append(wipi.pg)
 341                 wipj.results.append(scorefactor_j)
 342
 343     def process(self):
 344         """
 345         Calculate the Glicko2 ratings, deviations, and volatility updates for the records loaded.
 346         """
 347         for wip in self.wips.values():
 348             new_pg = rate(wip.pg, wip.opponents, wip.results)
 349
 350             log.debug("New rating for player {} before factors: mu={} phi={} sigma={}"
 351                       .format(pg.player_id, new_pg.mu, new_pg.phi, new_pg.sigma))
 352
 353             avg_k_factor = sum(wip.k_factors)/len(wip.k_factors)
 354             avg_ping_factor = LATENCY_TREND_FACTOR * sum(wip.ping_factors)/len(wip.ping_factors)
 355
 356             points_delta = (new_pg.mu - wip.pg.mu) * avg_k_factor * avg_ping_factor
 357
 358             wip.pg.mu += points_delta
 359             wip.pg.phi = new_pg.phi
 360             wip.pg.sigma = new_pg.sigma
 361
 362             log.debug("New rating for player {} after factors: mu={} phi={} sigma={}"
 363                       .format(wip.pg.player_id, wip.pg.mu, wip.pg.phi, wip.pg.sigma))
 364
 365     def save(self, session):
 366         """
 367         Put all changed PlayerElo and PlayerGameStat instances into the
 368         session to be updated or inserted upon commit.
 369         """
 370         for wip in self.wips.values():
 371             session.add(wip.pg)
 372
 373         session.commit()
 374
 375
 376 def main():
 377     # the example in the actual Glicko2 paper, for verification purposes
 378     pA = PlayerGlicko(1, "duel", mu=1500, phi=200)
 379     pB = PlayerGlicko(2, "duel", mu=1400, phi=30)
 380     pC = PlayerGlicko(3, "duel", mu=1550, phi=100)
 381     pD = PlayerGlicko(4, "duel", mu=1700, phi=300)
 382
 383     opponents = [pB, pC, pD]
 384     results = [1, 0, 0]
 385
 386     rate(pA, opponents, results)
 387
 388
 389 if __name__ == "__main__":
 390      sys.exit(main())