Welcome to Algorithmia! This guide is designed as an introduction to deploying your OpenCV model and publishing it as an algorithm, even if you’ve never used Algorithmia before!
Note: this guide uses the web UI to create and deploy your Algorithm. If you prefer a code-only approach to deployment, review Algorithm Management API after reading this guide.
Table of Contents
- Create your Algorithm
- Set your Dependencies
- Load your Model
- Publish your Algorithm
Before you get started hosting your model on Algorithmia there are a few things you’ll want to do first:
Create a Data Collection
Host your data where you want and serve it to your model with Algorithmia’s Data API.
In this guide we’ll use Algorithmia’s Hosted Data Collection, but you can host it in S3 or Dropbox as well. Alternatively, if your data lies in a database, check out how we connected to a DynamoDB databasee.
First, you’ll want to create a data collection to host your graph and variables.
Log into your Algorithmia account and create a data collection via the Data Collections page.
Click on “Add Collection” under the “My Collections” section.
After you create your collection you can set the read and write access on your data collection.
For more information check out: Data Collection Types.
Note, that you can also use the Data API to create data collections and upload files.
Save your Pre-Trained Model
You’ll want to do the training and saving of your model on your local machine, or the platform you’re using for training, before you deploy it to production on the Algorithmia platform.
After training your OpenCV model, can save it as a
.dat binary file. In this example we use the
Because we’ll be saving the model to a data collection, let’s create that directory right now.
Before we create our algorithm, let’s first train our model on our local machine on the handwriting digits dataset and save it to the DataAPI.
This requires version
The last line will save your model to the data collection you’ve created.
Create your Algorithm
Hopefully you’ve already followed along with the Getting Started Guide for algorithm development. If not, you might want to check it out in order to understand the various permission types, how to enable a GPU environment, and use the CLI.
Once you’ve gone through the Getting Started Guide, you’ll notice that when you’ve created your algorithm, there is boilerplate code in the editor that returns “Hello” and whatever you input to the console.
The main thing to note about the algorithm is that it’s wrapped in the
The apply() function defines the input point of the algorithm. We use the apply() function in order to make different algorithms standardized. This makes them easily chained and helps authors think about designing their algorithms in a way that makes them easy to leverage and predictable for end users.
Go ahead and remove the boilerplate code below that’s inside the
apply() function on line 6, but leave the
apply() function intact:
Note: Make sure that your version of python is the same between your development environment and the algorithm. There may be version conflicts otherwise.
Set your Dependencies
Now is the time to set the dependencies your model relies on.
- Click on the “Dependencies” button at the top right of the UI and add
opencv-python==220.127.116.11under the required ones already listed and click “Save Dependencies” on the bottom right corner.
Load your model
Here is where you load and run your model which will be called by the apply() function.
When you load your model, our recommendation is to preload your model in a separate function external to the apply() function.
This is because when a model is first loaded it can take time to load depending on the file size.
Then, with all subsequent calls only the apply() function gets called which will be much faster since your model is already loaded.
If you are authoring an algorithm, avoid using the ‘.my’ pseudonym in the source code. When the algorithm is executed, ‘.my’ will be interpreted as the user name of the user who called the algorithm, rather than the author’s user name.
Note that you always want to create valid JSON input and output in your algorithm. For examples see the Client Guides.
Now, we’ll deploy our newly trained model. For testing the model we have, we’ll crop a single zero digit from the dataset for testing.
Preloading your OpenCV model is a great step for improving your overall performance. By downloading your OpenCV model file when the container first starts, it means that any subsequent requests to the algorithm won’t have the same loading overhead!
Here’s an example of what that looks like:
Image pre-processing functions
Before we can pass the image to the model, we need to pre-process the user provided image.
The first function deskews the image, and the second function finds the HOG descriptor of the image.
Now when you run this code, the expected input is:
With the expected output:
Publish your Algorithm
Last is publishing your algorithm. The best part of deploying your model on Algorithmia is that users can access it via an API that takes only a few lines of code to use! Here is what you can set when publishing your algorithm:
On the upper right hand side of the algorithm page you’ll see a purple button “Publish” which will bring up a modal:
In this modal, you’ll see a Changes tab, a Sample I/O tab, and one called Versioning.
If you don’t recall from the Getting Started Guide how to go through the process of publishing your model, check that out before you finish publishing.
This guide is based on the OpenCV tutorial here.
If you run into any trouble, please contact us at email@example.com.