Skip to main content

Ranking Simulation Testing Tool

Project description

RSTT

MIT License PyPI - Types Documentation Status Awpy Discord

Simulation Framework for Tournament and Ranking in Competition

  • :warning: ALPHA version. Package still under construction. Do not hesitate to suggest features addition
  • :bulb: Design for simulation based research
  • :minidisc: Production of large synthetic dataset
  • :computer: Automated simulation workflow
  • :page_with_curl: Document your model by referercing class sources
  • :chart_with_upwards_trend: Enhance Analysis by comparing trained models to simulation models.
  • :wrench: Design and integrate your own custom components
  • :question: Support and advise on Discord

Installation

The package is available on PyPi. To install, run

pip install rstt

User Documentation is available on readthedocs.

Description

The package provides everything needed to simulate competition and generate synthetic match dataset. It contains ranking implementation (such as Elo and Glicko ...), popular tournament format (Single elimination bracket, round robin, ...), many versus many game mode with automated outcome (score/result) generation methods. Additionaly different player model are available, including time varing strenght.

RSTT is a framework, letting user developp and intergrate with ease their own models to test.

Getting Started

Code Example

from rstt import Player, BTRanking, LogSolver, BasicElo
from rstt import SingleEliminationBracket

# some player
population = Player.create(nb=16)

# a ranking to infer player's skills.
elo = BasicElo(name='Elo Ranking', players=population)

# display the ranking to the standard output
elo.plot()

# create a competition - the solver param specify how match outcome are generated
tournament = SingleEliminationBracket(name='RSTT World Cup 2024', seeding=elo, solver=LogSolver())

# register player, unranked partcipants get assigned lower seeds.
tournament.registration(population)

# play the tournament - the magic happens!
tournament.run()

# update ranking based on games played
elo.update(games=tournament.games())

# display the updated ranking
elo.plot()

# The LogSolver implies a 'Consensus' Ranking based on 'the real level' of players.
truth = BTRanking(name='Consensus Ranking', players=population)
truth.plot()

Simulation Based Research

RSTT is meant for science and simulation based research in the context of competition. Whenever possible code is based on peer reviewed publication and cite the sources.

The following papers can be good read to start a journey in the field:

  • Anu Maria [1], covers steps to follow and pitfalls to avoid in simulation based research.
  • D. Aldous [2] presents base models in the context of sport competition and introduce research questiions. Several classes and features of RSTT are implemetion from this paper.
  • S. Tang & Cie [3] Is a recent example of reseach. It uses synthetic dataset to provide insight about observations in real game data set.

Tutorial

Simulation based research should not be code dependant, rather model dependant. Thus I propose as tutrial a reproduction of result from A Krifa & Cie [4], which was originaly performed in R. It is a great example of the rstt features as it uses ranking, solver and scheduler models.

Package Concept

The rstt package is build on 5 fundamental abstraction:

  • Player: who participate in games and are items in rankings. Different models are available including ones with 'time varying skills'
  • Match: which represent more the notion of an encounter than a game title with rules. It contains players grouped in teams to which a Score (the outcome) is assigned once.
  • Solver: Protocol with a solve(Match) that assign a score to a game instance. Usually implements probabilistic model based on player level.
  • Scheduler: Automated game generator protocol. Matchmaking and Competition are scheduler, the package includes standards like elimination bracket and round robin variations..
  • Ranking: Implmeneted as a tuple (standing, rating system, inference method, observer) that estimate a skill value (or point) for player.

Regarding ranking's component.

  • Standing: is an hybrid container that implement a triplet relationship between (rank: int, player: Player, point: float) and behave like a List[Player ], Dict[Player, rank] and Dict[rank, Player]
  • RatingSystem: store data computed by ranking for player
  • Inferer: in charge of statistical inference and provide a rate() method.
  • Observer: manage the workflow from the observation that triggers the update of a ranking to the new computed ratings of players.

Community

How to cite

If you use RSTT, consider linking back to this repo!

Source

[1] Anu Maria. (1997). Introduction to modeling and simulation. In Proceedings of the 29th conference on Winter simulation (WSC '97). IEEE Computer Society, USA, 7–13. https://doi.org/10.1145/268437.268440

[2] Aldous, D. (2017). Elo ratings and the sports model: A neglected topic in applied probability? Statistical Science, 32(4):616–629, 2017.

[3] Tang, S., Wang, Y., & Jin, C. (2025). Is Elo Rating Reliable? A Study Under Model Misspecification. arXiv preprint arXiv:2502.10985.

[4] Adrien Krifa, Florian Spinelli, Stéphane Junca. On the convergence of the Elo rating system for a Bernoulli model and round-robin tournaments. [Research Report] Université Côte D’Azur. 2021. ⟨hal-03286065⟩.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rstt-0.6.5.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rstt-0.6.5-py3-none-any.whl (78.7 kB view details)

Uploaded Python 3

File details

Details for the file rstt-0.6.5.tar.gz.

File metadata

  • Download URL: rstt-0.6.5.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.2 Darwin/21.6.0

File hashes

Hashes for rstt-0.6.5.tar.gz
Algorithm Hash digest
SHA256 568d1542d313f05367a5021f2273aaa18004c3fdc136f52d174346bf77602234
MD5 d5973e54e04e5772868450b3c0f04d8d
BLAKE2b-256 a9c71545b6496dfae7726b7d7e314f339e8b03fa944e40812876be69e6244d38

See more details on using hashes here.

File details

Details for the file rstt-0.6.5-py3-none-any.whl.

File metadata

  • Download URL: rstt-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 78.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.2 Darwin/21.6.0

File hashes

Hashes for rstt-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b36dba20ff738fada7ac204c7d366be63e6528624e31d00ead6dd631d22753a2
MD5 9214a8228b4e8e82742fde66285f3700
BLAKE2b-256 4d900c8c7003436c77fa0aa59a2dc57dabd1aa3919834119fdb400b18d9dbd5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page