Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-v1-deprecated.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: 🐛 DocArray V1 Bug (0.1.0 - 0.20.1) (Deprecated Version)
name: 🐛 DocArray <=0.21 Bug (0.1.0 - 0.20.1) (Deprecated Version)
description: Report a bug or unexpected behavior in DocArray version prior to v2 (0.21.1)
labels: [bug V1, unconfirmed]

Expand Down
145 changes: 73 additions & 72 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docarray/array/doc_list/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ def _stream_header(self) -> bytes:
# Binary format for streaming case

# V2 DocList streaming serialization format
# | 1 byte | 8 bytes | 4 bytes | variable(docarray v2) | 4 bytes | variable(docarray v2) ...
# | 1 byte | 8 bytes | 4 bytes | variable(DocArray >=0.30) | 4 bytes | variable(DocArray >=0.30) ...

# 1 byte (uint8)
version_byte = b'\x02'
Expand Down
4 changes: 2 additions & 2 deletions docarray/documents/legacy/legacy_document.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@

class LegacyDocument(BaseDoc):
"""
This Document is the LegacyDocument. It follows the same schema as in DocArray v1.
This Document is the LegacyDocument. It follows the same schema as in DocArray <=0.21.
It can be useful to start migrating a codebase from v1 to v2.

Nevertheless, the API is not totally compatible with DocArray v1 `Document`.
Nevertheless, the API is not totally compatible with DocArray <=0.21 `Document`.
Indeed, none of the method associated with `Document` are present. Only the schema
of the data is similar.

Expand Down
16 changes: 16 additions & 0 deletions docs/assets/docarray-colorful.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/assets/docarray-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/how_to/add_doc_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ When indexing documents, your implementation should behave in the following way:
- Every field in the Document is mapped to a column in the database
- This includes the `id` field, which is mapped to the primary key of the database (if your backend has such a concept)
- The configuration of that column can be found in `self._column_infos[field_name].config`
- In DocArray v1, we used to store a serialized representation of every document. This is not needed anymore, as every row in your database table should fully represent a single indexed document.
- In DocArray <=0.21, we used to store a serialized representation of every document. This is not needed anymore, as every row in your database table should fully represent a single indexed document.

To handle nested documents, the public `index()` method already flattens every incoming document for you.
This means that `_index()` already receives a flattened representation of the data, and you don't need to worry about that.
Expand Down
6 changes: 3 additions & 3 deletions docs/migration_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

If you are using DocArray v<0.30.0, you will be familiar with its [dataclass API](https://docarray.jina.ai/fundamentals/dataclass/).

_DocArray v2 is that idea, taken seriously._ Every document is created through a dataclass-like interface,
_DocArray >=0.30 is that idea, taken seriously._ Every document is created through a dataclass-like interface,
courtesy of [Pydantic](https://pydantic-docs.helpmanual.io/usage/models/).

This gives the following advantages:
Expand Down Expand Up @@ -33,7 +33,7 @@ and additional `chunks` and `matches`.
- In v2 we have the [`LegacyDocument`][docarray.documents.legacy.LegacyDocument] class,
which extends `BaseDoc` while following the same schema as v1's `Document`.
The `LegacyDocument` can be useful to start migrating your codebase from v1 to v2.
Nevertheless, the API is not fully compatible with DocArray v1 `Document`.
Nevertheless, the API is not fully compatible with DocArray <=0.21 `Document`.
Indeed, none of the methods associated with `Document` are present.
Only the schema of the data is similar.

Expand Down Expand Up @@ -100,7 +100,7 @@ book_titles = docs.title # returns a list[str]
## Changes to Document Store

In v2 the `Document Store` has been renamed to [`DocIndex`](user_guide/storing/docindex.md) and can be used for fast retrieval using vector similarity.
DocArray v2 `DocIndex` supports:
DocArray >=0.30 `DocIndex` supports:

- [Weaviate](https://weaviate.io/)
- [Qdrant](https://qdrant.tech/)
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/representing/array.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Array of documents

DocArray allows users to represent and manipulate multi-modal data to build AI applications such as neural search and generative AI.
DocArray allows users to represent and manipulate multimodal data to build AI applications such as neural search and generative AI.

As you have seen in the [previous section](array.md), the fundamental building block of DocArray is the [`BaseDoc`][docarray.base_doc.doc.BaseDoc] class which represents a *single* document, a *single* datapoint.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/sending/api/jina.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this example we'll build an audio-to-text app using [Jina](https://docs.jina.

We will use:

* DocArray V2: To load and preprocess multimodal data such as image, text and audio.
* DocArray >=0.30: To load and preprocess multimodal data such as image, text and audio.
* Jina: To serve the model quickly and create a client.

## Install packages
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/sending/first_step.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Introduction

In the representation section we saw how to use [`BaseDoc`][docarray.base_doc.doc.BaseDoc], [`DocList`][docarray.array.doc_list.doc_list.DocList] and [`DocVec`][docarray.array.doc_vec.doc_vec.DocVec]
to represent multi-modal data. In this section we will see **how to send such data over the wire**.
to represent multimodal data. In this section we will see **how to send such data over the wire**.

This section is divided into two parts:

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/storing/first_step.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

In the previous sections we saw how to use [`BaseDoc`][docarray.base_doc.doc.BaseDoc], [`DocList`][docarray.array.doc_list.doc_list.DocList] and [`DocVec`][docarray.array.doc_vec.doc_vec.DocVec] to represent multi-modal data and send it over the wire.
In the previous sections we saw how to use [`BaseDoc`][docarray.base_doc.doc.BaseDoc], [`DocList`][docarray.array.doc_list.doc_list.DocList] and [`DocVec`][docarray.array.doc_vec.doc_vec.DocVec] to represent multimodal data and send it over the wire.
In this section we will see how to store and persist this data.

DocArray offers two ways of storing your data, each of which have their own documentation sections:
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ repo_name: docarray/docarray
repo_url: https://github.com/docarray/docarray
edit_uri: ''
theme:
logo: assets/logo-light.svg
logo: assets/docarray-dark.svg

favicon: assets/favicon.png
name: material
Expand Down