From 80755a7d5955f7d0c53df8e558fdd852dd1f5b75 Mon Sep 17 00:00:00 2001 From: Michele Dolfi <97102151+dolfim-ibm@users.noreply.github.com> Date: Wed, 25 Jun 2025 00:56:14 -0500 Subject: [PATCH] docs: Update example resources and improve README (#231) Signed-off-by: Michele Dolfi --- README.md | 27 ++++++++----------- docs/configuration.md | 2 +- .../docling-model-cache-deployment.yaml | 4 +-- docs/deploy-examples/docling-serve-oauth.yaml | 2 +- ...ling-serve-replicas-w-sticky-sessions.yaml | 4 +-- .../deploy-examples/docling-serve-simple.yaml | 4 +-- pyproject.toml | 6 ++++- 7 files changed, 24 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index c78bc1e..1517f23 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,31 @@ Running [Docling](https://github.com/docling-project/docling) as an API service. +📚 [Docling Serve documentation](./docs/README.md) + +- Learning how to [configure the webserver](./docs/configuration.md) +- Get to know all [runtime options](./docs/usage.md) of the API +- Explore usefule [deployment examples](./docs/deployment.md) +- And more + ## Getting started Install the `docling-serve` package and run the server. ```bash # Using the python package -pip install "docling-serve" -docling-serve run +pip install "docling-serve[ui]" +docling-serve run --enable-ui # Using container images, e.g. with Podman -podman run -p 5001:5001 quay.io/docling-project/docling-serve +podman run -p 5001:5001 -e DOCLING_SERVE_ENABLE_UI=1 quay.io/docling-project/docling-serve ``` The server is available at - API - API documentation +- UI playground ![swagger.png](img/swagger.png) Try it out with a simple conversion: @@ -55,25 +63,12 @@ Coming soon: `docling-serve-slim` images will reduce the size by skipping the mo ### Demonstration UI -```bash -# Install the Python package with the extra dependencies -pip install "docling-serve[ui]" -docling-serve run --enable-ui - -# Run the container image with the extra env parameters -podman run -p 5001:5001 -e DOCLING_SERVE_ENABLE_UI=true quay.io/docling-project/docling-serve -``` - An easy to use UI is available at the `/ui` endpoint. ![ui-input.png](img/ui-input.png) ![ui-output.png](img/ui-output.png) -## Documentation and advance usages - -Visit the [Docling Serve documentation](./docs/README.md) for learning how to [configure the webserver](./docs/configuration.md), use all the [runtime options](./docs/usage.md) of the API and [deployment examples](./docs/deployment.md), pre-load model weights into a persistent volume [model weights on persistent volume](./docs/pre-loading-models.md) - ## Get help and support Please feel free to connect with us using the [discussion section](https://github.com/docling-project/docling/discussions). diff --git a/docs/configuration.md b/docs/configuration.md index c84c456..487c8c1 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -60,7 +60,7 @@ The selected compute engine will be running all the async jobs. #### Local engine -The following table describes the options to configure the Docling Serve KFP engine. +The following table describes the options to configure the Docling Serve local engine. | ENV | Default | Description | |-----|---------|-------------| diff --git a/docs/deploy-examples/docling-model-cache-deployment.yaml b/docs/deploy-examples/docling-model-cache-deployment.yaml index 6cd3da1..a5e686e 100644 --- a/docs/deploy-examples/docling-model-cache-deployment.yaml +++ b/docs/deploy-examples/docling-model-cache-deployment.yaml @@ -22,8 +22,8 @@ spec: - name: api resources: limits: - cpu: 500m - memory: 2Gi + cpu: 2 + memory: 4Gi requests: cpu: 250m memory: 1Gi diff --git a/docs/deploy-examples/docling-serve-oauth.yaml b/docs/deploy-examples/docling-serve-oauth.yaml index f89b771..a8060aa 100644 --- a/docs/deploy-examples/docling-serve-oauth.yaml +++ b/docs/deploy-examples/docling-serve-oauth.yaml @@ -85,7 +85,7 @@ spec: resources: limits: cpu: 2000m - memory: 2Gi + memory: 4Gi requests: cpu: 800m memory: 1Gi diff --git a/docs/deploy-examples/docling-serve-replicas-w-sticky-sessions.yaml b/docs/deploy-examples/docling-serve-replicas-w-sticky-sessions.yaml index b69b347..5d7f3e4 100644 --- a/docs/deploy-examples/docling-serve-replicas-w-sticky-sessions.yaml +++ b/docs/deploy-examples/docling-serve-replicas-w-sticky-sessions.yaml @@ -60,8 +60,8 @@ spec: - name: api resources: limits: - cpu: 500m - memory: 2Gi + cpu: 1 + memory: 4Gi requests: cpu: 250m memory: 1Gi diff --git a/docs/deploy-examples/docling-serve-simple.yaml b/docs/deploy-examples/docling-serve-simple.yaml index 47390f4..b5c0f04 100644 --- a/docs/deploy-examples/docling-serve-simple.yaml +++ b/docs/deploy-examples/docling-serve-simple.yaml @@ -40,8 +40,8 @@ spec: - name: api resources: limits: - cpu: 500m - memory: 2Gi + cpu: 1 + memory: 4Gi nvidia.com/gpu: 1 # Limit to one GPU requests: cpu: 250m diff --git a/pyproject.toml b/pyproject.toml index d02079b..09d5e0c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,7 +26,11 @@ classifiers = [ # "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "Typing :: Typed", - "Programming Language :: Python :: 3" + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", ] requires-python = ">=3.10" dependencies = [