|
2 | 2 |
|
3 | 3 | A Docker image built through Github Actions with Git commit version tag |
4 | 4 |
|
| 5 | +[](https://github.com/xiaoyao9184/docker-marker/actions/workflows/docker-image-tag-commit.yml) [](https://hub.docker.com/r/xiaoyao9184/marker) |
| 6 | + |
| 7 | +[](https://github.com/xiaoyao9184/docker-marker/actions/workflows/docker-image-tag-version.yml) [](https://hub.docker.com/r/xiaoyao9184/marker) |
| 8 | + |
| 9 | +[](https://github.com/xiaoyao9184/docker-marker/actions/workflows/hf-model-sync.yml) [](https://huggingface.co/collections/xiaoyao9184/surya-and-marker-68635abc74f33ef5d5be792d) |
| 10 | + |
| 11 | +[](https://github.com/xiaoyao9184/docker-marker/actions/workflows/hf-space-sync.yml) [](https://huggingface.co/spaces/xiaoyao9184/marker)  |
| 12 | + |
5 | 13 | # Why |
6 | 14 |
|
7 | 15 | I found that Marker's Docker image is difficult to find. |
@@ -36,7 +44,30 @@ and `marker_version` will be used as the tag. |
36 | 44 |
|
37 | 45 | Currently, only the `linux/amd64` platform is supported. |
38 | 46 |
|
| 47 | +# Model |
| 48 | + |
| 49 | +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). |
| 50 | + |
| 51 | +The Docker image does not include model files. |
| 52 | +When running, the required models will be automatically downloaded. |
| 53 | + |
| 54 | +If you need to run offline, you must pre-download the model files and enable offline mode. |
| 55 | +See [cache/README.md](./cache/README.md) for detailed instructions. |
| 56 | + |
| 57 | +# Service |
| 58 | + |
| 59 | +By default, the Docker container runs the Streamlit App, which comes from the original project. |
| 60 | + |
| 61 | +However, this project also provides a Gradio App, a functional reimplementation of the Streamlit version. |
| 62 | +The Gradio App supports both a UI and API interface, and can even serve as an MCP server, |
| 63 | +so it is recommended as the preferred option. |
| 64 | + |
| 65 | +The source code for the Gradio App is located in the [gradio](./gradio) directory of this project. |
| 66 | +A demo of this project is also available and auto-synced on Hugging Face Spaces: [xiaoyao9184/marker](https://huggingface.co/spaces/xiaoyao9184/marker) |
| 67 | + |
| 68 | +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. |
| 69 | + |
39 | 70 | # Change |
40 | 71 |
|
41 | | -You can fork this project and build your own image. You will need to provide the following variables: `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN`. |
| 72 | +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`. |
42 | 73 | See [this](https://github.com/docker/login-action#docker-hub) for more details. |
0 commit comments