docs: adding field descriptions to predefined image document

punndcoder28 · punndcoder28 · commit fb2edac970f5 · 2023-09-04T22:27:06.000+05:30
Signed-off-by: punndcoder28 &lt;puneethk.2899@gmail.com&gt;
diff --git a/docarray/documents/image.py b/docarray/documents/image.py
@@ -2,12 +2,15 @@
 
 import numpy as np
 
+from pydantic import Field
+
 from docarray.base_doc import BaseDoc
 from docarray.typing import AnyEmbedding, ImageBytes, ImageUrl
 from docarray.typing.tensor.abstract_tensor import AbstractTensor
 from docarray.typing.tensor.image.image_tensor import ImageTensor
 from docarray.utils._internal.misc import import_library
 
+
 if TYPE_CHECKING:
     import tensorflow as tf  # type: ignore
     import torch
@@ -92,10 +95,25 @@ class MultiModalDoc(BaseDoc):
     ```
     """
 
-    url: Optional[ImageUrl]
-    tensor: Optional[ImageTensor]
-    embedding: Optional[AnyEmbedding]
-    bytes_: Optional[ImageBytes]
+    url: Optional[ImageUrl] = Field(
+        description='URL of the remote image',
+        example='https://github.com/docarray/docarray/blob/main/tests/toydata/image-data/apple.png?raw=true',
+    )
+    tensor: Optional[ImageTensor] = Field(
+        description='''Tensor object of the image which can be specifed to one of
+    `ImageNdArray`, `ImageTorchTensor`, `ImageTensorflowTensor`.''',
+        example='img.url.load()',
+    )
+    embedding: Optional[AnyEmbedding] = Field(
+        description='''Embedding field is used to store tensor objects of type
+        Tensorflow, PyTorch, NumPy and Jax''',
+        example='np.zeros((3, 32, 32))',
+    )
+    bytes_: Optional[ImageBytes] = Field(
+        description='''Bytes object of the image which is an instance of
+        `ImageBytes.''',
+        example='img.url.load_bytes()',
+    )
 
     @classmethod
     def validate(
