From 37afaf517b9afb07b957e215a1ddaeb8e2c37305 Mon Sep 17 00:00:00 2001 From: Will McGinnis Date: Sun, 29 Mar 2020 17:34:01 -0400 Subject: [PATCH] release prep --- CHANGELOG.md | 7 +++++++ elote/competitors/elo.py | 12 ++++-------- version.py | 2 +- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c18f20c..ed705d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +v0.1.0 +====== + + * Many bugfixes + * Improved testing and documentation + * Added notion of history object and bout objects for arenas to track progress + v0.0.3,4 and 5 ============== diff --git a/elote/competitors/elo.py b/elote/competitors/elo.py index 110de42..bc2a136 100644 --- a/elote/competitors/elo.py +++ b/elote/competitors/elo.py @@ -7,8 +7,7 @@ class EloCompetitor(BaseCompetitor): def __init__(self, initial_rating: float = 400): """ - Overview - ======== + **Overview** Elo rating is a rating system based on pairwise comparisons. Ratings are given to competitors based on their comparisons (bouts) with peers, in which they can win, lose or tie. The change in a players rating is scaled by @@ -16,8 +15,7 @@ def __init__(self, initial_rating: float = 400): [1] Elo, Arpad (1978). The Rating of Chessplayers, Past and Present. Arco. ISBN 0-668-04721-6. - Basic Usage - ----------- + **Basic Usage** .. code-block:: python @@ -28,8 +26,7 @@ def __init__(self, initial_rating: float = 400): print('probability of better beating good: %5.2f%%' % (better.expected_score(good) * 100, )) - Class Variables - --------------- + **Class Variables** Class variables are configured for all competitors in a population, not on a per-competitor basis. See the documentation on ``Arenas`` to see how to set these safely. @@ -37,8 +34,7 @@ def __init__(self, initial_rating: float = 400): * _base_rating: defaults to 400. * _k_factor: tunes the speed of response to new information, higher is faster response. Default=32 - Configuration Options - --------------------- + **Configuration Options** :param initial_rating: the initial rating to use for a new competitor who has no history. Default 400 :type initial_rating: int diff --git a/version.py b/version.py index a55ccd2..541f859 100644 --- a/version.py +++ b/version.py @@ -1 +1 @@ -__version__ = '0.0.5' \ No newline at end of file +__version__ = '0.1.0' \ No newline at end of file