docs: document the whole public surface and deny(missing_docs)
80 undocumented public items, including three that are first contact:
`History::current_skill` — the method the crate's own first example calls
— `EventBuilder`, the type `h.event(t)` hands you, and `Gaussian::mu()`.
Now zero, and `#![deny(missing_docs)]` keeps it that way.
Several docs are measurements rather than readings of the code:
- `Outcome::Ranked` says ranks are used ordinally, so `[0, 1, 2]` and
`[0, 5, 90]` are the same observation. Measured: bit-identical
posteriors for both.
- `OwnedGame::log_evidence` says two identically-rated competitors give
exactly `ln(0.5)`. Written as a doctest, so it runs.
- `Member::weight` says zero and negative are accepted. Measured.
- `ConvergenceReport::final_step` is `(|Δmu|, |Δsigma|)` in skill units,
NOT natural parameters. That one had to be traced through
`Gaussian::delta` rather than assumed from the neighbouring vocabulary.
- `GameOptions::score_sigma` rejects non-positive and NaN but accepts
`+inf`, which is what the guard actually says.
README: it is the front door for a crate on a private registry, and it
opened with a link dump followed by 130 lines on drift. The first
`record_winner → converge → current_skill` block was at line 226 of 307.
It now leads with what the crate is, an install line, a quickstart, a
"which entry point?" table, and the `converge`-is-strict rationale that
was the crate's most opinionated recent decision and went unmentioned.
The two canonical examples disagreed on spelling (`History::default()`
vs `History::builder().build()`, `current_skill("a")` vs
`current_skill(&"a")`); they now agree. Five new README blocks are
doctested, taking the suite from 19 to 25.
`pub use smallvec;`. Four public items name `SmallVec` in their
signatures, and the only `Joint` example failed to compile from a
consumer crate with `unresolved import smallvec` — the dependency was in
the API but not reachable. Both worked examples now use the re-export,
so they teach the path that works downstream.
Vocabulary, from #75: "agent" was a fourth word for competitor, 200
occurrences, and it had reached public signatures before #73 un-exported
`TimeSlice`. Now zero.
Closes #77. Refs #75.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011hcFjNDmHXZF8URGLku5zZ
This commit is contained in:
@@ -1,15 +1,142 @@
|
||||
# TrueSkill - Through Time
|
||||
|
||||
Rust port of [TrueSkillThroughTime.py](https://github.com/glandfried/TrueSkillThroughTime.py).
|
||||
Bayesian skill rating over a time axis.
|
||||
|
||||
## Other implementations
|
||||
Where plain TrueSkill gives each competitor one running estimate, TrueSkill
|
||||
Through Time treats a whole history as a single model and infers skill *at every
|
||||
point in time*. Evidence flows both directions: a result today sharpens the
|
||||
estimate of who someone was last year, so early estimates stop being frozen
|
||||
guesses and comparisons across eras become meaningful.
|
||||
|
||||
- [ttt-scala](https://github.com/ankurdave/ttt-scala)
|
||||
- [ChessAnalysis #F](https://github.com/lucasmaystre/ChessAnalysis)
|
||||
- [TrueSkillThroughTime.jl](https://github.com/glandfried/TrueSkillThroughTime.jl)
|
||||
- [TrueSkillThroughTime.R](https://github.com/glandfried/TrueSkillThroughTime.R)
|
||||
- [TrueSkill Through Time: Revisiting the History of Chess](https://www.microsoft.com/en-us/research/wp-content/uploads/2008/01/NIPS2007_0931.pdf)
|
||||
- [TrueSkill Through Time. The full scientific documentation](https://glandfried.github.io/publication/landfried2021-learning/)
|
||||
A Rust port of
|
||||
[TrueSkillThroughTime.py](https://github.com/glandfried/TrueSkillThroughTime.py).
|
||||
|
||||
## Install
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
trueskill-tt = "0.8"
|
||||
```
|
||||
|
||||
Optional features, both off by default:
|
||||
|
||||
- `approx` — `approx`'s equality traits for `Gaussian`. Useful in tests.
|
||||
- `rayon` — parallelises the within-slice sweep and the per-slice passes of
|
||||
`learning_curves` / `log_evidence`. Results stay bit-identical regardless of
|
||||
worker count; `just determinism` asserts it at 1, 2, 4 and 8 threads.
|
||||
|
||||
## Quickstart
|
||||
|
||||
Record results, converge, then read off skills.
|
||||
|
||||
```rust
|
||||
use trueskill_tt::History;
|
||||
|
||||
let mut history = History::default();
|
||||
|
||||
history.record_winner(&"alice", &"bob", 1)?;
|
||||
history.record_winner(&"bob", &"carol", 2)?;
|
||||
history.record_winner(&"alice", &"carol", 3)?;
|
||||
|
||||
history.converge()?;
|
||||
|
||||
let alice = history.current_skill("alice").unwrap();
|
||||
assert!(alice.mu() > 0.0, "alice won every game she played");
|
||||
# Ok::<(), trueskill_tt::InferenceError>(())
|
||||
```
|
||||
|
||||
The third argument is the time. It is what makes this Through Time rather than
|
||||
plain TrueSkill: skill is inferred at each of those moments, not once at the
|
||||
end. `learning_curve` reads the whole trajectory back.
|
||||
|
||||
```rust
|
||||
# use trueskill_tt::History;
|
||||
# let mut history = History::default();
|
||||
# history.record_winner(&"alice", &"bob", 1)?;
|
||||
# history.record_winner(&"bob", &"carol", 2)?;
|
||||
# history.record_winner(&"alice", &"carol", 3)?;
|
||||
# history.converge()?;
|
||||
// `None` means the key is unknown; `Some(vec![])` means known but unplayed.
|
||||
let curve = history.learning_curve("alice").unwrap();
|
||||
for (time, skill) in &curve {
|
||||
println!("t={time}: {:.2} ± {:.2}", skill.mu(), skill.sigma());
|
||||
}
|
||||
|
||||
// Everyone's latest posterior in one pass — the leaderboard query.
|
||||
let latest = history.current_skills();
|
||||
assert_eq!(latest.len(), 3);
|
||||
# Ok::<(), trueskill_tt::InferenceError>(())
|
||||
```
|
||||
|
||||
## Teams, rankings and draws
|
||||
|
||||
Anything beyond one-versus-one goes through the fluent event builder. An event
|
||||
is only recorded by the terminal `.commit()`.
|
||||
|
||||
```rust
|
||||
use trueskill_tt::History;
|
||||
|
||||
let mut history = History::builder().p_draw(0.1).build();
|
||||
|
||||
history
|
||||
.event(1)
|
||||
.team(["alice", "bob"])
|
||||
.team(["carol", "dave"])
|
||||
.ranking([0, 1]) // lower is better; equal values are a tie
|
||||
.commit()?;
|
||||
|
||||
history.converge()?;
|
||||
# Ok::<(), trueskill_tt::InferenceError>(())
|
||||
```
|
||||
|
||||
**A tie needs a positive `p_draw`.** A `p_draw` of zero asserts draws cannot
|
||||
happen, so a tied result has no representable likelihood and is rejected rather
|
||||
than fitted to something else:
|
||||
|
||||
```rust
|
||||
use trueskill_tt::{History, InferenceError};
|
||||
|
||||
let mut history = History::default(); // p_draw defaults to 0.0
|
||||
let err = history.record_draw(&"alice", &"bob", 1).unwrap_err();
|
||||
assert!(matches!(err, InferenceError::TieWithoutDrawProbability { .. }));
|
||||
```
|
||||
|
||||
This also catches `Outcome::winner(w, n)` for three or more teams, which ties
|
||||
every loser.
|
||||
|
||||
## Which entry point?
|
||||
|
||||
| You want to | Use |
|
||||
|---|---|
|
||||
| One match, two competitors | `record_winner` / `record_draw` |
|
||||
| Teams, explicit ranks, scores, per-member weights | `history.event(t)…commit()` |
|
||||
| A batch you already have as values | `add_events(iter)` |
|
||||
| Score a hypothetical with no history at all | `Game` |
|
||||
|
||||
`Game` is the odd one out and worth being explicit about: it is a single match's
|
||||
factor graph, it does not participate in a `History`, and nothing it computes is
|
||||
remembered. Reach for it to evaluate a matchup in isolation; reach for `History`
|
||||
for everything that accumulates.
|
||||
|
||||
## `converge` is strict
|
||||
|
||||
`converge` returns `Err(NotConverged)` if the sweep hits `max_iter` with the
|
||||
step still above `epsilon`, and `Err(NonFiniteResult)` if a sweep produces NaN.
|
||||
|
||||
It used to return `Ok` with `converged: false`, which was the worst available
|
||||
shape. A fit that stops short is *wrong by a little*: every posterior is finite,
|
||||
the ordering looks sensible, and nothing about the output says the numbers were
|
||||
still moving. Detection was opt-in, and `let _ = h.converge()` silently opted
|
||||
out — which is how a real defect hid in this crate's own test suite.
|
||||
|
||||
The default `max_iter` is high enough that reaching it means something is
|
||||
genuinely wrong rather than that the history is large; the loop exits at
|
||||
`epsilon` long before, so raising the cap costs nothing when it is not needed.
|
||||
Use `converge_partial` when a deliberately capped, unconverged fit is the point.
|
||||
|
||||
Predictions are strict for the same reason: every `predict_*` method reads
|
||||
skills through one gate that refuses a NaN-poisoned fit, rather than returning a
|
||||
plausible number computed from it.
|
||||
|
||||
## Drift
|
||||
|
||||
@@ -228,11 +355,11 @@ certain because it knows less.
|
||||
```rust
|
||||
use trueskill_tt::History;
|
||||
|
||||
let mut h = History::builder().build();
|
||||
let mut h = History::default();
|
||||
h.record_winner(&"alice", &"bob", 1).unwrap();
|
||||
let _ = h.converge().unwrap();
|
||||
h.converge().unwrap();
|
||||
|
||||
let skill = h.current_skill(&"alice").unwrap();
|
||||
let skill = h.current_skill("alice").unwrap();
|
||||
|
||||
// "How sure am I that this is below the cutoff?" — a probability, not a
|
||||
// `mu + z * sigma` band whose confidence drifts as sigma changes.
|
||||
@@ -254,7 +381,7 @@ what you believe now and what you would believe afterwards.
|
||||
```rust
|
||||
use trueskill_tt::History;
|
||||
|
||||
let mut h = History::builder().build();
|
||||
let mut h = History::default();
|
||||
for t in 1..=10 {
|
||||
h.record_winner(&"veteran", &"regular", t).unwrap();
|
||||
h.record_winner(&"regular", &"veteran", t + 100).unwrap();
|
||||
@@ -278,16 +405,21 @@ expensive than `quality()`. Scoring every pairing among `n` competitors is
|
||||
`O(n² × outcomes)` passes — shortlist with `quality()` or
|
||||
`predict_win_probabilities` first, then score only the shortlist.
|
||||
|
||||
## Todo
|
||||
## Other implementations
|
||||
|
||||
- [x] Implement approx for Gaussian
|
||||
- [x] Add more tests from `TrueSkillThroughTime.jl`
|
||||
- [x] Generalise a time axis — `Time` is now a trait (`Untimed`, `i64`), not an enum
|
||||
- [x] Add examples (`examples/atp.rs`, `examples/scored.rs`)
|
||||
- [x] Add Observer (`Observer` / `NullObserver`)
|
||||
- [x] Benchmark the inference loop (`benches/batch.rs`, `benches/history_converge.rs`, `benches/ingest.rs`)
|
||||
- [x] N-team `predict_outcome` with draw mass, and `expected_information_gain`
|
||||
- [x] Cross-check `quality()` against [sublee/trueskill](https://github.com/sublee/trueskill/tree/master) — N identical teams follow the closed form `(1/5)^((n-1)/2)` for the conventional parameters, asserted for n = 2..10, and the n=3/n=5 values (0.200, 0.040) match the reference package
|
||||
- [ttt-scala](https://github.com/ankurdave/ttt-scala)
|
||||
- [ChessAnalysis #F](https://github.com/lucasmaystre/ChessAnalysis)
|
||||
- [TrueSkillThroughTime.jl](https://github.com/glandfried/TrueSkillThroughTime.jl)
|
||||
- [TrueSkillThroughTime.R](https://github.com/glandfried/TrueSkillThroughTime.R)
|
||||
- [TrueSkill Through Time: Revisiting the History of Chess](https://www.microsoft.com/en-us/research/wp-content/uploads/2008/01/NIPS2007_0931.pdf)
|
||||
- [TrueSkill Through Time. The full scientific documentation](https://glandfried.github.io/publication/landfried2021-learning/)
|
||||
|
||||
## Status
|
||||
|
||||
Every box on the old todo list is ticked, so it has been retired; open work
|
||||
lives in the issue tracker instead. The crate is in use and the API is still
|
||||
moving — breaking changes are batched into minor releases rather than dribbled
|
||||
out, and `CHANGELOG.md` records them.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user