GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — docs: adding field descriptions to predefined mesh 3D document by punndcoder28 · Pull Request #1789 · docarray/docarray

This repository was archived by the owner on Sep 9, 2026. It is now read-only.

Conversation

@punndcoder28

@punndcoder28 punndcoder28 commented Sep 15, 2023

Copy link
Copy Markdown
Contributor
  • Add Field Description and examples to predefined Mesh3D document Add Field Description and example to Predefined Documents #1736

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@punndcoder28
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
punndcoder28 marked this pull request as ready for review September 15, 2023 16:10
@punndcoder28

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
JoanFM
JoanFM suggested 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 JoanFM Sep 15, 2023

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@punndcoder28 punndcoder28 Sep 15, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@JoanFM JoanFM Sep 15, 2023

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@codecov

codecov Bot commented Sep 15, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@punndcoder28
docs: adding field descriptions to predefined mesh 3D document
fa67f86 
Signed-off-by: punndcoder28 <[email protected]>
@punndcoder28
punndcoder28 force-pushed the docs_adding_field_description_mesh_3d_document branch from d2c90f7 to fa67f86 Compare September 15, 2023 16:18
@punndcoder28
punndcoder28 requested a review from JoanFM September 15, 2023 16:18
Joan Fontanals
Merge branch 'main' into docs_adding_field_description_mesh_3d_document
8914bab
JoanFM
JoanFM approved these changes Sep 15, 2023
View reviewed changes
@JoanFM
JoanFM merged commit d0b9990 into docarray:main Sep 15, 2023
@JoanFM JoanFM mentioned this pull request Oct 2, 2023
Release Notes #1817
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@JoanFM JoanFM JoanFM approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@punndcoder28 @JoanFM
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.