yujunjun/unstructured
1
0
Fork 0
mirror of https://github.com/Unstructured-IO/unstructured.git synced 2025-11-04 12:03:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
unstructured/docs/source/index.rst

55 lines
1.6 KiB
ReStructuredText
Raw Normal View History

docs: add slack and github links back into docs page (#535) * stars and github link to top of page * wording updates * remove unnecessary font weight change * remove next arrows * buttons to bottom on sidebar
2023-05-01 18:17:52 -04:00
Unstructured Core Library
=========================
Initial Release
2022-06-29 14:35:19 -04:00
Docs updates (#2458) To test: > cd docs && make html Change logs: * Updates the best practice for table extraction to use `skip_infer_table_types` instead of `pdf_infer_table_structure`. * Fixed CSS issue with a duplicate search box. * Fixed RST warning message * Fixed typo on the Intro page.
2024-01-25 12:31:28 -08:00
The ``unstructured`` library is designed to help preprocess and structure unstructured text documents for use in downstream machine learning tasks. Examples of documents that can be processed
Initial Release
2022-06-29 14:35:19 -04:00
using the ``unstructured`` library include PDFs, XML and HTML documents.
Library Documentation
---------------------
:doc:`installing`
docs: more detailed bricks writeup; reoganize docs (#304) * add print statement in readme * elements before bricks * new preamble to bricks section * add preamble to bricks section * add preamble to cleaning section * descriptions of each documentation page * non-brick helper functions to the bottom * fix codeblock * includes some optional kwargs * code blocks * typo fix
2023-02-27 18:11:49 -05:00
Instructions on how to install the ``unstructured`` library on your system.
docs: Add Unstructured API documentation (#928) * fran-unstructured/Add unstructured API documentation * fran-unstructured/add api docs to index.rst * fran-unstructured/add api docs with changes requested
2023-07-14 14:28:57 -04:00
:doc:`api`
Access all the power of ``unstructured`` through the ``unstructured-api`` or learn to host it locally.
Create Enterprise Platform Documentation (#2486) To test: > cd docs && make html Structures: * Getting Started with Platform (User Account Management) * Set Up workflow automation * Job Scheduling * Platform Source Connectors: * Azure Blob Storage, * Amazon S3 * Salesforce * Sharepoint * Google Cloud Storage * Google Drive * One Drive * Elasticsearch * SFTP Storage * Platform Destination Connectors: (i) * Amazon S3 * Azure Cognitive Search * Google Cloud Storage * Pinecone * Elasticsearch * Weaviate * MongoDB * AWS OpenSearch * Databricks --------- Co-authored-by: Matt Robinson <mrobinson@unstructured.io> Co-authored-by: Matt Robinson <mrobinson@unstructuredai.io>
2024-03-06 11:16:08 -08:00
:doc:`platform`
Explore the enterprise-grade platform for enterprises and high-growth companies with large data volume looking to automatically retrieve, transform, and stage their data for LLMs.
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 10:43:26 -04:00
:doc:`core`
Learn more about the core partitioning, chunking, cleaning, and staging functionality within the
Unstructured library.
feat: add ability to extract extra metadata with regex (#763) * first pass on regex metadata * fix typing for regex metadata * add dataclass back in * add decorators * fix tests * update docs * add tests for regex metadata * add process metadata to tsv * changelog and version * docs typos * consolidate to using a single kwarg * fix test
2023-06-16 10:10:56 -04:00
update sphinx docs with ingest content (#1969) ### Description Create a new structure for ingest content in the docs, update with all configs
2023-11-02 16:40:35 -04:00
:doc:`ingest/index`
fix: typos (#1215) fix: typos
2023-08-28 14:05:48 +02:00
Connect to your favorite data storage platforms for an effortless batch processing of your files.
docs: adds connectors' documentation (#917) * Add connectors documentation * Add connectors documentation with corrections and index.rst update * Add connectors documentation - add API information --------- Co-authored-by: Francisco Ansaldo <franciscoansaldo@Franciscos-MacBook-Pro.local> Co-authored-by: ryannikolaidis <1208590+ryannikolaidis@users.noreply.github.com>
2023-07-12 14:56:09 -04:00
feat: add ability to extract extra metadata with regex (#763) * first pass on regex metadata * fix typing for regex metadata * add dataclass back in * add decorators * fix tests * update docs * add tests for regex metadata * add process metadata to tsv * changelog and version * docs typos * consolidate to using a single kwarg * fix test
2023-06-16 10:10:56 -04:00
:doc:`metadata`
Learn more about how metadata is tracked in the ``unstructured`` library.
Initial Release
2022-06-29 14:35:19 -04:00
:doc:`examples`
docs: more detailed bricks writeup; reoganize docs (#304) * add print statement in readme * elements before bricks * new preamble to bricks section * add preamble to bricks section * add preamble to cleaning section * descriptions of each documentation page * non-brick helper functions to the bottom * fix codeblock * includes some optional kwargs * code blocks * typo fix
2023-02-27 18:11:49 -05:00
Examples of other types of workflows within the ``unstructured`` package.
Initial Release
2022-06-29 14:35:19 -04:00
Docs: add Integrations section (#372) * docs: update index, add integrations * docs: fix typos * docs: create integrations.rst section structure * docs: descriptions and use for 8 integrations * refactor: SEC example in Label Studio section * Apply suggestions from code review Co-authored-by: qued <64741807+qued@users.noreply.github.com> * docs: change links order and refactor|paraphrase --------- Co-authored-by: qued <64741807+qued@users.noreply.github.com>
2023-03-17 20:11:38 +01:00
:doc:`integrations`
We make it easy for you to connect your output with other popular ML services.
Initial Release
2022-06-29 14:35:19 -04:00
Add `strategy` documentation (#1353)
2023-09-09 18:54:01 -07:00
:doc:`best_practices`
Learn best practices to optimize document information extraction using ``unstructured`` library.
Initial Release
2022-06-29 14:35:19 -04:00
.. Hidden TOCs
.. toctree::
docs: add slack and github links back into docs page (#535) * stars and github link to top of page * wording updates * remove unnecessary font weight change * remove next arrows * buttons to bottom on sidebar
2023-05-01 18:17:52 -04:00
:caption: Documentation
Initial Release
2022-06-29 14:35:19 -04:00
:maxdepth: 2
:hidden:
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
introduction
Initial Release
2022-06-29 14:35:19 -04:00
installing
docs: Add Unstructured API documentation (#928) * fran-unstructured/Add unstructured API documentation * fran-unstructured/add api docs to index.rst * fran-unstructured/add api docs with changes requested
2023-07-14 14:28:57 -04:00
api
Create Enterprise Platform Documentation (#2486) To test: > cd docs && make html Structures: * Getting Started with Platform (User Account Management) * Set Up workflow automation * Job Scheduling * Platform Source Connectors: * Azure Blob Storage, * Amazon S3 * Salesforce * Sharepoint * Google Cloud Storage * Google Drive * One Drive * Elasticsearch * SFTP Storage * Platform Destination Connectors: (i) * Amazon S3 * Azure Cognitive Search * Google Cloud Storage * Pinecone * Elasticsearch * Weaviate * MongoDB * AWS OpenSearch * Databricks --------- Co-authored-by: Matt Robinson <mrobinson@unstructured.io> Co-authored-by: Matt Robinson <mrobinson@unstructuredai.io>
2024-03-06 11:16:08 -08:00
platform
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 10:43:26 -04:00
core
update sphinx docs with ingest content (#1969) ### Description Create a new structure for ingest content in the docs, update with all configs
2023-11-02 16:40:35 -04:00
ingest/index
feat: add ability to extract extra metadata with regex (#763) * first pass on regex metadata * fix typing for regex metadata * add dataclass back in * add decorators * fix tests * update docs * add tests for regex metadata * add process metadata to tsv * changelog and version * docs typos * consolidate to using a single kwarg * fix test
2023-06-16 10:10:56 -04:00
metadata
Initial Release
2022-06-29 14:35:19 -04:00
examples
Docs: add Integrations section (#372) * docs: update index, add integrations * docs: fix typos * docs: create integrations.rst section structure * docs: descriptions and use for 8 integrations * refactor: SEC example in Label Studio section * Apply suggestions from code review Co-authored-by: qued <64741807+qued@users.noreply.github.com> * docs: change links order and refactor|paraphrase --------- Co-authored-by: qued <64741807+qued@users.noreply.github.com>
2023-03-17 20:11:38 +01:00
integrations
roman/delta lake dest connector (#1385) ### Description Add delta table downstream destination connector Closes https://github.com/Unstructured-IO/unstructured/issues/1415
2023-09-15 18:13:39 -04:00
best_practices
Reference in New Issue Copy Permalink