docs: Update example resources and improve README (#231)

Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
This commit is contained in:
Michele Dolfi
2025-06-25 00:56:14 -05:00
committed by GitHub
parent 30aca92298
commit 80755a7d59
7 changed files with 24 additions and 25 deletions

View File

@@ -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 <http://127.0.0.1:5001>
- API documentation <http://127.0.0.1:5001/docs>
- UI playground <http://127.0.0.1:5001/ui>
![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).

View File

@@ -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 |
|-----|---------|-------------|

View File

@@ -22,8 +22,8 @@ spec:
- name: api
resources:
limits:
cpu: 500m
memory: 2Gi
cpu: 2
memory: 4Gi
requests:
cpu: 250m
memory: 1Gi

View File

@@ -85,7 +85,7 @@ spec:
resources:
limits:
cpu: 2000m
memory: 2Gi
memory: 4Gi
requests:
cpu: 800m
memory: 1Gi

View File

@@ -60,8 +60,8 @@ spec:
- name: api
resources:
limits:
cpu: 500m
memory: 2Gi
cpu: 1
memory: 4Gi
requests:
cpu: 250m
memory: 1Gi

View File

@@ -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

View File

@@ -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 = [