Welcome to deploying your spaCy model on Algorithmia!
This guide is designed as an introduction to deploying a spaCy model and publishing 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 after reading this guide.
Table of Contents
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 need to load a trained model from spaCy, check out this example in Spacy, which shows loading a trained model. Particulary check out the dependency file and the top few lines of code to see how to load it. You’ll load a trained spaCy model the same way.
If you are using a library that depends on SpaCy creating symlink between
en, please find an alternative as we don’t support creating that symlink manually.
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 Algorithm Development Guides.
Example Hosted Model:
Here is some code that has been adapted from the spaCy online books tutorial Learning to Classify Text
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.
Here is a working example, pay special attention to the dependencies file to download an example Spacy model:
That’s it for hosting your spaCy model on Algorithmia!