Skip to content
This repository was archived by the owner on Sep 9, 2026. It is now read-only.

Latest commit

 

History

History
150 lines (104 loc) · 3.03 KB

index.md

File metadata and controls

150 lines (104 loc) · 3.03 KB

Welcome to DocArray!

:start-after: <!-- start elevator-pitch -->
:end-before: <!-- end elevator-pitch -->

Install

PyPI is the latest version.

Make sure you have Python 3.7+ and numpy installed on Linux/Mac/Windows:


```bash
pip install docarray
```

No extra dependency will be installed.

```bash
conda install -c conda-forge docarray
```

No extra dependency will be installed.

```bash
pip install "docarray[common]"
```

The following dependencies will be installed to enable the most common features:

| Package | Used in |
|---|---|
| `protobuf` | advanced serialization |
| `lz4` | compression in seralization |
| `requests` | push/pull to Jina Cloud |
| `matplotlib` | visualizing image sprites |
| `Pillow` | image data-related IO |
| `fastapi`| used in embedding projector of DocumentArray|
| `uvicorn`| used in embedding projector of DocumentArray|


```bash
pip install "docarray[full]"
```

In addition to `common`, the following dependencies will be installed to enable full features:

| Package | Used in |
|---|---|
| `scipy` | for sparse embedding, tensors |
| `av` | for video processing and IO |
| `trimesh` | for 3D mesh processing and IO |
| `weaviate-client` | for using Weaviate-based document store |
| `annlite` | for using Annlite-based document store |
| `qdrant-client` | for using Qdrant-based document store |
| `strawberry-graphql` | for GraphQL support |

Alternatively, you can first do basic installation and then install missing dependencies on-demand. 

```bash
pip install "docarray[full,test]"
```

This will install all requirements for reproducing tests on your local dev environment.
>>> import docarray
>>> docarray.__version__
'0.1.0'
>>> from docarray import Document, DocumentArray
Jina 3.x users do not need to install `docarray` separately, as it is shipped with Jina. To check your Jina version, type `jina -vf` in the console.

However, if the printed version is smaller than `0.1.0`, say `0.0.x`, then you are 
not installing `docarray` correctly. You are probably still using an old `docarray` shipped with Jina 2.x. 
:start-after: <!-- start support-pitch -->
:end-before: <!-- end support-pitch -->
:caption: Get Started
:hidden:

get-started/what-is
:caption: User Guides
:hidden:

fundamentals/document/index
fundamentals/documentarray/index
datatypes/index

:caption: Integrations
:hidden:

fundamentals/jina-support/index
fundamentals/notebook-support/index
fundamentals/fastapi-support/index
advanced/graphql-support/index
advanced/document-store/index
:caption: Developer References
:hidden:
:maxdepth: 1

api/docarray
proto/index
changelog/index
advanced/document-store/extend

{ref}genindex | {ref}modindex