Skip to content

Latest commit

 

History

History
133 lines (102 loc) · 4.36 KB

README.md

File metadata and controls

133 lines (102 loc) · 4.36 KB
Raw

gamewinner

Checked with mypy Code style: black Imports: isort

March madness predictor. Bring your own game winning prediction algorithm and hope for the best library and get a bracket printed out with the winners, along with a score for the final game.

How it works

Data Model

Only data included in the official NCAA bracket will be provided. The following data points are included:

  • team name
  • region
  • bracket rank
  • wins
  • losses

Additional data such as national rankings or seasonal statistics are not included as part of the main library, but should be implemented as part of a concrete strategy (see IEvanMiyaStrategy for an example of this).

Teams in the first four have their region marked as <REGION>-Playoff along with the regional rank they're competing for.

For example, this is a sample of the 2022 bracket data used as test data:

Team Name,Region,Regional Rank,Wins,Losses
Rutgers,West-Playoff,11,18,13
Notre Dame,West-Playoff,11,22,10
Texas Southern,Midwest-Playoff,16,18,12
Texas A&M CC,Midwest-Playoff,16,23,11
Wright St.,South-Playoff,16,21,13
Bryant,South-Playoff,16,22,9
Wyoming,East-Playoff,12,25,8
Indiana,East-Playoff,12,20,13
Gonzaga,West,1,26,3
Georgia St.,West,16,18,10
Boise St.,West,8,27,7
Memphis,West,9,21,10
Uconn,West,5,23,9
New Mexico St.,West,12,26,6
Arkansas,West,4,25,8
Vermont,West,13,28,5
Alabama,West,6,19,3
Texas Tech,West,3,25,9
...

Define a Strategy

Implement a class that inherits from the IStrategy interface defined in istrategy.py. Example strategies can be found in gamewinner/strategies/ (i.e. the classic BestRankWins).

The class has 4 main methods:

prepare(teams: dict[str,Team]) -> None

  • gets called after the teams are loaded into the bracket but before any games (including first four) are played
  • used to do any external data fetching, rank teams, etc.
  • defaults to no-op if you don't override the method

adjust(teams: dict[str,Team]) -> None

  • gets called before each round, including the first four
  • adjust your strategy to accomodate "Cinderella factor" or how to recover after an upset
  • defaults to no-op if you don't override the method

pick(team1: Team, team2: Team) -> tuple[Team, Team]

  • pick a winner using whatever method you think will make you the gamewinner
  • the whole point of the library

predict_score(winner: Team, loser: Team) -> tuple[int, int]

  • predict the score of a game, generally reserved for the final game

Run the model

Once you've got your strategy figured out, printing a sample bracket is trivial. The only requirement is Python 3.10 with standard library, so the tooling should work with any Python package manager (pip, poetry, conda, pipenv, etc.) on pretty much any system.

from gamewinner import gamewinner
from yourlib.strategies import YourFavoriteStrategy

gamewinner.play(strategy=YourFavoriteStrategy())

Or in your terminal with poetry

poetry run play --help
#usage: play [-h] [--strategy STRATEGY] [--year YEAR] [--printer PRINTER]
#
#options:
#  -h, --help           show this help message and exit
#  --strategy STRATEGY  what strategy you want to use, must be one of ['BestRankWins',
#                       'MrFreeze', 'SlothfireSteady', 'SlothfireSteadiest',
#                       'SlothfireSteadyBayz', 'TheCuts23', 'TheCuts23Frozen',
#                       'TheCuts23DumBayz', 'VanillaMiya', 'WorstRankWins']
#  --year YEAR          year you want to play
#  --printer PRINTER    how to print the bracket, must be one of {'plaintext', 'color'}
#

There is an additional make target if that's preferable, though you don't get all the features:

make play strategy=BestRankWins

That's it. Good luck!

Special thanks to Vulfpeck for the name inspiration.