fix: only display in notebook

Signed-off-by: anna-charlotte <[email protected]>
docarray · samsja · Feb 17, 2023 · Feb 9, 2023 · Feb 9, 2023 · Feb 9, 2023
commit 38f771d5f7e93b7adf31ee411f2c7d08414b2f1a
diff --git a/docarray/documents/mesh/mesh_3d.py b/docarray/documents/mesh/mesh_3d.py
@@ -46,6 +46,7 @@ class Mesh3D(BaseDocument):
         from docarray.typing import AnyEmbedding
         from typing import Optional
 
+
         # extend it
         class MyMesh3D(Mesh3D):
             name: Optional[Text]
@@ -65,6 +66,7 @@ class MyMesh3D(Mesh3D):
         from docarray import BaseDocument
         from docarray.documents import Mesh3D, Text
 
+
         # compose it
         class MultiModalDoc(BaseDocument):
             mesh: Mesh3D
@@ -81,7 +83,7 @@ class MultiModalDoc(BaseDocument):
         mmdoc.mesh.bytes = mmdoc.mesh.url.load_bytes()
 
 
-    You can display your 3D mesh from either its url, or its tensors:
+    You can display your 3D mesh in a notebook from either its url, or its tensors:
 
     .. code-block:: python
 

diff --git a/docarray/documents/point_cloud/points_and_colors.py b/docarray/documents/point_cloud/points_and_colors.py
@@ -5,7 +5,7 @@
 from docarray.base_document import BaseDocument
 from docarray.typing import AnyTensor
 from docarray.typing.tensor.abstract_tensor import AbstractTensor
-from docarray.utils.misc import is_notebook, is_tf_available, is_torch_available
+from docarray.utils.misc import is_tf_available, is_torch_available
 
 torch_available = is_torch_available()
 if torch_available:
@@ -46,7 +46,8 @@ def validate(
 
     def display(self) -> None:
         """
-        Plot point cloud consisting of points in 3D space and optionally colors.
+        Plot point cloud consisting of points in 3D space and optionally colors in
+        notebook.
         """
         import trimesh
         from IPython.display import display
@@ -61,8 +62,5 @@ def display(self) -> None:
         )
         pc = trimesh.points.PointCloud(vertices=self.points, colors=colors)
 
-        if is_notebook():
-            s = trimesh.Scene(geometry=pc)
-            display(s.show())
-        else:
-            display(pc.show())
+        s = trimesh.Scene(geometry=pc)
+        display(s.show())
diff --git a/docarray/typing/url/url_3d/mesh_url.py b/docarray/typing/url/url_3d/mesh_url.py
@@ -59,7 +59,7 @@ class MyDoc(BaseDocument):
 
     def display(self) -> None:
         """
-        Plot mesh from url.
+        Plot mesh in notebook from url.
         This loads the Trimesh instance of the 3D mesh, and then displays it.
         """
         from IPython.display import display

diff --git a/docarray/typing/url/url_3d/point_cloud_url.py b/docarray/typing/url/url_3d/point_cloud_url.py
@@ -73,7 +73,7 @@ class MyDoc(BaseDocument):
 
     def display(self, samples: int = 10000) -> None:
         """
-        Plot point cloud from url.
+        Plot point cloud in notebook from url.
         First, it loads the point cloud into a :class:`PointsAndColors` object, and then
         calls display on it. The following is therefore equivalent:
 
@@ -90,7 +90,7 @@ def display(self, samples: int = 10000) -> None:
             pc.url.display()
 
             # option 2 (equivalent)
-            pc.url.load().display()
+            pc.url.load(samples=10000).display()
 
         :param samples: number of points to sample from the mesh.
         """

diff --git a/docarray/utils/misc.py b/docarray/utils/misc.py
@@ -20,29 +20,3 @@ def is_torch_available():
 
 def is_tf_available():
     return tf_imported
-
-
-def is_notebook() -> bool:
-    """
-    Check if we're running in a Jupyter notebook, using magic command
-    `get_ipython` that only available in Jupyter.
-
-    :return: True if run in a Jupyter notebook else False.
-    """
-
-    try:
-        shell = get_ipython().__class__.__name__  # type: ignore
-    except NameError:
-        return False
-
-    if shell == 'ZMQInteractiveShell':
-        return True
-
-    elif shell == 'Shell':
-        return True
-
-    elif shell == 'TerminalInteractiveShell':
-        return False
-
-    else:
-        return False