feat(v2): rich display for doc and da by anna-charlotte · Pull Request #1043 · docarray/docarray

anna-charlotte · 2023-01-19T14:32:50Z

Goals:

Add .summary() to for Document and DocumentArray.
Add pretty print for Document as well as DocumentArray.

Pretty prints:

For Document:

doc.summary() to display the Document instance
- key, value (including type and shape)
- maybe display shorter id: 2184b5 ... instead of 2184b53f977f566d72f72a6e706edb00
- if eg. list of 200 elements is part of the Document, don't show all 200 elements, keep max size of such display manageable.
  Example:

doc.schema_summary() to display the Document's schema

For DocumentArray:

schema and length
redundant fields for v2:
- Homogenous Documents
- Common Attributes, instead show the schema
- Multimodal dataclass

samsja · 2023-01-20T12:33:32Z

@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

docarray/base_document/document.py

anna-charlotte · 2023-01-23T15:16:12Z

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.

docarray/math/helper.py

docarray/base_document/mixins/plot.py

JohannesMessner · 2023-01-24T13:47:54Z

@anna-charlotte could you please link this PR/Issue to the dev roadmap and tick it off once merged?

JohannesMessner

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 <[email protected]>

github-actions · 2023-01-25T13:12:14Z

📝 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 <[email protected]> * fix: wip plot Signed-off-by: anna-charlotte <[email protected]> * fix: wip plot Signed-off-by: anna-charlotte <[email protected]> * fix: wip plot Signed-off-by: anna-charlotte <[email protected]> * feat: add math package and minmax normalize Signed-off-by: anna-charlotte <[email protected]> * fix: summary for document Signed-off-by: anna-charlotte <[email protected]> * chore: update poetry lock after rebase Signed-off-by: anna-charlotte <[email protected]> * fix: move all from plotmixin to base document Signed-off-by: anna-charlotte <[email protected]> * feat: add docs schema summary Signed-off-by: anna-charlotte <[email protected]> * feat: add document array summary Signed-off-by: anna-charlotte <[email protected]> * fix: display doc within doc Signed-off-by: anna-charlotte <[email protected]> * fix: in notebook print docs summary Signed-off-by: anna-charlotte <[email protected]> * fix: move summary from da to abstract da Signed-off-by: anna-charlotte <[email protected]> * fix: get schema for doc Signed-off-by: anna-charlotte <[email protected]> * fix: wip doc summary Signed-off-by: anna-charlotte <[email protected]> * fix: wip clean up Signed-off-by: anna-charlotte <[email protected]> * test: add test for da pretty print Signed-off-by: anna-charlotte <[email protected]> * docs: update note Signed-off-by: anna-charlotte <[email protected]> * docs: add some documentation Signed-off-by: anna-charlotte <[email protected]> * fix: apply samis suggestion Signed-off-by: anna-charlotte <[email protected]> * fix: mypy checks Signed-off-by: anna-charlotte <[email protected]> * fix: move to plot mixin Signed-off-by: anna-charlotte <[email protected]> * fix: remove redundant line Signed-off-by: anna-charlotte <[email protected]> * fix: remove comments Signed-off-by: anna-charlotte <[email protected]> * feat: add schema highlighter Signed-off-by: anna-charlotte <[email protected]> * fix: add plotmixin to mixin init Signed-off-by: anna-charlotte <[email protected]> * fix: adjust da summary Signed-off-by: anna-charlotte <[email protected]> * fix: move minmaxnormalize to comp backend Signed-off-by: anna-charlotte <[email protected]> * fix: remove redundant lines Signed-off-by: anna-charlotte <[email protected]> * fix: add squeeze and detach to comp backend Signed-off-by: anna-charlotte <[email protected]> * fix: apply suggestion from code review Signed-off-by: anna-charlotte <[email protected]> * refactor: rename iterable attrs Signed-off-by: anna-charlotte <[email protected]> * fix: clean up Signed-off-by: anna-charlotte <[email protected]> * fix: import Signed-off-by: anna-charlotte <[email protected]> * fix: iterate over fields instead of annotations Signed-off-by: anna-charlotte <[email protected]> * fix: remove math package since moved to comp backends Signed-off-by: anna-charlotte <[email protected]> * refactor: use single quotes Signed-off-by: anna-charlotte <[email protected]> * fix: apply suggestions from code review Signed-off-by: anna-charlotte <[email protected]> * fix: extract summary to doc summary class Signed-off-by: anna-charlotte <[email protected]> * fix: add pretty print for base document Signed-off-by: anna-charlotte <[email protected]> * fix: use rich capture instead of string io Signed-off-by: anna-charlotte <[email protected]> * fix: add colors for optional and union and use only single quotes Signed-off-by: anna-charlotte <[email protected]> * fix: extract display classes to display package Signed-off-by: anna-charlotte <[email protected]> * fix: make da not optional in da summary Signed-off-by: anna-charlotte <[email protected]> * fix: set _console instead of initializing new one everytime in __str__ Signed-off-by: anna-charlotte <[email protected]> * fix: put console at module level Signed-off-by: anna-charlotte <[email protected]> Signed-off-by: anna-charlotte <[email protected]> Signed-off-by: Joan Fontanals Martinez <[email protected]>

anna-charlotte linked an issue Jan 19, 2023 that may be closed by this pull request

V2: rich display of Document and DocumentArray #1025

Closed

anna-charlotte force-pushed the feat-rich-display branch from 5d453d4 to ca7aadf Compare January 19, 2023 14:58

github-actions bot added size/m area/core area/setup area/testing labels Jan 19, 2023

github-actions bot added the component/array label Jan 23, 2023

anna-charlotte force-pushed the feat-rich-display branch from 15b6e0a to b5923ad Compare January 23, 2023 13:16

samsja reviewed Jan 23, 2023

View reviewed changes

docarray/base_document/document.py Outdated Show resolved Hide resolved

anna-charlotte commented Jan 23, 2023

View reviewed changes

docarray/base_document/document.py Outdated Show resolved Hide resolved

anna-charlotte closed this Jan 23, 2023

anna-charlotte reopened this Jan 23, 2023

anna-charlotte requested review from JohannesMessner and samsja January 23, 2023 15:28

github-actions bot added size/l size/m and removed size/m size/l labels Jan 23, 2023

samsja reviewed Jan 24, 2023

View reviewed changes

docarray/math/helper.py Outdated Show resolved Hide resolved

samsja reviewed Jan 24, 2023

View reviewed changes

docarray/base_document/mixins/plot.py Outdated Show resolved Hide resolved

samsja reviewed Jan 24, 2023

View reviewed changes

docarray/base_document/mixins/plot.py Outdated Show resolved Hide resolved

anna-charlotte force-pushed the feat-rich-display branch from 4592694 to 181b5a9 Compare January 24, 2023 10:32

github-actions bot added size/l and removed size/m labels Jan 24, 2023

anna-charlotte commented Jan 24, 2023

View reviewed changes

docarray/base_document/mixins/plot.py Outdated Show resolved Hide resolved

anna-charlotte marked this pull request as ready for review January 24, 2023 13:43

JohannesMessner approved these changes Jan 24, 2023

View reviewed changes

anna-charlotte added 24 commits January 25, 2023 14:06

fix: remove redundant line

58229aa

Signed-off-by: anna-charlotte <[email protected]>

fix: remove comments

e55ba3b

Signed-off-by: anna-charlotte <[email protected]>

feat: add schema highlighter

147742d

Signed-off-by: anna-charlotte <[email protected]>

fix: add plotmixin to mixin init

59bd3a6

Signed-off-by: anna-charlotte <[email protected]>

fix: adjust da summary

fd26a43

Signed-off-by: anna-charlotte <[email protected]>

fix: move minmaxnormalize to comp backend

675b5c5

Signed-off-by: anna-charlotte <[email protected]>

fix: remove redundant lines

a375d19

Signed-off-by: anna-charlotte <[email protected]>

fix: add squeeze and detach to comp backend

c3b44bd

Signed-off-by: anna-charlotte <[email protected]>

fix: apply suggestion from code review

0d5653c

Signed-off-by: anna-charlotte <[email protected]>

refactor: rename iterable attrs

6d479ab

Signed-off-by: anna-charlotte <[email protected]>

fix: clean up

a1c4678

Signed-off-by: anna-charlotte <[email protected]>

fix: import

3aac1c9

Signed-off-by: anna-charlotte <[email protected]>

fix: iterate over fields instead of annotations

eb75060

Signed-off-by: anna-charlotte <[email protected]>

fix: remove math package since moved to comp backends

3cc1b55

Signed-off-by: anna-charlotte <[email protected]>

refactor: use single quotes

ab585eb

Signed-off-by: anna-charlotte <[email protected]>

fix: apply suggestions from code review

b838ec9

Signed-off-by: anna-charlotte <[email protected]>

fix: extract summary to doc summary class

c56aa6e

Signed-off-by: anna-charlotte <[email protected]>

fix: add pretty print for base document

b2b5bdd

Signed-off-by: anna-charlotte <[email protected]>

fix: use rich capture instead of string io

7aa7e58

Signed-off-by: anna-charlotte <[email protected]>

fix: add colors for optional and union and use only single quotes

2ae8d6a

Signed-off-by: anna-charlotte <[email protected]>

fix: extract display classes to display package

0b881b1

Signed-off-by: anna-charlotte <[email protected]>

fix: make da not optional in da summary

6ba4eff

Signed-off-by: anna-charlotte <[email protected]>

fix: set _console instead of initializing new one everytime in __str__

a70142a

Signed-off-by: anna-charlotte <[email protected]>

fix: put console at module level

2a6bd5c

Signed-off-by: anna-charlotte <[email protected]>

anna-charlotte force-pushed the feat-rich-display branch from 23e3f6a to 2a6bd5c Compare January 25, 2023 13:06

samsja merged commit ac28cf3 into feat-rewrite-v2 Jan 25, 2023

samsja deleted the feat-rich-display branch January 25, 2023 13:22

anna-charlotte mentioned this pull request Feb 20, 2023

DocArray v2 third alpha release note #1153

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(v2): rich display for doc and da#1043

feat(v2): rich display for doc and da#1043
samsja merged 46 commits intofeat-rewrite-v2from
feat-rich-display

anna-charlotte commented Jan 19, 2023 •

edited

Loading

Uh oh!

samsja commented Jan 20, 2023

Uh oh!

Uh oh!

Uh oh!

anna-charlotte commented Jan 23, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JohannesMessner commented Jan 24, 2023

Uh oh!

JohannesMessner left a comment

Uh oh!

github-actions bot commented Jan 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

anna-charlotte commented Jan 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samsja commented Jan 20, 2023

Uh oh!

Uh oh!

Uh oh!

anna-charlotte commented Jan 23, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JohannesMessner commented Jan 24, 2023

Uh oh!

JohannesMessner left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 25, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

anna-charlotte commented Jan 19, 2023 •

edited

Loading