Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add display example to docs
Signed-off-by: anna-charlotte <[email protected]>
  • Loading branch information
anna-charlotte committed Feb 15, 2023
commit dca04ceb2fa750381ec06c03a4479d4ca83cd150
2 changes: 1 addition & 1 deletion docarray/documents/mesh/mesh_3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ class MultiModalDoc(BaseDocument):
mmdoc.mesh.bytes = mmdoc.mesh.url.load_bytes()


You can display your point cloud from either its url, or its tensors:
You can display your 3D mesh from either its url, or its tensors:

.. code-block:: python

Expand Down
16 changes: 16 additions & 0 deletions docarray/documents/point_cloud/point_cloud_3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,22 @@ class MultiModalDoc(BaseDocument):

mmdoc.point_cloud.bytes = mmdoc.point_cloud.url.load_bytes()


You can display your point cloud from either its url, or its tensors:

.. code-block:: python

from docarray.documents import PointCloud3D

# display from url
pc = PointCloud3D(url='https://people.sc.fsu.edu/~jburkardt/data/obj/al.obj')
pc.url.display()

# display from tensors
pc.tensors = pc.url.load(samples=10000)
model = MyEmbeddingModel()
pc.embedding = model(pc.tensors.points)

"""

url: Optional[PointCloud3DUrl]
Expand Down