Create a tutorial for deploying a model on toolforge
Open, Needs TriagePublic
Actions

Assigned To

Authored By

	• ACraze
	Apr 27 2021, 9:29 PM

Description

In preparation for putting ORES in maintenance mode while we complete the Lift-Wing MVP, we should create a tutorial that shows how to deploy a model on Toolforge .

This would provide an alternative for folks who do not want to wait or work through our team to deploy community models.

There was some work done in T265066, although we feel toolforge is better suited for community models at this time.

Here is a good tutorial for making a python app on toolforge:
https://wikitech.wikimedia.org/wiki/Help:Toolforge/My_first_Flask_OAuth_tool

Also a good example of a simple model server that could be used in the tutorial:
https://github.com/chrisalbon/sklearn-flask-docker

Deliverables:

A running model on toolforge
Instructions on Wikitech for deploying a similar model

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		None	T203131 Update and Improve Toolforge and Cloud VPS Technical Documentation
		Open		calbon	T281317 Create a tutorial for deploying a model on toolforge

Event Timeline

• ACraze created this task.Apr 27 2021, 9:29 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 27 2021, 9:29 PM

• ACraze added projects: Lift-Wing, artificial-intelligence.Apr 27 2021, 9:33 PM

• ACraze updated the task description. (Show Details)

• ACraze updated the task description. (Show Details)Apr 27 2021, 9:37 PM

• ACraze mentioned this in T265066: Proof of concept: dockerized model served over CloudVPS.

• ACraze updated the task description. (Show Details)Apr 27 2021, 10:02 PM

kevinbazira subscribed.May 10 2021, 8:17 AM

• ACraze mentioned this in T282429: Host Label Studio on Toolforge.May 10 2021, 5:55 PM

FYI -- Research has two templates for this that might be of use:

API on Cloud VPS: https://github.com/wikimedia/research-api-endpoint-template
- The Cloud VPS component may be less useful to community members (as onboarding/permissions take more time) but the underlying Flask app code was initially built with Toolforge in mind. I glanced at Chris' docker example and that looks great too. My only suggestions would be to allow CORS as that's a common headache w/ "why is my API not working?" and perhaps add some basic examples of validating/normalizing values passed via URL parameters (where common parameters would be pageid, pagetitle, qid, language, username, and I'm sure a few others)
- I also have had a really good experience with Flask and found it quite good for building simple apps. On Cloud VPS, we've also gotten a node backend and Go server backend) working too.
API Interface on Toolforge (this has a bunch of Research branding in it but that could always be removed): https://github.com/wikimedia/research-api-interface-template
- The interface obviously isn't required but I think having a good template promotes transparency (source code, documentation, who to contact, what logging is happening if any, etc.) and making it far easier for users to test out the API.