yujunjun/unstructured
1
0
Fork 0
mirror of https://github.com/Unstructured-IO/unstructured.git synced 2025-07-05 08:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
unstructured/docs/source/index.rst

50 lines
1.4 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
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`
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.
:doc:`getting_started`
Check out this section to learn about basic workflows in ``unstructured``.
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.
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
:doc:`bricks`
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
Learn more about partitioning, cleaning, and staging bricks, including advanced usage patterns.
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
:doc:`connectors`
feat: `unique_element_ids` kwarg for UUID elements (#1085) * added kwarg for unique elements * test for unique ids * update docs * changelog and version
2023-08-11 07:02:37 -04: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
.. 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:
installing
docs: add getting started section and remove outdated docs (#277) * add getting started section to the docs * remove old examples * update example notebook * change to convert_to_dict * various and sundry edits
2023-02-27 10:10:53 -05:00
getting_started
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
Initial Release
2022-06-29 14:35:19 -04:00
bricks
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
connectors
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
Reference in New Issue Copy Permalink