:start-after: <!-- start elevator-pitch -->
:end-before: <!-- end elevator-pitch -->
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[full]"
```
The following dependencies will be installed to enable additional 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 |
| `rich` | push/pull to Jina Cloud, summary of Document, DocumentArray |
| `av` | video data-related IO |
| `trimesh`| 3D mesh data-related IO |
| `fastapi`| used in embedding projector of DocumentArray|
Alternatively, you can first do basic installation and then install missing dependencies on-demand.
>>> import docarray
>>> docarray.__version__
'0.1.0'
>>> from docarray import Document, DocumentArrayJina 3.x[^1] 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
fundamentals/notebook-support/index
fundamentals/fastapi-support/index
:caption: Developer References
:hidden:
:maxdepth: 1
api/docarray
proto/index
changelog/index
{ref}genindex | {ref}modindex