FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: adding field descriptions to predefined mesh 3D document by punndcoder28 · Pull Request #1789 · docarray/docarray · GitHub

/ docarray Public

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

Merged
JoanFM merged 2 commits into
docarray:mainfrom
punndcoder28:docs_adding_field_description_mesh_3d_document
Sep 15, 2023
ConversationCommits (2)ChecksFiles changed
Merged

docs: adding field descriptions to predefined mesh 3D document#1789
JoanFM merged 2 commits into
docarray:mainfrom
punndcoder28:docs_adding_field_description_mesh_3d_document

Conversation

punndcoder28 commented Sep 15, 2023

Copy link
Copy Markdown
Contributor

punndcoder28 force-pushed the docs_adding_field_description_mesh_3d_document branch 2 times, most recently from 251f278 to d2c90f7 Compare September 15, 2023 16:09
punndcoder28 marked this pull request as ready for review September 15, 2023 16:10

punndcoder28 commented Sep 15, 2023

Copy link
Copy Markdown
Contributor Author

@JoanFM This PR addresses the changes to add field descriptions and examples for Mesh3D document

JoanFM requested changes Sep 15, 2023
View reviewed changes
Comment thread docarray/documents/mesh/mesh_3d.py Outdated
)
embedding: Optional[AnyEmbedding] = Field(
description='Store an embedding: a vector representation of the 3D mesh.',
default=[[1, 0, 1], [0, 1, 1], [1, 1, 0]],

JoanFM Sep 15, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

the embedding is tipically a 1-D vector, so better show that in example

punndcoder28 Sep 15, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Understood but the docs for this document says the below which is then added to the embedding in an example

Vertices are points in a 3D space, represented as a tensor of shape (n_points, 3)

#example 
model = MyEmbeddingModel()
mesh.embedding = model(mesh.vertices)

JoanFM Sep 15, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

buut vertices are not the embedding. The embedding is a vector semantically representing an object, in this case a 3D mesh represented by its vertices.

codecov Bot commented Sep 15, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Patch coverage: 100.00% and project coverage change: -1.52% ⚠️

Comparison is base (4ef4939) 81.60% compared to head (fa67f86) 80.08%.
Report is 1 commits behind head on main.

❗ Current head fa67f86 differs from pull request most recent head 8914bab. Consider uploading reports for the commit 8914bab to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1789      +/-   ##
==========================================
- Coverage   81.60%   80.08%   -1.52%     
==========================================
  Files         136      136              
  Lines        9044     9045       +1     
==========================================
- Hits         7380     7244     -136     
- Misses       1664     1801     +137
Flag Coverage Δ
docarray 80.08% <100.00%> (-1.52%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
docarray/documents/mesh/mesh_3d.py 82.35% <100.00%> (+1.10%) ⬆️

... and 7 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs: adding field descriptions to predefined mesh 3D document
fa67f86 
Signed-off-by: punndcoder28 <puneethk.2899@gmail.com>
punndcoder28 force-pushed the docs_adding_field_description_mesh_3d_document branch from d2c90f7 to fa67f86 Compare September 15, 2023 16:18
punndcoder28 requested a review from JoanFM September 15, 2023 16:18
JoanFM merged commit d0b9990 into docarray:main Sep 15, 2023
JoanFM mentioned this pull request Oct 2, 2023
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

JoanFM JoanFM approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL