docs: adding field descriptions to predefined mesh 3D document #1789
Conversation
251f278 to
d2c90f7
Compare
|
@JoanFM This PR addresses the changes to add field descriptions and examples for |
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]], |
There was a problem hiding this comment.
the embedding is tipically a 1-D vector, so better show that in example
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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 ReportPatch coverage:
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
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
Signed-off-by: punndcoder28 <[email protected]>
d2c90f7 to
fa67f86
Compare
Mesh3Ddocument Add Field Description and example to Predefined Documents #1736