Skip to content

docs: fix doc store code snippet in README.md #1389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anna-charlotte merged 4 commits into from
Apr 17, 2023
Merged

docs: fix doc store code snippet in README.md #1389

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6952fa7
docs: fix doc store code snippet
Apr 17, 2023
ec74857
Merge remote-tracking branch 'origin/main' into docs-readme-doc-store
Apr 17, 2023
f242281
fix: on disk example instead of jina ai cloud
Apr 17, 2023
1fd5d97
fix: apply alex suggestions
Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,28 +328,20 @@ But fret not! DocArray has you covered!

The Document Store interface lets you push and pull Documents to and from multiple data sources, all with the same user interface.

As an example, let's take a look at how that would work with AWS S3 storage:
For example, let's see how that works with on-disk storage:

```python
from docarray import DocList
from docarray.documents import ImageDoc
import numpy as np
from docarray import BaseDoc, DocList


class SimpleDoc(BaseDoc):
text: str

dl = DocList[ImageDoc](
[
ImageDoc(
url="https://upload.wikimedia.org/wikipedia/commons/2/2f/Alpamayo.jpg",
tensor=np.zeros((3, 224, 224)),
)
for _ in range(100)
]
)

# push the DocList to S3
dl.push('s3://my-bucket/my-documents', show_progress=True)
docs = DocList[SimpleDoc]([SimpleDoc(text=f'doc {i}') for i in range(8)])
docs.push('file://simple_docs')

# pull the DocList from S3
dl_2 = DocList[ImageDoc].pull('s3://my-bucket/my-documents', show_progress=True)
docs_pull = DocList[SimpleDoc].pull('file://simple_docs')
```
</details>

Expand Down