Official Python library for RunPod API & SDK.
Project description
Official Python library for RunPod API & SDK.
Table of Contents
- Table of Contents
- Installation
- SDK - Serverless Worker
- API Language Library
- Directory
- Community and Contributing
Installation
pip install runpod
SDK - Serverless Worker
This python package can also be used to create a serverless worker that can be deployed to RunPod as a custom endpoint API.
Quick Start
Create an python script in your project that contains your model definition and the RunPod worker start code. Run this python code as your default container start command:
import runpod
MODEL = 'YOUR_MODEL'
def run(job):
# Your inference code here
return MODEL.predict(job.input)
runpod.serverless.start({"handler": run})
Make sure that this file is ran when your container starts. This can be accomplished by calling it in the docker command when you setup a template at runpod.io/console/serverless/user/templates or by setting it as the default command in your Dockerfile.
See our blog post for creating a basic Serverless API, or view the details docs for more information.
API Language Library
When interacting with the RunPod API you can use this library to make requests to the API.
import runpod
runpod.api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Directory
.
├── docs # Documentation
├── runpod # Package source code
└── tests # Package tests
Community and Contributing
We welcome both pull requests and issues on GitHub. Bug fixes and new features are encouraged.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.