Matt Robinson d9c035edb1
docs: no more bricks (#1967)
### Summary

We no longer use the "bricks" terminology for partioning functions, etc
in the library. This PR updates various references to bricks within the
repo and the docs. This is just an initial pass to swap the terminology
out, it'll likely be helpful to reorganize the docs a bit as well.

---------

Co-authored-by: qued <64741807+qued@users.noreply.github.com>
Co-authored-by: ryannikolaidis <1208590+ryannikolaidis@users.noreply.github.com>
2023-11-02 09:43:26 -05:00

56 lines
1.6 KiB
ReStructuredText

Unstructured Core Library
=========================
The ``unstructured`` library is designed to help preprocess structure unstructured text documents
for use in downstream machine learning tasks. Examples of documents that can be processed
using the ``unstructured`` library include PDFs, XML and HTML documents.
Library Documentation
---------------------
:doc:`installing`
Instructions on how to install the ``unstructured`` library on your system.
:doc:`api`
Access all the power of ``unstructured`` through the ``unstructured-api`` or learn to host it locally.
:doc:`core`
Learn more about the core partitioning, chunking, cleaning, and staging functionality within the
Unstructured library.
:doc:`source_connectors`
Connect to your favorite data storage platforms for an effortless batch processing of your files.
:doc:`destination_connectors`
Connect to your favorite data storage platforms to write you ingest results to.
:doc:`metadata`
Learn more about how metadata is tracked in the ``unstructured`` library.
:doc:`examples`
Examples of other types of workflows within the ``unstructured`` package.
:doc:`integrations`
We make it easy for you to connect your output with other popular ML services.
:doc:`best_practices`
Learn best practices to optimize document information extraction using ``unstructured`` library.
.. Hidden TOCs
.. toctree::
:caption: Documentation
:maxdepth: 2
:hidden:
introduction
installing
api
core
source_connectors
destination_connectors
metadata
examples
integrations
best_practices