jaemil / runpod

Run locally

python3 -u rp_handler.py --rp_serve_api

roop inswapper | RunPod Serverless Worker

This is the source code for a RunPod Serverless worker that uses roop (inswapper) for face swapping AI tasks.

Model

The worker uses the inswapper_128.onnx model by InsightFace.

Testing

1. Local Testing
2. RunPod Testing

Building the Docker image that will be used by the Serverless Worker

There are two options:

1. Network Volume
2. Standalone (without Network Volume)

RunPod API Endpoint

You can send requests to your RunPod API Endpoint using the /run or /runsync endpoints.

Requests sent to the /run endpoint will be handled asynchronously, and are non-blocking operations. Your first response status will always be IN_QUEUE. You need to send subsequent requests to the /status endpoint to get further status updates, and eventually the COMPLETED status will be returned if your request is successful.

Requests sent to the /runsync endpoint will be handled synchronously and are blocking operations. If they are processed by a worker within 90 seconds, the result will be returned in the response, but if the processing time exceeds 90 seconds, you will need to handle the response and request status updates from the /status endpoint until you receive the COMPLETED status which indicates that your request was successful.

RunPod API Examples

• Swap as many source faces as possible into as many target faces as possible
• Swap a single source face into a specific target face in a target image containing multiple faces
• Swap two faces from source image into 2 specific target faces in a target image containing multiple faces
• Swap two specific faces from source image containing multiple faces into 2 specific target faces in a target image containing multiple faces

Endpoint Status Codes

Status	Description
IN_QUEUE	Request is in the queue waiting to be picked up by a worker. You can call the /status endpoint to check for status updates.
IN_PROGRESS	Request is currently being processed by a worker. You can call the /status endpoint to check for status updates.
FAILED	The request failed, most likely due to encountering an error.
CANCELLED	The request was cancelled. This usually happens when you call the /cancel endpoint to cancel the request.
TIMED_OUT	The request timed out. This usually happens when your handler throws some kind of exception that does return a valid response.
COMPLETED	The request completed successfully and the output is available in the output field of the response.

Serverless Handler

The serverless handler (rp_handler.py) is a Python script that handles the API requests to your Endpoint using the runpod Python library. It defines a function handler(event) that takes an API request (event), runs the inference using the inswapper model (and CodeFormer where applicable) with the input, and returns the output in the JSON response.

Acknowledgements

• Inswapper
• Roop
• Insightface
• CodeFormer
• Real-ESRGAN (ai-forever)
• Generative Labs YouTube Tutorials

Additional Resources

• Generative Labs YouTube Tutorials
• Getting Started With RunPod Serverless
• Serverless | Create a Custom Basic API

Community and Contributing

Pull requests and issues on GitHub are welcome. Bug fixes and new features are encouraged.

You can contact me and get help with deploying your Serverless worker to RunPod on the RunPod Discord Server below, my username is ashleyk.

Appreciate my work?