Skip to content

fix: DocArrayStack to DocVec in docstrings #1347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samsja merged 1 commit into from
Apr 11, 2023
Merged

fix: DocArrayStack to DocVec in docstrings #1347

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docarray/array/doc_vec/doc_vec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ class DocVec(AnyDocArray[T_doc]):
A DocVec has a similar interface as
{class}`~docarray.array.DocList` but with an underlying implementation that is
column based instead of row based. Each field
of the schema of the DocArrayStack
of the schema of the DocVec
(the :attr:`~docarray.array.doc_vec.DocVec.doc_type` which is a
`BaseDoc`) will be stored in a column. If the field is a tensor, the data from all Documents will be stored as a single, doc_vec (torch/np/tf) tensor.
If the tensor field
Expand Down Expand Up @@ -195,7 +195,7 @@ def from_columns_storage(cls: Type[T], storage: ColumnStorage) -> T:
"""
Create a DocVec directly from a storage object
:param storage: the underlying storage.
:return: a DocArrayStack
:return: a DocVec
"""
docs = cls.__new__(cls)
docs.tensor_type = storage.tensor_type
Expand Down