Jack Retterer a35ff890e0
Update docs jack (#1157)
Documentation Overhaul

- Added documentation hierarchy
- Added options for Bash vs Python for API & Upstream Connectors
- Added Introduction section (Overview, Key Concepts, Getting Started)
- Redid connectors section
- Installation is now broken up (needs further work)
2023-08-21 10:27:32 -07:00

48 lines
1.3 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 processes
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:`bricks`
Learn more about partitioning, cleaning, and staging bricks, including advanced usage patterns.
:doc:`upstream_connectors`
Connect to your favortite data storage platforms for an efortless batch processing of your files.
: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.
.. Hidden TOCs
.. toctree::
:caption: Documentation
:maxdepth: 2
:hidden:
introduction
installing
api
bricks
upstream_connectors
metadata
examples
strategies
integrations