Page MenuHomePhabricator

Improve documentation of what happens when an ORES score is requested
Closed, ResolvedPublic

Description

The intended audience are engineers hoping to understand and help with the service architecture. We want to unpack the steps that our system will take to deliver a score, given various initial conditions.

Review existing documentation of the scoring step, see https://etherpad.wikimedia.org/p/revscoring from 12/19 "ORES overview" and the sequence diagrams in https://wikitech.wikimedia.org/wiki/Nova_Resource:Ores.

Build a few more ways of looking at the scoring scenario. Process diagram to show decision points. Data flow diagram to show interacting subsystems. Illustrate how the models themselves work, how features are measured and how they are reduced into classifications, although this might be wasted effort since we occasionally change the model type.