Skip to content

Commit 4783377

Browse files
dev-bot@jina.aidev-bot@jina.ai
authored andcommitted
chore(docs): sync up README from docarray
Signed-off-by: dev-bot@jina.ai <Jina Dev Bot>
1 parent c63b4de commit 4783377

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ DocArray is a library for nested, unstructured, multimodal data in transit, incl
3434

3535
🛸 **IDE integration**: pretty-print and visualization on Jupyter notebook and Google Colab; comprehensive autocomplete and type hints in PyCharm and VS Code.
3636

37-
Read more on [why should you use DocArray](https://docarray.jina.ai/get-started/what-is/) and [comparison to alternatives](https://docarray.jina.ai/get-started/what-is/#comparing-to-alternatives).
37+
Read more on [why should you use DocArray](https://docs.docarray.org/get-started/what-is/) and [comparison to alternatives](https://docs.docarray.org/get-started/what-is/#comparing-to-alternatives).
3838

3939
<!-- end elevator-pitch -->
4040

4141
DocArray was released under the open-source [Apache License 2.0](https://github.com/docarray/docarray/blob/main/LICENSE) in January 2022. It is currently a sandbox project under [LF AI & Data Foundation](https://lfaidata.foundation/).
4242

43-
## [Documentation](https://docarray.jina.ai)
43+
## [Documentation](https://docs.docarray.org)
4444

4545
## Install
4646

@@ -52,7 +52,7 @@ or via Conda:
5252
```shell
5353
conda install -c conda-forge docarray
5454
```
55-
[Commonly used features](https://docarray.jina.ai/#install) can be enabled via `pip install "docarray[common]"`.
55+
[Commonly used features](https://docs.docarray.org/#install) can be enabled via `pip install "docarray[common]"`.
5656

5757

5858
## Get Started
@@ -141,7 +141,7 @@ Here the feature embedding is done by simple [feature hashing](https://en.wikipe
141141

142142
### Example 3: external storage for out-of-memory data
143143

144-
When your data is too big, storing in memory is not the best idea. DocArray supports [multiple storage backends](https://docarray.jina.ai/advanced/document-store/) such as SQLite, Weaviate, Qdrant and AnnLite. They're all unified under **the exact same user experience and API**. Take the above snippet: you only need to change one line to use SQLite:
144+
When your data is too big, storing in memory is not the best idea. DocArray supports [multiple storage backends](https://docs.docarray.org/advanced/document-store/) such as SQLite, Weaviate, Qdrant and AnnLite. They're all unified under **the exact same user experience and API**. Take the above snippet: you only need to change one line to use SQLite:
145145

146146
```python
147147
da = DocumentArray(
@@ -208,7 +208,7 @@ left_da.plot_image_sprites()
208208
```
209209

210210
<p align="center">
211-
<a href="https://docarray.jina.ai"><img src="https://github.com/docarray/docarray/blob/main/.github/README-img/sprite.png?raw=true" alt="Load totally looks like dataset with docarray API" width="60%"></a>
211+
<a href="https://docs.docarray.org"><img src="https://github.com/docarray/docarray/blob/main/.github/README-img/sprite.png?raw=true" alt="Load totally looks like dataset with docarray API" width="60%"></a>
212212
</p>
213213

214214
### Apply preprocessing
@@ -254,7 +254,7 @@ left_da.plot_embeddings(image_sprites=True)
254254
```
255255

256256
<p align="center">
257-
<a href="https://docarray.jina.ai"><img src="https://github.com/docarray/docarray/blob/main/.github/README-img/tsne.gif?raw=true" alt="Visualizing embedding via tSNE and embedding projector" width="90%"></a>
257+
<a href="https://docs.docarray.org"><img src="https://github.com/docarray/docarray/blob/main/.github/README-img/tsne.gif?raw=true" alt="Visualizing embedding via tSNE and embedding projector" width="90%"></a>
258258
</p>
259259

260260
Fun is fun, but our goal is to match left images against right images, and so far we have only handled the left. Let's repeat the same procedure for the right:
@@ -334,8 +334,8 @@ Better see it.
334334
```
335335

336336
<p align="center">
337-
<a href="https://docarray.jina.ai"><img src="https://github.com/jina-ai/docarray/blob/main/.github/README-img/9nn-left.jpeg?raw=true" alt="Visualizing top-9 matches using DocArray API" height="250px"></a>
338-
<a href="https://docarray.jina.ai"><img src="https://github.com/jina-ai/docarray/blob/main/.github/README-img/9nn.png?raw=true" alt="Visualizing top-9 matches using DocArray API" height="250px"></a>
337+
<a href="https://docs.docarray.org"><img src="https://github.com/jina-ai/docarray/blob/main/.github/README-img/9nn-left.jpeg?raw=true" alt="Visualizing top-9 matches using DocArray API" height="250px"></a>
338+
<a href="https://docs.docarray.org"><img src="https://github.com/jina-ai/docarray/blob/main/.github/README-img/9nn.png?raw=true" alt="Visualizing top-9 matches using DocArray API" height="250px"></a>
339339
</p>
340340

341341
Here we reversed the preprocessing steps (i.e. switching axis and normalizing) on the copied matches, so you can visualize them using image sprites.
@@ -400,7 +400,7 @@ Now anyone who knows the token `my_shared_da` can pull and work on it.
400400
left_da = DocumentArray.pull('<username>/my_shared_da')
401401
```
402402

403-
Intrigued? That's only scratching the surface of what DocArray is capable of. [Read our docs to learn more](https://docarray.jina.ai).
403+
Intrigued? That's only scratching the surface of what DocArray is capable of. [Read our docs to learn more](https://docs.docarray.org).
404404

405405

406406
<!-- start support-pitch -->

0 commit comments

Comments
 (0)