From da9b9fc145af2c1cb4c15acc0748c420059b82fe Mon Sep 17 00:00:00 2001 From: Joan Fontanals Martinez Date: Thu, 24 Aug 2023 09:54:19 +0200 Subject: [PATCH] docs: add note about pickling dynamically created doc class Signed-off-by: Joan Fontanals Martinez --- docarray/documents/helper.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docarray/documents/helper.py b/docarray/documents/helper.py index d5a7db86443..f74c4bc0cd9 100644 --- a/docarray/documents/helper.py +++ b/docarray/documents/helper.py @@ -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