Spaces:
Configuration error
Configuration error
Brent Salisbury
commited on
Commit
·
b189003
1
Parent(s):
45f20c2
Readme additions for running
Browse filesReadme additions for a quickstart running of docling-serve
Signed-off-by: Brent Salisbury <[email protected]>
README.md
CHANGED
@@ -276,6 +276,17 @@ The response can be a JSON Document or a File.
|
|
276 |
- If you set the parameter `return_as_file` to True, the response will be a zip file.
|
277 |
- If multiple files are generated (multiple inputs, or one input but multiple outputs with `return_as_file` True), the response will be a zip file.
|
278 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
279 |
## Helpers
|
280 |
|
281 |
- A full Swagger UI is available at the `/docs` endpoint.
|
@@ -323,7 +334,7 @@ uv sync --extra ui --extra rapidocr
|
|
323 |
uv sync --extra tesserocr
|
324 |
```
|
325 |
|
326 |
-
See `[project.optional-dependencies]` section in `pyproject.toml` for full list of options
|
327 |
|
328 |
### Run the server
|
329 |
|
|
|
276 |
- If you set the parameter `return_as_file` to True, the response will be a zip file.
|
277 |
- If multiple files are generated (multiple inputs, or one input but multiple outputs with `return_as_file` True), the response will be a zip file.
|
278 |
|
279 |
+
## Run docling-serve
|
280 |
+
|
281 |
+
Clone the repository and run the following from within the cloned directory root.
|
282 |
+
|
283 |
+
```bash
|
284 |
+
python -m venv venv
|
285 |
+
source venv/bin/activate
|
286 |
+
pip install "docling-serve[ui]"
|
287 |
+
docling-serve run --enable-ui
|
288 |
+
```
|
289 |
+
|
290 |
## Helpers
|
291 |
|
292 |
- A full Swagger UI is available at the `/docs` endpoint.
|
|
|
334 |
uv sync --extra tesserocr
|
335 |
```
|
336 |
|
337 |
+
See `[project.optional-dependencies]` section in `pyproject.toml` for full list of options and runtime options with `uv run docling-serve --help`.
|
338 |
|
339 |
### Run the server
|
340 |
|