Update documentation to install pdfium

aws-samples · Jun 20, 2024 · 1c0d7f2 · 1c0d7f2
1 parent f21bf96
commit 1c0d7f2
Show file tree

Hide file tree

Showing 19 changed files with 36 additions and 35 deletions.
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -9,7 +9,8 @@ ____________________________________
 
 Textractor is available on PyPI and can be installed with :code:`pip install amazon-textract-textractor`. By default this will install the minimal version of textractor. The following extras can be used to add features:
 
-- :code:`pdf` (:code:`pip install amazon-textract-textractor[pdf]`) includes :code:`pdf2image` and enables PDF rasterization in Textractor. Note that this is **not** necessary to call Textract with a PDF file.
+- :code:`pdfium` (:code:`pip install amazon-textract-textractor[pdfium]`) includes :code:`pypdfium2` and is the recommended way to enable PDF rasterization in Textractor. Note that this is **not** necessary to call Textract with a PDF file.
+- :code:`pdf` (:code:`pip install amazon-textract-textractor[pdf]`) includes :code:`pdf2image` and is an additional way to enable PDF rasterization in Textractor. Note that this is **not** necessary to call Textract with a PDF file.
 - :code:`torch` (:code:`pip install amazon-textract-textractor[torch]`) includes :code:`sentence_transformers` for better word search and matching. This will work on CPU but be noticeably slower than non-machine learning based approaches.
 - :code:`dev` (:code:`pip install amazon-textract-textractor[dev]`) includes all the dependencies above and everything else needed to test the code.
 

diff --git a/docs/source/notebooks/document_linearization_to_markdown_or_html.ipynb b/docs/source/notebooks/document_linearization_to_markdown_or_html.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/going_further.ipynb b/docs/source/notebooks/going_further.ipynb
@@ -18,7 +18,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract\n",
     "\n",

diff --git a/docs/source/notebooks/interfacing_with_trp2.ipynb b/docs/source/notebooks/interfacing_with_trp2.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/introduction_to_searching.ipynb b/docs/source/notebooks/introduction_to_searching.ipynb
diff --git a/docs/source/notebooks/layout_analysis.ipynb b/docs/source/notebooks/layout_analysis.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/layout_analysis_for_text_linearization.ipynb b/docs/source/notebooks/layout_analysis_for_text_linearization.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/parsing_an_existing_response.ipynb b/docs/source/notebooks/parsing_an_existing_response.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "##  Not calling Textract\n",
     "\n",

diff --git a/docs/source/notebooks/signature_detection.ipynb b/docs/source/notebooks/signature_detection.ipynb
diff --git a/docs/source/notebooks/simple_ocr.ipynb b/docs/source/notebooks/simple_ocr.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)"
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)"
    ]
   },
   {

diff --git a/docs/source/notebooks/table_data_to_various_formats.ipynb b/docs/source/notebooks/table_data_to_various_formats.ipynb
diff --git a/docs/source/notebooks/tabular_data_linearization.ipynb b/docs/source/notebooks/tabular_data_linearization.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/tabular_data_linearization_continued.ipynb b/docs/source/notebooks/tabular_data_linearization_continued.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/textractor_for_large_language_models.ipynb b/docs/source/notebooks/textractor_for_large_language_models.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "`pip install amazon-textract-textractor`\n",
     "\n",
-    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdf]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
+    "There are various sets of dependencies available to tailor your installation to your use case. The base package will have sensible default, but you may want to install the PDF extra dependencies if your workflow uses PDFs with `pip install amazon-textract-textractor[pdfium]`. You can read more on extra dependencies [in the documentation](https://aws-samples.github.io/amazon-textract-textractor/installation.html)\n",
     "\n",
     "## Calling Textract"
    ]

diff --git a/docs/source/notebooks/using_analyze_expense.ipynb b/docs/source/notebooks/using_analyze_expense.ipynb
diff --git a/docs/source/notebooks/using_analyze_id.ipynb b/docs/source/notebooks/using_analyze_id.ipynb
diff --git a/docs/source/notebooks/using_queries.ipynb b/docs/source/notebooks/using_queries.ipynb
diff --git a/docs/source/notebooks/visualizing_results.ipynb b/docs/source/notebooks/visualizing_results.ipynb
diff --git a/docs/source/using_in_lambda.rst b/docs/source/using_in_lambda.rst
@@ -27,7 +27,7 @@ policy. We recommend that you review your lambda function and tailor the permiss
 
    .. image:: images/lambda_tutorial/1b.png
 
-   c. Scroll to the bottom of the page and download the package that matches your Python installation. Packages with the `-pdf` suffix contains `pdf2image` and allow you to process PDF documents. 
+   c. Scroll to the bottom of the page and download the package that matches your Python installation. Packages with the `-pdfium` suffix contain `pypdfium2` and allow you to process PDF documents. Packages with the `-pdf` suffix contain `pdf2image` and also allow you to process PDF documents, however we recommend using `pypdfium2` as it does not require any OS-level dependencies.
 
    .. image:: images/lambda_tutorial/1c.png
 
@@ -59,7 +59,7 @@ policy. We recommend that you review your lambda function and tailor the permiss
 
 4. Update your code to use Textractor
 
-   a. If using the PDF version you have to update the `PATH` and `LD_LIBRARY_PATH` environment variables through the lambda function configuration interface or directly in code with the `os` module: 
+   a. If using the `pdf2image` PDF version you have to update the `PATH` and `LD_LIBRARY_PATH` environment variables through the lambda function configuration interface or directly in code with the `os` module: 
 
    .. code-block:: python