Skip to content

Commit

Permalink
Improved README, added a picture.
Browse files Browse the repository at this point in the history
I also added a reference to Kickoff.ai, since it is the project that
drove the development of kickscore.
  • Loading branch information
lucasmaystre committed Jul 25, 2019
1 parent 4c5aaa3 commit 6b161b8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
21 changes: 14 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@ kickscore

|build-status| |coverage|

``kickscore`` is a dynamic skill rating system, similar to the `Elo rating
system <https://en.wikipedia.org/wiki/Elo_rating_system>`_ and to `TrueSkill
<https://en.wikipedia.org/wiki/TrueSkill>`_. It comes as a Python 3 library.
``kickscore`` is the dynamic skill rating system powering `Kickoff.ai
<https://kickoff.ai/>`_.

In short, ``kickscore`` can be used to understand & visualize the skill of
players competing in pairwise matches, and to predict outcomes of future
matches.
players (or teams) competing in pairwise matches, and to predict outcomes of
future matches. It extends the `Elo rating system
<https://en.wikipedia.org/wiki/Elo_rating_system>`_ and `TrueSkill
<https://en.wikipedia.org/wiki/TrueSkill>`_.

|nba-history|

Getting started
---------------
Expand All @@ -22,10 +25,10 @@ To get started, you might want to explore one of these notebooks:

- `Basic example illustrating the API <examples/kickscore-basics.ipynb>`_
(`interactive version
<https://colab.research.google.com/github/lucasmaystre/kickscore/blob/master/examples/kickscore-basics.ipynb>`_)
<https://colab.research.google.com/github/lucasmaystre/kickscore/blob/master/examples/kickscore-basics.ipynb>`__)
- `Visualizing the history of the NBA <examples/nba-history.ipynb>`_
(`interactive version
<https://colab.research.google.com/github/lucasmaystre/kickscore/blob/master/examples/nba-history.ipynb>`_)
<https://colab.research.google.com/github/lucasmaystre/kickscore/blob/master/examples/nba-history.ipynb>`__)

References
----------
Expand All @@ -46,3 +49,7 @@ References
:alt: code coverage
:scale: 100%
:target: https://codecov.io/gh/lucasmaystre/kickscore

.. |nba-history| image:: https://lum-public.s3-eu-west-1.amazonaws.com/kickscore-nba-history.svg
:alt: evolution of NBA teams' skill over history
:scale: 100%
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def readme():

setup(
name="kickscore",
version="0.1.2",
version="0.1.4",
author="Lucas Maystre",
author_email="[email protected]",
description="A dynamic skill rating system.",
Expand Down

0 comments on commit 6b161b8

Please sign in to comment.