docs: small fixes in docs

Signed-off-by: anna-charlotte <[email protected]>
docarray · samsja · Jan 17, 2023 · Jan 3, 2023 · Jan 3, 2023 · Jan 4, 2023
commit 7ab8dbd41af0d7ef7bb1a8b89a07d5b2e81af4ce
diff --git a/docarray/__init__.py b/docarray/__init__.py
@@ -3,4 +3,7 @@
 from docarray.array.array import DocumentArray
 from docarray.base_document.document import BaseDocument
 
-__all__ = ['BaseDocument', 'DocumentArray']
+__all__ = [
+    'BaseDocument',
+    'DocumentArray',
+]
diff --git a/docarray/computation/abstract_comp_backend.py b/docarray/computation/abstract_comp_backend.py
@@ -1,8 +1,9 @@
 import typing
 from abc import ABC, abstractmethod
-from typing import List, Optional, Tuple, TypeVar, Union
+from typing import TYPE_CHECKING, List, Optional, Tuple, TypeVar, Union
 
-import numpy as np
+if TYPE_CHECKING:
+    import numpy as np
 
 # In practice all of the below will be the same type
 TTensor = TypeVar('TTensor')
@@ -38,7 +39,7 @@ def n_dim(array: 'TTensor') -> int:
 
     @staticmethod
     @abstractmethod
-    def to_numpy(array: 'TTensor') -> np.ndarray:
+    def to_numpy(array: 'TTensor') -> 'np.ndarray':
         """
         Convert array to np.ndarray.
         """

diff --git a/docarray/computation/numpy_backend.py b/docarray/computation/numpy_backend.py
@@ -65,7 +65,7 @@ def n_dim(array: 'np.ndarray') -> int:
         return array.ndim
 
     @staticmethod
-    def to_numpy(array: 'np.ndarray') -> np.ndarray:
+    def to_numpy(array: 'np.ndarray') -> 'np.ndarray':
         return array
 
     @staticmethod

diff --git a/docarray/computation/torch_backend.py b/docarray/computation/torch_backend.py
@@ -66,7 +66,7 @@ def n_dim(array: 'torch.Tensor') -> int:
         return array.ndim
 
     @staticmethod
-    def to_numpy(array: 'torch.Tensor') -> np.ndarray:
+    def to_numpy(array: 'torch.Tensor') -> 'np.ndarray':
         return array.cpu().detach().numpy()
 
     @staticmethod

diff --git a/docarray/documents/video.py b/docarray/documents/video.py
@@ -14,7 +14,8 @@ class Video(BaseDocument):
     Document for handling video.
     The Video Document can contain a VideoUrl (`Video.url`), an AudioTensor
     (`Video.audio_tensor`), a VideoTensor (`Video.video_tensor`), an AnyTensor
-    ('Video.key_frame_indices), and an AnyEmbedding (`Video.embedding`).
+    representing the indices of the video's key frames (`Video.key_frame_indices`),
+    and an AnyEmbedding (`Video.embedding`).
 
     EXAMPLE USAGE:
 

diff --git a/docarray/typing/tensor/video/abstract_video_tensor.py b/docarray/typing/tensor/video/abstract_video_tensor.py
@@ -13,9 +13,9 @@ class AbstractVideoTensor(AbstractTensor, ABC):
     def save_to_mp4_file(
         self: 'T',
         file_path: Union[str, BinaryIO],
+        audio_tensor: Optional[AudioTensor] = None,
         video_frame_rate: int = 24,
         video_codec: str = 'h264',
-        audio_tensor: Optional[AudioTensor] = None,
         audio_frame_rate: int = 48000,
         audio_codec: str = 'aac',
         audio_format: str = 'fltp',
@@ -25,9 +25,9 @@ def save_to_mp4_file(
 
         :param file_path: path to a .mp4 file. If file is a string, open the file by
             that name, otherwise treat it as a file-like object.
+        :param audio_tensor: AudioTensor containing the video's soundtrack.
         :param video_frame_rate: video frames per second.
         :param video_codec: the name of a video decoder/encoder.
-        :param audio_tensor: AudioTensor that should be added as soundtrack.
         :param audio_frame_rate: audio frames per second.
         :param audio_codec: the name of an audio decoder/encoder.
         :param audio_format: the name of one of the audio formats supported by PyAV,

diff --git a/docarray/typing/url/video_url.py b/docarray/typing/url/video_url.py
@@ -86,7 +86,9 @@ class MyDoc(BaseDocument):
                 key_frame_indices: Optional[NdArray]
 
 
-            doc = MyDoc(video_url='toydata/mov_bbb.mp4')
+            doc = MyDoc(
+                video_url='https://github.com/docarray/docarray/tree/feat-add-video-v2/tests/toydata/mov_bbb.mp4?raw=true'
+            )
             doc.audio, doc.video, doc.key_frame_indices = doc.video_url.load()
 
             assert isinstance(doc.video, VideoNdArray)
@@ -109,7 +111,9 @@ class MyDoc(BaseDocument):
                 video_key_frames: Optional[VideoNdArray]
 
 
-            doc = MyDoc(video_url='toydata/mov_bbb.mp4')
+            doc = MyDoc(
+                video_url='https://github.com/docarray/docarray/tree/feat-add-video-v2/tests/toydata/mov_bbb.mp4?raw=true'
+            )
             doc.video_key_frames = doc.video_url.load(only_keyframes=True)
 
             assert isinstance(doc.video_key_frames, VideoNdArray)