diff options
| author | Luke Shumaker <shumakl@purdue.edu> | 2014-04-26 21:12:00 -0400 |
|---|---|---|
| committer | Luke Shumaker <shumakl@purdue.edu> | 2014-04-26 21:12:00 -0400 |
| commit | edb9e6a59459b42acb8dc751044d51c70e81429c (patch) | |
| tree | 7db7b1b74a7f249a5d29dfb9ce023e03b182dedd /lib/scoring/README.md | |
| parent | edcca83c6c251a79afcd83760cf20ebaf00b3b32 (diff) | |
clean up lib/scoring (a bit)
Diffstat (limited to 'lib/scoring/README.md')
| -rw-r--r-- | lib/scoring/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/scoring/README.md b/lib/scoring/README.md new file mode 100644 index 0000000..95dd5e0 --- /dev/null +++ b/lib/scoring/README.md @@ -0,0 +1,10 @@ +Files in this directory should be modules implementing the following +interface: + + - `stats_needed() => Array[i]=Symbol` + Returns which statistics need to be collected for this scoring + algorithm. + + - `score(match) => Hash[User]=Integer` + User scores for this match, assuming statistics have been + collected. |