feat(v2): rich display for doc and da - #1043
Merged
samsja merged 46 commits intoJan 25, 2023
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
anna-charlotte
force-pushed
the
feat-rich-display
branch
from
5d453d4 to
ca7aadf
Compare
January 19, 2023 14:58
Copy link
Copy Markdown
Member
|
@anna-charlotte I believe we should tackle pretty printing in this PR as well. at the moment pritting a document array will lool like this <docarray.array.abstract_array.DocumentArray[Document][MyDoc] at 0x7fb93800b5e0> which is not very informative. Same apply to document |
Sorry, something went wrong.
anna-charlotte
force-pushed
the
feat-rich-display
branch
from
15b6e0a to
b5923ad
Compare
January 23, 2023 13:16
samsja
reviewed
Jan 23, 2023
Comment thread
docarray/base_document/document.py
Outdated
anna-charlotte
commented
Jan 23, 2023
Comment thread
docarray/base_document/document.py
Outdated
Copy link
Copy Markdown
Contributor
Author
|
Wrt pretty prints: this PR only includes the pretty print for DocumentArray but not for Document, since for the latter I encountered the following problem: rich provides a nice pretty print for pydantic models, which we would like to use as the Documents __repr__(). class MyDoc(pydantic.BaseModel):
title: str
mydoc = MyDoc(title='my title')
rich.print(mydoc)output: MyDoc(
title='my title'
)
But for the Documents .summary() we overwrite the __rich_console__() function to the tabular print wanted for the summary such as: mydoc.summary()----------------------------------------- | Attribute | Value | ----------------------------------------- | title | 'my title' | ----------------------------------------- This __rich_console__() is also being called in the rich.print(mydoc), which results in a tabular summary display for the pretty print instead of the pydantic pretty print. I opened a question in their discussion to see if there is a nice way to solve this. Therefore for now only pretty print for DocumenArray. |
Sorry, something went wrong.
samsja
reviewed
Jan 24, 2023
Comment thread
docarray/math/helper.py
Outdated
samsja
reviewed
Jan 24, 2023
Comment thread
docarray/base_document/mixins/plot.py
Outdated
samsja
reviewed
Jan 24, 2023
Comment thread
docarray/base_document/mixins/plot.py
Outdated
anna-charlotte
force-pushed
the
feat-rich-display
branch
from
4592694 to
181b5a9
Compare
January 24, 2023 10:32
anna-charlotte
commented
Jan 24, 2023
Comment thread
docarray/base_document/mixins/plot.py
Outdated
anna-charlotte
marked this pull request as ready for review
January 24, 2023 13:43
Copy link
Copy Markdown
Member
|
@anna-charlotte could you please link this PR/Issue to the dev roadmap and tick it off once merged? |
Sorry, something went wrong.
JohannesMessner
approved these changes
Jan 24, 2023
JohannesMessner
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Honestly I am lost in all of this rich stuff, but the screenshots look pretty, so that's a thumbs up from me ^^
Sorry, something went wrong.
added 24 commits
January 25, 2023 14: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>
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>
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>
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>
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>
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>
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>
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
force-pushed
the
feat-rich-display
branch
from
23e3f6a to
2a6bd5c
Compare
January 25, 2023 13:06
Copy link
Copy Markdown
|
📝 Docs are deployed on https://ft-feat-rich-display--jina-docs.netlify.app 🎉 |
Sorry, something went wrong.
JoanFM
pushed a commit
that referenced
this pull request
Jan 26, 2023
* feat: add rich display for doc and da Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: wip plot Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: wip plot Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: wip plot Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * feat: add math package and minmax normalize Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: summary for document Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * chore: update poetry lock after rebase Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: move all from plotmixin to base document Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * feat: add docs schema summary Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * feat: add document array summary Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: display doc within doc Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: in notebook print docs summary Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: move summary from da to abstract da Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: get schema for doc Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: wip doc summary Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: wip clean up Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * test: add test for da pretty print Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * docs: update note Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * docs: add some documentation Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: apply samis suggestion Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: mypy checks Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: move to plot mixin Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: remove redundant line Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: remove comments Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * feat: add schema highlighter Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: add plotmixin to mixin init Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: adjust da summary Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: move minmaxnormalize to comp backend Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: remove redundant lines Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: add squeeze and detach to comp backend Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: apply suggestion from code review Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * refactor: rename iterable attrs Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: clean up Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: import Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: iterate over fields instead of annotations Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: remove math package since moved to comp backends Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * refactor: use single quotes Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: apply suggestions from code review Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: extract summary to doc summary class Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: add pretty print for base document Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: use rich capture instead of string io Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: add colors for optional and union and use only single quotes Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: extract display classes to display package Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: make da not optional in da summary Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: set _console instead of initializing new one everytime in __str__ Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> * fix: put console at module level Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> Signed-off-by: anna-charlotte <charlotte.gerhaher@jina.ai> Signed-off-by: Joan Fontanals Martinez <joan.martinez@jina.ai>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
3 participants
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.
Goals:
Pretty prints:
For Document:
Example:
For DocumentArray: