Add Link

This page contains information about the infrastructure used for the link recommendation service and the data pipeline used to support the "Add a Link" structured task project.
== High-level summary ==
The Link Recommendation Service recommends phrases of text in an article to link to other articles on a wiki. Users can then accept or reject these recommendations.
# The service is an application hosted on kubernetes with an API accessible via HTTP (see ). It responds to a POST request containing wikitext of an article and responds with a structured response of link recommendations for the article. It does not have caching or storage; the client (MediaWiki) is responsible for doing that ().
# The search index stores metadata about which articles have link recommendations via a field we set per article (, )
# A MySQL table per wiki is used for caching the actual link recommendations (); each row contains serialized link recommendations for a particular article.
# A maintenance script () runs hourly per enabled wiki to generate link recommendations by iterating over each Search/articletopic and calling the Link Recommendation Service to request recommendations
#* the maintenance script caches the results in the MySQL table, then sends an event to Event_Platform/EventGate, where the Search pipeline ensures that the index is updated with the links/nolinks metadata for the article.
#* on page edit (when the edit is not done via the Add Link UX), link recommendations are regenerated via the job queue and the same code and APIs that are utilized in the maintenance script (n.b. we might do this differently; not yet implemented)
=== Diagram: Fetching and completing link recommendation tasks ===
Source: Add_Link/Diagram:_Fetching_and_completing_link_recommendation_tasks
== Link Recommendation Service ==
=== Repository ===
The repository for training the link recommendation model as well as for the query service is available:
=== Machine learning model ===
Some explanation of how the model works can be found on the meta-research-page.
=== Local development ===
Please see the README in the research/mwaddlink repository for options available, including docker-compose, Vagrant, and host system setups. 
=== API ===
* api.wikimedia.org documentation
* Swagger
=== Deployment ===
The service is deployed in production using the Deployment pipeline. The configuration specific to the service is in the deployment-charts repository:
=== Dataset pipeline ===
The link recommendation model is trained on the stat1008 server (due to its high CPU needs and access to production systems available via stat1008) with the run-pipeline.sh script. That script aggregates MediaWiki data from hive into several MySQL lookup tables per wiki. (For more details, see the Training the model section of the readme.) Those tables (stored in the staging database with an lr_ prefix) are then exported and published via datasets.wikimedia.org with the publish-datasets.sh command. The production query service (that MediaWiki interacts with) will poll for changes and import those datasets into its own MySQL instance in Kubernetes ().
The canonical location for training new models and publishing datasets is at /home/mgerlach/REPOS/mwaddlink-gerrit
=== Monitoring ===
* Grafana dashboard
* Logstash
== Resolved questions / decisions ==
* 10 December How to get a MySQL database from stat* server to a production MySQL instance (SRE/Analytics) ()
*23 October: Store the link recommendations in WANObjectCache or in a MySQL table? (needs SRE/DBA input) 
*15 October: use wikitext for training model, generating dictionary data, and as input to the mwaddlink query service. Will search for phrases in VE's editable content surface rather than attempt to apply offsets from wikitext / parsoid HTML. 
== Deployment ==
=== Prepare the deployment patch ===
Make a patch in operations/deployment-charts that updates the value of the main_app.version field in helmfile.d/services/linkrecommendation/values.yaml, to the new image tag was mentioned in PipelineBot's comment on the last merged research/mwaddlink patch (example).
==== Commit message guidelines ====
* Subject line can always be: "linkrecommendation: Bump version"
* Add a bullet point for patch in research/mwaddlink that is part of this release. The first line should specify what relevant code is affected (api, app, etc) followed by the subject line of the commit. On the second line, include a reference to the task from the patch and a link to the Gerrit Change-Id.
* Finally, the last line should include "Bug: " and reference the relevant phabricator task for this deployment.
All of the above guidelines in the commit message are helpful for paper trail and for documenting what was deployed, and when.
==== See also ====
See Deployments on kubernetes for tips, and note that 1) self merges are OK in this repository, and 2) a cron script on the deployment server will fetch the latest contents of the repository every minute.
=== Deploy the patch ===
Now, SSH to a Deployment server.
=== staging ===
=== eqiad ===
=== codfw ===
=== Checking output from a container ===
== Enabling on a new wiki ==
Enabling on a new-wiki once the models have been set up is a two-step process:
* Add task configuration for the link-recommendation task type. Typically this would be done by running a command like
:
PHAB=T123456
for WIKI in wiki1 wiki2 wiki3 ...; do
 ORIGIN=`mwscript getConfiguration.php $WIKI --settings 'wgCanonicalServer' --format json | jq --raw-output '.wgCanonicalServer'`
 mwscript extensions/GrowthExperiments/maintenance/changeWikiConfig.php $WIKI \
 --page MediaWiki:NewcomerTasks.json \
 --create-only \
 --json \
 --summary "Growth features configuration boilerplate ([[phab:$PHAB]])" \
 link-recommendation \
 '{ "type": "link-recommendation", "group": "easy" }'
 jq "select(.wiki==\"$WIKI\" and .probability > 0.25) | .section" wiki_sections.jsonl \
 | jq --slurp --compact-output "unique" \
 | mwscript extensions/GrowthExperiments/maintenance/changeWikiConfig.php $WIKI \
 --page MediaWiki:NewcomerTasks.json \
 --json \
 --summary "machine-generated configuration for excluding sections from link recommendations ([[phab:$PHAB]]), feel free to improve" \
 link-recommendation.excludedSections \
 "`cat`"
 echo "$ORIGIN/wiki/MediaWiki:NewcomerTasks.json"
 echo "$ORIGIN/w/index.php?title=MediaWiki:NewcomerTasks.json&diff=next"
 echo "Press <Enter> to continue"
 read # give time for manual verification
done
:on mwmaint1002. (The wiki_sections.jsonl file can be found at F35092312 on Phabricator; see T306792#7897336 for how it was produced.)
* Set $wgGENewcomerTasksLinkRecommendationsEnabled to true for the target wikis.
* Wait a few days so the systemd job running refreshLinkRecommendations.php can generate tasks.
* set $wgGELinkRecommendationsFrontendEnabled to true for the target wikis.
== Updates ==
=== 9 November - 10 December 2020 ===
* Growth / Research: Continued refactoring of research/mwaddlink for production ready status
* Growth: Backend patches for GrowthExperiments for consuming research/mwaddlink data
* Growth / SRE: Deployed linkrecommendation service to production (no datasets yet though)
* DBA: Created database and read/write users for production kubernetes instance to access
* Search: Working on consuming event(s) generated by service
=== 2 - 6 November 2020 ===
* Growth / Analytics Engineering: Discuss pipeline for MySQL on stats1008 -> production MySQL
=== 26 - 30 October 2020 ===
* Growth / Research: Recap architecture and discuss milestones
* Growth / SRE / DBA: Agreed to use MySQL for lookup tables for the link recommendation service
* Growth: Continued prototyping of the VisualEditor integration; continued work on deployment pipeline; initial work on HTTP API via Flask; addition of MySQL cache table in GrowthExperiments along with general infrastructure for reading/writing to the cache
=== 19 - 23 October 2020 ===
* Growth / Research: Working on deployment pipeline for mwaddlink
*Growth: Prototyping VisualEditor integration
*Growth: Beginning work on maintenance script and supporting classes
=== 12 - 16 October 2020 ===
* Growth / Research: Parsoid HTML vs wikitext, repo structure, MySQL vs SQLite, misc other things
* Growth: Engineers meet to discuss schedule, order of tasks, etc
=== 5 - 9 October 2020 ===
* Growth / Editing: Exploring ways to bring link recommendation data into VisualEditor
* Growth / Research: Discussing repository structures in preparation for deployment pipeline setup
* Growth / SRE / Research: Discussing how to get mwaddlink-query / mwaddlink into production
== Teams / Contact ==
Growth (primary stakeholder, technical contact for project is Sergio Gimeno, product owner is Kirsten Stoller). Other teams: Search Platform, SRE, Release Engineering, Research, Editing, Parsing
=== Roles / responsibilities ===
* Growth: User facing code, integration with our existing newcomer tasks framework, plus maintenance script to populate cache with recommendations
* Research: Implementing code to train models and provide a query client (research/mwaddlink repo)
* SRE: Working with Growth + Research to put the link recommendation service into production
* Search Platform: Implementing the event pipeline to update the search index metadata for a document when new link recommendations are generated
* Release Engineering: Consulting with Growth for deployment pipeline
* Editing: Consulting with Growth for VE integration
* Parsing: Consulting with Growth for VE integration
== Background reading ==
* Engineering notes (public for view only) (WMF link for edit access)
* Summary of project architecture
* Link Recommendation Project Architecture
* Technical Plan for Productization of "Add a Link"
== See also ==
* Add Image, a similar structured task project (but with fairly different architecure)