-
Notifications
You must be signed in to change notification settings - Fork 233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(v2): rich display for doc and da #1043
Conversation
5d453d4
to
ca7aadf
Compare
@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 |
15b6e0a
to
b5923ad
Compare
Wrt pretty prints: this PR only includes the pretty print for rich provides a nice pretty print for pydantic models, which we would like to use as the Documents class MyDoc(pydantic.BaseModel):
title: str
mydoc = MyDoc(title='my title')
rich.print(mydoc) output:
But for the Documents mydoc.summary()
This 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. |
4592694
to
181b5a9
Compare
@anna-charlotte could you please link this PR/Issue to the dev roadmap and tick it off once merged? |
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.
Honestly I am lost in all of this rich
stuff, but the screenshots look pretty, so that's a thumbs up from me ^^
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>
23e3f6a
to
2a6bd5c
Compare
📝 Docs are deployed on https://ft-feat-rich-display--jina-docs.netlify.app 🎉 |
* 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>
Goals:
.summary()
to for Document and DocumentArray.Pretty prints:

For
Document
:doc.summary()
to display the Document instance2184b5 ...
instead of2184b53f977f566d72f72a6e706edb00
Example:
doc.schema_summary()
to display the Document's schemaFor
DocumentArray
:Homogenous Documents
Common Attributes
, instead show the schemaMultimodal dataclass