Skip to content

api(skore): Revisit the output of the .frame() from .summarize() #1837

@glemaitre

Description

@glemaitre

What would you like to say?

We recently added the .summarize method that create a MetricsSummaryDisplay to align the API of the object. We should now revisit a bit the API of the summarize function and the frame method and specifically the data structure stored in the display.

With the experience gather with the other display, we should store a "long" dataframe in the display because it can accommodate all the different combination of reports. The frame method will have a job to transform this "long" dataframe to a "wide" dataframe whenever possible depending on the case.

In terms of API, we should move the parameter indicator_favorability , flat_index, aggregate as parameter into the frame method because they just modify the structure of the dataframe. We can switch flat_index to True to make it easy to index the dataframe.

Metadata

Metadata

Assignees

Labels

API 🧑‍💻Improvement of the API facing usersfeature 🎁Feature or enhancementready for dev 💻Issue specified enough and ready to be implemented

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions