Skip to content

docs: add note about pickling dynamically created doc class #1763

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
merged 1 commit into from
Aug 24, 2023
Merged

docs: add note about pickling dynamically created doc class #1763

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
6 changes: 6 additions & 0 deletions docarray/documents/helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ def create_doc(
"""
Dynamically create a subclass of BaseDoc. This is a wrapper around pydantic's create_model.

!!! note
To pickle a dynamically created BaseDoc subclass:

- the class must be defined globally
- it must provide `__module__`

```python
from docarray.documents import Audio
from docarray.documents.helper import create_doc
Expand Down