Skip to content

docs: add colab notebook for interactive 3d data visualization#749

Merged
JoanFM merged 6 commits intomainfrom
docs-colab-3d-visualization-715
Nov 11, 2022
Merged

docs: add colab notebook for interactive 3d data visualization#749
JoanFM merged 6 commits intomainfrom
docs-colab-3d-visualization-715

Conversation

@anna-charlotte
Copy link
Copy Markdown
Contributor

@anna-charlotte anna-charlotte commented Nov 10, 2022

Goals:

Add a link to a Google Colab notebook to demonstrate DocArray's 3d data handling and interactive visualization. Prepare examples for DocArrays point cloud representation as well as vertices and faces representation for users to interact with.

  • prepare notebook
  • prepare data and push to Jina Hub
  • add colab link to docs

@anna-charlotte anna-charlotte linked an issue Nov 10, 2022 that may be closed by this pull request
@anna-charlotte anna-charlotte self-assigned this Nov 10, 2022
@anna-charlotte anna-charlotte marked this pull request as ready for review November 10, 2022 17:04
@anna-charlotte
Copy link
Copy Markdown
Contributor Author

Link to notebook can be found in the docs (Multimodal Data / Mesh 3d section) or here: https://colab.research.google.com/drive/17uHgNVndRlfAAV9CAB_HEHHuRdGgsBW2?usp=sharing

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 10, 2022

Codecov Report

Base: 84.40% // Head: 84.40% // No change to project coverage 👍

Coverage data is based on head (5ffb753) compared to base (6af88dc).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #749   +/-   ##
=======================================
  Coverage   84.40%   84.40%           
=======================================
  Files         133      133           
  Lines        6703     6703           
=======================================
  Hits         5658     5658           
  Misses       1045     1045           
Flag Coverage Δ
docarray 84.40% <ø> (ø)

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

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@JoanFM JoanFM closed this Nov 10, 2022
@JoanFM JoanFM reopened this Nov 10, 2022
Copy link
Copy Markdown
Member

@JoanFM JoanFM left a comment

Choose a reason for hiding this comment

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

make sure to check the login functionality in the notebook.

Also, remember once released, to simply do pip install docarray. Why is full needed is not clear to me

@anna-charlotte anna-charlotte marked this pull request as draft November 11, 2022 07:48
@anna-charlotte
Copy link
Copy Markdown
Contributor Author

@JoanFM The login works. W.r.t. the installation, I think as of right now, trimesh is only installed with the pip install "docarray[full]", not with the basic install though. Should I do pip install docarray, trimesh instead?

image

@anna-charlotte anna-charlotte marked this pull request as ready for review November 11, 2022 08:13
@JohannesMessner
Copy link
Copy Markdown
Member

@JoanFM The login works. W.r.t. the installation, I think as of right now, trimesh is only installed with the pip install "docarray[full]", not with the basic install though. Should I do pip install docarray, trimesh instead?

image

Didn't we at some point want to offer installs for different modalities, like pip install docarray[3dmesh]? Might be worth revisiting this idea

@samsja
Copy link
Copy Markdown
Member

samsja commented Nov 11, 2022

I believe we need to have the notebook as well in the repo

@github-actions
Copy link
Copy Markdown

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions github-actions bot added size/xl and removed size/xs labels Nov 11, 2022
@anna-charlotte
Copy link
Copy Markdown
Contributor Author

I added the notebook to docarray/docs/datatypes/mesh directory and added everyone from team core as editors of the notebook.

@github-actions github-actions bot added size/m and removed size/xl labels Nov 11, 2022
@github-actions
Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-colab-3d-visualization-715--jina-docs.netlify.app 🎉

@JoanFM JoanFM merged commit efc203f into main Nov 11, 2022
@JoanFM JoanFM deleted the docs-colab-3d-visualization-715 branch November 11, 2022 16:06
anna-charlotte added a commit that referenced this pull request Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

demo for new 3d data representation

5 participants