For an even faster start, clone or download the worker-basic repository for a pre-configured template for building and deploying Serverless workers. After cloning the repository, skip to step 6 of this tutorial to deploy and test the endpoint.
What you’ll learn
In this tutorial you’ll learn how to:- Set up your development environment.
- Create a handler file.
- Test your handler locally.
- Build a Docker image for deployment.
- Deploy and test your worker on the Runpod console.
Requirements
- You’ve created a Runpod account.
- You’ve installed Python 3.x and Docker on your local machine and configured them for your command line.
Step 1: Create a Python virtual environment
First, set up a virtual environment to manage your project dependencies.1
Create a virtual environment
Run this command in your local terminal:
2
Activate the virtual environment
3
Install the Runpod SDK
Step 2: Create a handler file
Create a file namedrp_handler.py
and add the following code:
prompt
string contained in the input
object. You can replace the time.sleep(seconds)
call with your own Python code for generating images, text, or running any machine learning workload.
Step 3: Create a test input file
You’ll need to create an input file to properly test your handler locally. Create a file namedtest_input.json
and add the following code:
Step 4: Test your handler locally
Run your handler to verify that it works correctly:Step 5: Create a Dockerfile
Create a file namedDockerfile
with the following content:
Step 6: Build and push your Docker image
Instead of building and pushing your image via Docker Hub, you can also deploy your worker from a GitHub repository.
1
Build your Docker image
Build your Docker image, specifying the platform for Runpod deployment, replacing
[YOUR_USERNAME]
with your Docker username:2
Push the image to your container registry
Step 7: Deploy your worker using the Runpod console
To deploy your worker to a Serverless endpoint:- Go to the Serverless section of the Runpod console.
- Click New Endpoint.
- Click Import from Docker Registry
- In the Container Image field, enter your Docker image URL:
docker.io/yourusername/serverless-test:latest
. - Click Next to proceed to endpoint configuration.
- Configure your endpoint settings:
- (Optional) Enter a custom name for your endpoint, or use the randomly generated name.
- Make sure the Endpoint Type is set to Queue.
- Under GPU Configuration, check the box for 16 GB GPUs.
- Leave the rest of the settings at their defaults.
- Click Deploy Endpoint.
Step 8: Test your worker
To test your worker, click the Requests tab in the endpoint detail page:
Next steps
Now that you’ve learned the basics, you’re ready to:- Create more advanced handler functions.
- Send endpoint requests using cURL and the Serverless SDK.
- Learn how to use endpoint operations like
/run
and/status
. - Manage your Serverless endpoints using the Runpod console.
- Configure your endpoints for optimal performance and cost.
- Learn more about local testing.