Skip to content

Commit

Permalink
Update docs with more info on dependencies. (#769)
Browse files Browse the repository at this point in the history
  • Loading branch information
bsowell authored Sep 6, 2024
1 parent 33da32d commit 5c5c5cc
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions docs/source/sycamore/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,23 @@ We recommend installing the Sycmaore library using ``pip``:
..
Connectors for vector databases can be installed via extras. For example,

.. code-block:: python
pip install sycamore-ai[opensearch]
..
will install Sycamore with OpenSearch support. You can find a list of supported connectors :doc:`here </sycamore/connectors>`.

By default, Sycamore works with the Aryn Partitioning Service to process PDFs. To run inference locally, install the `local-inference` extra as follows:

.. code-block:: python
pip install sycamore-ai[local-inference]
..
Next, you can set the proper API keys for related services, like the Aryn Partitioning Service (APS) for processing PDFs (`sign-up here <https://www.aryn.ai/get-started>`_ for free) or OpenAI to use GPT with Sycamore's LLM-based transforms.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/sycamore/tutorials/etl_for_opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In this example, we will be using PDF documents from the [Sort Benchmark](http:/

## Steps

1. Install Sycamore using pip using [these instructions](../sycamore/get_started.rst)
1. Install Sycamore using pip using [these instructions](/sycamore/get_started)

2. Create a Python script and import Sycamore. In the following code snippet, we are initializing Sycamore and creating a DocSet by reading all the files from a local path.

Expand Down

0 comments on commit 5c5c5cc

Please sign in to comment.