Skip to content

feat: add exclude fields metas parameter#891

Merged
JoanFM merged 9 commits into
mainfrom
fix-plot-embeddings
Dec 5, 2022
Merged

feat: add exclude fields metas parameter#891
JoanFM merged 9 commits into
mainfrom
fix-plot-embeddings

Conversation

@anna-charlotte

@anna-charlotte anna-charlotte commented Dec 5, 2022

Copy link
Copy Markdown
Contributor

Signed-off-by: anna-charlotte charlotte.gerhaher@jina.ai

Add the option to exclude additional fields from csv metadata file, such as .chunks by adding the parameter exclude_fields_metas to .plot_embedding.

  • add parameter exclude_fields_metas
  • check and update documentation, if required. See guide

Comment thread docarray/array/mixins/plot.py Outdated
@codecov-commenter

codecov-commenter commented Dec 5, 2022

Copy link
Copy Markdown

Codecov Report

Base: 88.15% // Head: 83.74% // Decreases project coverage by -4.40% ⚠️

Coverage data is based on head (28a0d72) compared to base (5ea0fc6).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #891      +/-   ##
==========================================
- Coverage   88.15%   83.74%   -4.41%     
==========================================
  Files         138      138              
  Lines        7148     7148              
==========================================
- Hits         6301     5986     -315     
- Misses        847     1162     +315     
Flag Coverage Δ
docarray 83.74% <100.00%> (-4.41%) ⬇️

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

Impacted Files Coverage Δ
docarray/array/mixins/plot.py 67.96% <100.00%> (ø)
docarray/math/evaluation.py 0.00% <0.00%> (-93.34%) ⬇️
docarray/array/mixins/embed.py 9.89% <0.00%> (-82.42%) ⬇️
docarray/array/mixins/evaluation.py 8.33% <0.00%> (-80.13%) ⬇️
docarray/array/storage/memory/find.py 54.68% <0.00%> (-40.63%) ⬇️
docarray/document/mixins/sugar.py 60.00% <0.00%> (-20.00%) ⬇️
docarray/array/mixins/group.py 71.05% <0.00%> (-18.43%) ⬇️
docarray/math/helper.py 67.64% <0.00%> (-17.65%) ⬇️
docarray/array/mixins/match.py 83.33% <0.00%> (-8.34%) ⬇️
docarray/array/mixins/setitem.py 74.79% <0.00%> (-8.14%) ⬇️
... and 4 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.

anna-charlotte added 3 commits December 5, 2022 12:06
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
@anna-charlotte anna-charlotte marked this pull request as ready for review December 5, 2022 11:10

@JohannesMessner JohannesMessner left a comment

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.

We need to document this, otherwise it looks good to me!
Also, is there a reason the argument is called exclude_fields_metas and not just exclude_fields or something like that?

@anna-charlotte anna-charlotte marked this pull request as draft December 5, 2022 11:19
Comment thread docarray/array/mixins/plot.py Outdated
anna-charlotte and others added 3 commits December 5, 2022 13:08
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
@anna-charlotte anna-charlotte marked this pull request as ready for review December 5, 2022 13:15
Comment thread docs/fundamentals/documentarray/visualization.md Outdated
Co-authored-by: Alex Cureton-Griffiths <alexcg1@users.noreply.github.com>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
Comment thread docs/fundamentals/documentarray/visualization.md Outdated
Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai>
@github-actions

github-actions Bot commented Dec 5, 2022

Copy link
Copy Markdown

📝 Docs are deployed on https://ft-fix-plot-embeddings--jina-docs.netlify.app 🎉

@JoanFM JoanFM enabled auto-merge (squash) December 5, 2022 16:25
@JoanFM JoanFM merged commit f7aaba4 into main Dec 5, 2022
@JoanFM JoanFM deleted the fix-plot-embeddings branch December 5, 2022 16:55
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.

5 participants