From a8a60d52b17fc25e71a421d4f89240bc7f02e154 Mon Sep 17 00:00:00 2001 From: Michele Dolfi <97102151+dolfim-ibm@users.noreply.github.com> Date: Fri, 30 Aug 2024 10:20:21 +0200 Subject: [PATCH] docs: add instructions for cpu-only installation (#56) Signed-off-by: Michele Dolfi --- Dockerfile | 5 ++++- README.md | 17 +++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 5b295ee..0c05fda 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,7 +6,10 @@ RUN apt-get update \ && apt-get install -y libgl1 libglib2.0-0 curl wget git \ && apt-get clean -RUN pip install --no-cache-dir docling +# This will install torch with *only* cpu support +# Remove the --extra-index-url part if you want to install all the gpu requirements +# For more details in the different torch distribution visit https://pytorch.org/. +RUN pip install --no-cache-dir docling --extra-index-url https://download.pytorch.org/whl/cpu ENV HF_HOME=/tmp/ ENV TORCH_HOME=/tmp/ diff --git a/README.md b/README.md index d1865e7..a882411 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,23 @@ pip install docling > [!NOTE] > Works on macOS and Linux environments. Windows platforms are currently not tested. + +### Use alternative PyTorch distributions + +The Docling models depend on the [PyTorch](https://pytorch.org/) library. +Depending on your architecture, you might want to use a different distribution of `torch`. +For example, you might want support for different accelerator or for a cpu-only version. +All the different ways for installing `torch` are listed on their website . + +One common situation is the installation on Linux systems with cpu-only support. +In this case, we suggest the installation of Docling with the following options + +```bash +# Example for installing on the Linux cpu-only version +pip install docling --extra-index-url https://download.pytorch.org/whl/cpu +``` + + ### Development setup To develop for Docling, you need Python 3.10 / 3.11 / 3.12 and Poetry. You can then install from your local clone's root dir: