https://github.com/xiaoyao9184/docker-surya
Docker implementation of the Surya OCR
https://github.com/xiaoyao9184/docker-surya
cuda-support docker-image ocr surya
Last synced: about 2 months ago
JSON representation
Docker implementation of the Surya OCR
- Host: GitHub
- URL: https://github.com/xiaoyao9184/docker-surya
- Owner: xiaoyao9184
- License: apache-2.0
- Created: 2024-11-25T12:09:55.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-01-05T06:32:07.000Z (5 months ago)
- Last Synced: 2025-02-17T21:11:48.656Z (3 months ago)
- Topics: cuda-support, docker-image, ocr, surya
- Language: Python
- Homepage:
- Size: 149 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Surya
A Docker image built through Github Actions with Git commit version tag
# Why
I found that Surya's Docker image is difficult to find.
The code on [GitHub](https://github.com/VikParuchuri/surya) does not provide a pre-built Docker image.
After reviewing the following items
- [linux.do](https://linux.do/t/topic/239082)
This project will use GitHub Actions and Docker Hub to build and publish images,
aiming to keep the process as clean as possible without custom configuration files.
# Tags
The images of this project will be published to Docker Hub under the repository [xiaoyao9184/surya](https://hub.docker.com/r/xiaoyao9184/surya).
Since this project references the Surya project via a submodule, it cannot monitor push events on the Surya project, and therefore cannot automatically create an image for every commit.
A good solution is to manually trigger the action and tag it with the commit id. For more details, see this article [set-dynamic-parameters-github-workflows-en](https://damienaicheh.github.io/github/actions/2022/01/20/set-dynamic-parameters-github-workflows-en.html).
The default image name format is `${DOCKERHUB_USERNAME}/surya`.
The tag uses the input parameter `commit_id`,
which can be either a branch name or a commit id,
when manually triggering the [docker-image-tag-commit](./.github/workflows/docker-image-tag-commit.yml) job.
if the job is triggered by a submodule update push,
the default branch name `master` will be used instead of the `commit_id` parameter.
This job will also use the shortened commit id as the tag.
If the job [docker-image-tag-version](./.github/workflows/docker-image-tag-version.yml) is triggered with the `surya_version` parameter set to the PyPI Surya version number,
the Surya package published on PyPI will be installed for the build,
and `surya_version` will be used as the tag.
Currently, only the `linux/amd64` platform is supported.
# Change
You can fork this project and build your own image. You will need to provide the following variables: `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN`.
See [this](https://github.com/docker/login-action#docker-hub) for more details.