Skip to main content

Ranking Simulation Testing Tool

Project description

RSTT

MIT License PyPI - Types Documentation Status codecov RSTT Discord

Simulation Framework for Tournament and Ranking in Competition

  • ⚠️ ALPHA version. Package still under construction. Feature suggestions are welcomed.
  • 💡 Design for simulation based research
  • 💽 Production of large synthetic dataset
  • 💻 Automated simulation workflow
  • 📃 Document model by referercing class sources
  • 📈 Enhance Analysis by comparing trained models to simulation models.
  • 🔧 Design and integrate custom components
  • ❓ 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

RSTT stands for Ranking Simulation Testing Tool.

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.

It 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 are great start for 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 questions. Several features of RSTT are based on it.
  • 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

The tutorials contains a collections of topic to about RSTT usages.

  1. The basics illustrate common fonctionnalities and
  2. Integreation. You can use use extermaly defined rating system in RSTT. We provide an example for with openskill. It can easly be extended to trueskill.
  3. Simulation based research should not be code dependant, rather model dependant. tutrial_3 propose a reproduction of A Krifa & Cie [4]. There is an exercises version where you code part of the experiments, and a solutions one that runs most of the research report.

Soon Available: 4) Modeling. You can extend and developp your own model and integrate them well into simulation. We model a professional video game ecosystem from ranking specfifcation to leagues structures with international events.

Package Concept

The rstt package is build on 5 fundamental abstractions:

  • 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 that assign a score to a game instance. Usually implements probabilistic model based on player level.
  • Scheduler: Automated game generator procedure. Matchmaking and Competition are scheduler. The package provides standards like elimination bracket and round robin variations.
  • Ranking: Composed of a standing, a rating system, an inference method and a data update procedure, rankings estimate skill value of player.

Regarding ranking's component.

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

Community

Join our Discord and exchange with us.

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. https://www.stat.berkeley.edu/~aldous/Papers/me-Elo-SS.pdf

[3] Tang, S., Wang, Y., & Jin, C. (2025). Is Elo Rating Reliable? A Study Under Model Misspecification. arXiv preprint arXiv:2502.10985. https://arxiv.org/pdf/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⟩. https://hal.science/hal-03286065/document

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.7.tar.gz (67.0 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.7-py3-none-any.whl (86.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rstt-0.6.7.tar.gz
  • Upload date:
  • Size: 67.0 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.7.tar.gz
Algorithm Hash digest
SHA256 93795977962d648cbbcb6649a925bbf52a98b9f2f254a8ff05a90eeba0886623
MD5 d796e014505752a290773eda652eae43
BLAKE2b-256 e97d6c427ce4688c9949ac886c76aa0af71861421ccd54d762f3527a1b9d9972

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rstt-0.6.7-py3-none-any.whl
  • Upload date:
  • Size: 86.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 fd927e9e6bbc81c582d219e4be65fe07cc39fc6cfccf2565a8f4b54f600560d4
MD5 b1e66245e7dfeac164490175bb4075e6
BLAKE2b-256 01c0299d24c2c76d1d32af390732f84b9c79dedecfe172b8e6f947b19a134f78

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