unstructured/docs/source/best_practices.rst

Best Practices
==============

Unstructured offers a few strategies and models to extract document information. These best practices are intended to provide guidelines to configure the ``strategy`` and ``model`` configurations to optimize document information extraction.

High-level overview of available strategies and models in ``Unstructured`` library:

.. image:: imgs/strategy.png
  :width: 1000
  :alt: strategy

.. toctree::
   :maxdepth: 1

   best_practices/strategies
   best_practices/models
   best_practices/table_extraction_pdf
Add `strategy` documentation (#1353) 2023-09-09 18:54:01 -07:00			`Best Practices`
			`==============`

			Unstructured offers a few strategies and models to extract document information. These best practices are intended to provide guidelines to configure the ``strategy`` and ``model`` configurations to optimize document information extraction.

			High-level overview of available strategies and models in ``Unstructured`` library:

			`.. image:: imgs/strategy.png`
			`:width: 1000`
Reorganized the Examples section in Documentation & add Databricks example (#1855) To test: > cd docs && make html Change logs: * Examples are reorganized to have its own page * Removed two old examples, ie. "file-utils" & "sentiment analysis". * Added two examples: "RAG with Unstructured, LangChain, and ChromaDB" & "Multi-Files Processing with S3 Connector and API" * Reorganized and added detailed API documentation: (i) usage, (ii) SDKs, (iii) Azure Marketplace, (iv) AWS Marketplace, (v) parameters and validation errors 2023-11-29 17:24:43 -08:00			`:alt: strategy`
Add `strategy` documentation (#1353) 2023-09-09 18:54:01 -07:00
			`.. toctree::`
			`:maxdepth: 1`

			`best_practices/strategies`
Docs models (#1412) This PR adds documentation of models supported by the `Unstructured` tool. The changes reflect the tool's capabilities, usage examples, and the process for integrating custom models. Sections: - Detailed the basic usage of the `Unstructured` partition with the model name. - Provided a list of available models in the `Unstructured` partition. - Added instructions on using non-default models via three distinct methods. - Explained leveraging models from the LayoutParser's model zoo with `UnstructuredDetectronModel`. - Guided users in integrating their custom object detection models using the `UnstructuredObjectDetectionModel` class. Tested the docs build with: > cd docs > pip install -r requirements.txt > make html 2023-09-13 23:37:31 -07:00			`best_practices/models`
Docs various updates (#2386) To test: > cd docs && make html Changelogs: * Added verbiage about the cap limit and data usage for the Freemium AP * Added deprecated warning on Staging bricks * Added warning and code examples to use the SaaS API Endpoints using CLI-vs-SDKs * Fixed example page formatting * Added deprecation warning on ``model_name`` param in favor of ``hi_res_model_name`` * Added ``extract_images_in_pdf`` usage and code example in ``partition_pdf`` section * Reorganized and improved the documentation Intro section 2024-01-17 13:01:01 -08:00			`best_practices/table_extraction_pdf`