docker-surya

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #go #machine-learning #deep-learning #docker #java #awesome #cli #kubernetes #vue #awesome-list

(★ 10)

Docker implementation of the Surya OCR

docker-surya Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Docker Surya

A Docker image built through Github Actions with Git commit version tag

[![Docker Image Build/Publish tag with commit](https://github.com/xiaoyao9184/docker-surya/actions/workflows/docker-image-tag-commit.yml/badge.svg)](https://github.com/xiaoyao9184/docker-surya/actions/workflows/docker-image-tag-commit.yml) [![](https://img.shields.io/docker/v/xiaoyao9184/surya)](https://hub.docker.com/r/xiaoyao9184/surya)

[![Docker Image Build/Publish tag with version](https://github.com/xiaoyao9184/docker-surya/actions/workflows/docker-image-tag-version.yml/badge.svg)](https://github.com/xiaoyao9184/docker-surya/actions/workflows/docker-image-tag-version.yml) [![](https://img.shields.io/docker/v/xiaoyao9184/surya/0.22.1)](https://hub.docker.com/r/xiaoyao9184/surya)

[![HuggingFace Model Sync](https://github.com/xiaoyao9184/docker-surya/actions/workflows/hf-model-sync.yml/badge.svg)](https://github.com/xiaoyao9184/docker-surya/actions/workflows/hf-model-sync.yml) [![](https://img.shields.io/badge/HuggingFace-model-8b2cff?logo=huggingface)](https://huggingface.co/collections/xiaoyao9184/surya-and-surya-68635abc74f33ef5d5be792d)

[![HuggingFace Space Sync](https://github.com/xiaoyao9184/docker-surya/actions/workflows/hf-space-sync.yml/badge.svg)](https://github.com/xiaoyao9184/docker-surya/actions/workflows/hf-space-sync.yml) [![](https://img.shields.io/badge/HuggingFace-space-ff9f44?logo=huggingface)](https://huggingface.co/spaces/xiaoyao9184/surya)

![LabelStudio ML](https://img.shields.io/badge/LabelStudio-ML-ff7557?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABmJLR0QA%2FwD%2FAP%2BgvaeTAAABhElEQVRIie2UzStEURjGf%2Bd%2BIFkoNc0sWAgLZUOS9ZSVBQvGwspCliym%2FAdTsiQpG1lpVuIfYMPCSKMoFkr5HBFFGM5rccPljnOnu%2BWps3ju%2Bzzv73bqXiXpoTl%2BSmRXTS%2FPB577I%2BlUD6j%2B4OBtSk1njz%2BsAzIWCClWACMAaC%2FZtaxFwA8oqS5Jp1ZDAE0hcyMgDvSWsyAaIFEPnUlz82gPDnIRAW4V1MXMzdOa0OUewNExNHG0lacuBj2DYP12cz61dkBLG%2BQ24DAPihFsvUZl4fYbQGWyBZkYqMABlA1V1WW9GY7jHdv1vMi9ymQLP2NWedui6x%2FwFwAyPpxA2d5XpTU8PsDLU3jztehl34qeF6tWxocTMjrq%2BmMObvHs091cwvIsNDRDMvgn%2Fqb9Hcitf3klC7hFqL3rBra%2BAKX08gzX52bA4715bgRcnMDqUlkLogGUusJ2d4xN%2FdqI1i3RACKbKrPUZypKOjUJZMIBwkyJej6siMg2qGDXVheh3X%2F59Q535W%2Fus0NULAAAAABJRU5ErkJggg%3D%3D)

# 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).

The default image name format is `${DOCKERHUB_USERNAME}/surya`.

Currently, only the `linux/amd64` platform is supported.

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 upstream Surya commit.

When the submodule pointer or Docker build files are updated and pushed to this project, the [docker-image-tag-commit](./.github/workflows/docker-image-tag-commit.yml) job builds an image for the current project commit.
The commit-based image tag is the short commit id of this project repository,
generated from the GitHub Actions checkout with `git rev-parse --short HEAD`.
For example, a project commit `0123456789abcdef` will publish `${DOCKERHUB_USERNAME}/surya:0123456`.

**NOTE**:
> Starting from Surya `0.20.0`, commit-based image tags use the short commit id of this project repository.
> Before Surya `0.20.0`, commit-based image tags used the short commit id of the upstream Surya project repository.

If the job [docker-image-tag-version](./.github/workflows/docker-image-tag-version.yml) is triggered, the Surya package published on PyPI will be installed for the build.
The Docker image tag is read from the Git tag on the current `surya` submodule commit,
with the leading `v` prefix removed.
For example, a Surya Git tag `v0.22.1` will publish `${DOCKERHUB_USERNAME}/surya:0.22.1`.
If no Git tag is found on the current `surya` submodule commit, the build will fail.

# Model

The models of this project will be synced to HuggingFace under the collection [xiaoyao9184/surya-and-marker](https://huggingface.co/collections/xiaoyao9184/surya-and-marker-68635abc74f33ef5d5be792d).

The Docker image does not include model files.
When running, the required models will be automatically downloaded.

If you need to run offline, you must pre-download the model files and enable offline mode.
See [cache/README.md](./cache/README.md) for detailed instructions.

# Service

By default, the Docker container runs the Streamlit App, which comes from the original project.

However, this project also provides a Gradio App, a functional reimplementation of the Streamlit version.
The Gradio App supports both a UI and API interface, and can even serve as an MCP server,
so it is recommended as the preferred option.

The source code for the Gradio App is located in the [gradio](./gradio) directory of this project.
A demo of this project is also available and auto-synced on Hugging Face Spaces: [xiaoyao9184/surya](https://huggingface.co/spaces/xiaoyao9184/surya)

To run the Gradio App, you can do so by modifying the Docker command. see the `up.gradio` sub-directory in the [docker](./docker) directory for details.

And this project also provides Label Studio ML Backend.

The source code for the Label Studio ML Backend is located in the [label](./label) directory of this project.

To run the Label Studio ML Backend, you can do so by modifying the Docker command. see the `up.label` sub-directory in the [docker](./docker) directory for details.

# Change

You can fork this project and build your own image. You will need to provide the following variables: `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN`, `HF_USERNAME`, `HF_TOKEN`.
See [this](https://github.com/docker/login-action#docker-hub) for more details.

docker-surya

docker-surya Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

docker-surya

docker-surya Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README