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

Signed-off-by: Joan Fontanals Martinez <joan.martinez@jina.ai>
docarray · Aug 24, 2023 · 587ab5b · 587ab5b
1 parent 61bf9c7
commit 587ab5b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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