Skip to content

docs: add docs for docvec serialization#1349

Closed
nan-wang wants to merge 1 commit intofeat-rewrite-v2from
docs-send-docvec-0410
Closed

docs: add docs for docvec serialization#1349
nan-wang wants to merge 1 commit intofeat-rewrite-v2from
docs-send-docvec-0410

Conversation

@nan-wang
Copy link
Copy Markdown
Collaborator

Goals:

  • add docs for docvec serialization
  • check and update documentation, if required. See guide

@nan-wang nan-wang marked this pull request as draft April 10, 2023 11:17
@github-actions
Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-send-docvec-0410--jina-docs.netlify.app 🎉

@@ -0,0 +1,23 @@
# Serialization for `DocVec`
When sending or storing `DocVec`, you need to use serialization. `DocVec` only supports protobuf to serialize the data.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When sending or storing `DocVec`, you need to use serialization. `DocVec` only supports protobuf to serialize the data.
When sending or storing [`DocVec`][docarray.array.doc_vec.doc_vec.DocVec], you need to use serialization. `DocVec` only supports protobuf to serialize the data.

@samsja samsja self-assigned this Apr 12, 2023
@samsja
Copy link
Copy Markdown
Member

samsja commented Apr 12, 2023

closing this pr as I will merge the content in the other pr #1350

@samsja samsja closed this Apr 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants