https://github.com/runpod-workers/worker-esrgan

🎞️ | RunPod worker for the ESRGAN endpoint.
https://github.com/runpod-workers/worker-esrgan

docker esrgan

Last synced: 3 months ago
JSON representation

🎞️ | RunPod worker for the ESRGAN endpoint.

• Host: GitHub
• URL: https://github.com/runpod-workers/worker-esrgan
• Owner: runpod-workers
• License: mit
• Created: 2023-05-05T17:13:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T20:32:33.000Z (12 months ago)
• Last Synced: 2025-05-30T09:27:30.388Z (4 months ago)
• Topics: docker, esrgan
• Language: Python
• Homepage:
• Size: 12.7 KB
• Stars: 4
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


Real-ESRGAN | Worker


[![Docker Image](https://github.com/runpod-workers/worker-template/actions/workflows/CD-docker_dev.yml/badge.svg)](https://github.com/runpod-workers/worker-template/actions/workflows/CD-docker_dev.yml)

🚀 | A simple worker that can be used as a starting point to build your own custom RunPod Endpoint API worker.



## 📖 | Getting Started

1. Clone this repository.

2. (Optional) Add DockerHub credentials to GitHub Secrets.

3. Add your code to the `src` directory.

4. Update the `handler.py` file to load models and process requests.

5. Add any dependencies to the `requirements.txt` file.

6. Add any other build time scripts to the`builder` directory, for example, downloading models.

7. Update the `Dockerfile` to include any additional dependencies.

### CI/CD

This repository is setup to automatically build and push a docker image to the GitHub Container Registry. You will need to add the following to the GitHub Secrets for this repository to enable this functionality:

- `DOCKERHUB_USERNAME` | Your DockerHub username for logging in.

- `DOCKERHUB_TOKEN` | Your DockerHub token for logging in.

- `DOCKERHUB_REPO` | The name of the repository you want to push to.

- `DOCKERHUB_IMG` | The name of the image you want to push to.

The `CD-docker_dev.yml` file will build the image and push it to the `dev` tag, while the `CD-docker_release.yml` file will build the image on releases and tag it with the release version.

## Best Practices

Models should be part of your docker image, this can be accomplished by either copying them into the image or downloading them during the build process.

If using the input validation utility from the runpod python package, create a `schemas` python file where you can define the schemas, then import that file into your `handler.py` file.