Welcome to deploying your PyTorch model on Algorithmia!
This guide is designed as an introduction to deploying a PyTorch model and publishing an algorithm even if you’ve never used Algorithmia before.
Table of Contents
- Create your Algorithm
- Set your Dependencies
- Load your Model
- Publish your Algorithm
Before you get started deploying your Pytorch model on Algorithmia there are a few things you’ll want to do first:
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.
Saving and loading models in Pytorch can get tedious, because it requires keeping a copy of your source class code for any models you want to load again. The team at Algorithmia created a module for Python that sidesteps this process, along with a few other optimizations. For more information, check out the GitHub repo here.
1. Install and Import the Pytorch-Ergonomics Package
ergo-pytorch package using Pypi with
pip install ergo-pytorch==1.1.1. Import the base module with
import ergonomics, or a specific module with
from ergonomics import model_ergonomics.
2. Save Your Model Using Our Ergonomics Package
Instead of using Pytorch’s built in
model.save() functionality, use
ergonomics.model_ergonomics.save_portable(source_path). This will save your model along with the class code, so you don’t need to copy and paste that later on.
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 database.
First, you’ll want to create a data collection to host your pre-trained model.
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.
Host Your Model File
Next, upload your pickled model to your newly created data collection.
Load model by clicking box “Drop files here to upload”
Note the path to your files: data://username/collections_name/file_name.zip
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:
Set your Dependencies
Now is the time to set your dependencies that your model relies on.
- Click on the “Dependencies” button at the top right of the UI and list your packages under the required ones already listed and click “Save Dependencies” on the bottom right corner.
For easy copy and paste:
If you’re using the CPU implementation of Pytorch, you can add
torch directly to the dependencies. If you’re using a GPU version, you’ll need to use our customized
.whl file. You can find it here, and read about it in more detail on the ergo-pytorch repo.
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.
CPUs vs. GPUs on Pytorch
Pytorch offers a few different distributions for download that are split by CPU and GPU. The Pytorch files for CPU usage are normal sized, but when using the GPU packages the files can get very large.
For GPU based implementations we’ve created a workaround that loads the files much faster than the default. When using the workaround, the main file stays the same (see example hosted model below) but you’ll need to create an extra file that executes the workaround. See the second example
implement.py for how to do this.
Example Hosted Model (Main):
If you’re using GPUs, you’ll also need to create a second file to implement the workaround:
Example Workaround File:
Now when you run this code, the expected input is:
With the expected output:
If you run into any problems or need help, don’t hesitate to reach out to our team!
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.
If you would like to check this demo out on the platform you can find it here: Pytorch CNN Demo.
That’s it for hosting your Pytorch model on Algorithmia!