The documentation of the usage of the link recommendation algorithm (https://github.com/wikimedia/research-mwaddlink/blob/main/README.md) is out of date and missing some important information (training the pipeline, querying, backtesting) .
The aim is to update the information for better maintenance of the code-base in the future:
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| Improve the README | research/mwaddlink | main | +160 -191 |
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | MMiller_WMF | T252822 [EPIC] Growth: "add a link" structured task 1.0 | |||
| Resolved | kostajh | T266437 Add a link engineering: backend product specifications | |||
| Resolved | kostajh | T261396 Add a link: engineering tasks for initial release | |||
| Open | None | T276438 Establish processes for running the dataset pipeline | |||
| Resolved | MGerlach | T290067 Improve the documentation in the README of the mwaddlink-repo |
Change 724024 had a related patch set uploaded (by MGerlach; author: MGerlach):
[research/mwaddlink@main] Improve the README.md for mwaddlink-repo.