Skip to content

docs: adding field descriptions to predefined mesh 3D document #1789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoanFM merged 2 commits into from
Sep 15, 2023
Merged

docs: adding field descriptions to predefined mesh 3D document #1789

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa67f86
docs: adding field descriptions to predefined mesh 3D document
punndcoder28 Sep 15, 2023
8914bab
Merge branch 'main' into docs_adding_field_description_mesh_3d_document
Sep 15, 2023
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
25 changes: 21 additions & 4 deletions docarray/documents/mesh/mesh_3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
from typing import Any, Optional, Type, TypeVar, Union

from pydantic import Field

from docarray.base_doc import BaseDoc
from docarray.documents.mesh.vertices_and_faces import VerticesAndFaces
from docarray.typing.tensor.embedding import AnyEmbedding
from docarray.typing.url.url_3d.mesh_url import Mesh3DUrl


T = TypeVar('T', bound='Mesh3D')


Expand Down Expand Up @@ -103,10 +106,24 @@ class MultiModalDoc(BaseDoc):

"""

url: Optional[Mesh3DUrl] = None
tensors: Optional[VerticesAndFaces] = None
embedding: Optional[AnyEmbedding] = None
bytes_: Optional[bytes] = None
url: Optional[Mesh3DUrl] = Field(
description='URL to a file containing 3D mesh information. Can be remote (web) URL, or a local file path.',
example='https://people.sc.fsu.edu/~jburkardt/data/obj/al.obj',
default=None,
)
tensors: Optional[VerticesAndFaces] = Field(
description='A tensor object of 3D mesh of type `VerticesAndFaces`.',
example=[[0, 1, 1], [1, 0, 1], [1, 1, 0]],
default=None,
)
embedding: Optional[AnyEmbedding] = Field(
description='Store an embedding: a vector representation of the 3D mesh.',
default=[1, 0, 1],
)
bytes_: Optional[bytes] = Field(
description='Bytes representation of 3D mesh.',
default=None,
)

@classmethod
def validate(
Expand Down