Skip to content

Commit

Permalink
release prep
Browse files Browse the repository at this point in the history
  • Loading branch information
Will McGinnis committed Mar 29, 2020
1 parent ad70f4d commit 37afaf5
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
==============

Expand Down
12 changes: 4 additions & 8 deletions elote/competitors/elo.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@ 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
the rating difference between them and their competitor.
[1] Elo, Arpad (1978). The Rating of Chessplayers, Past and Present. Arco. ISBN 0-668-04721-6.
Basic Usage
-----------
**Basic Usage**
.. code-block:: python
Expand All @@ -28,17 +26,15 @@ 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.
* _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
Expand Down
2 changes: 1 addition & 1 deletion version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.0.5'
__version__ = '0.1.0'

0 comments on commit 37afaf5

Please sign in to comment.