cleanvision icon indicating copy to clipboard operation
cleanvision copied to clipboard

Extend `report()` to produce nicely formatted summary cards

Open jwmueller opened this issue 2 years ago • 12 comments

The cards should summarize the issues in a dataset like from the CleanVision blogpost: https://cleanlab.ai/blog/cleanvision/

Here's an example of a desired output from Caltech-256: Screen Shot 2023-03-22 at 9 29 20 AM

jwmueller avatar Mar 22 '23 16:03 jwmueller

Thanks @anishathalye for the suggestion!

jwmueller avatar Mar 22 '23 16:03 jwmueller

Could I be assigned/look into this?

addison-ch avatar Apr 04 '23 19:04 addison-ch

Hi @addison-ch Yes would be awesome to have your help on this! Hopefully the task is clear. Figuring out how to get a nice layout like this for an arbitrary dataset with arbitrary numbers of each types of issue will be a fun problem to think about :D

jwmueller avatar Apr 04 '23 20:04 jwmueller

Okay thanks, I am very new to this project and open source in general, so apologies if it takes a while to get set up or if I have a bunch of questions later on

addison-ch avatar Apr 04 '23 20:04 addison-ch

No worries, excited to have your help! FYI you may find it easier to start with this issue: https://github.com/cleanlab/cleanvision/issues/135

to get an idea of how the plotting code works in different environments.

jwmueller avatar Apr 04 '23 20:04 jwmueller

Is it okay for me to work on it even if someone is already assigned? Or did you mean to just take a look at what the issue might involve?

addison-ch avatar Apr 04 '23 20:04 addison-ch

You can start working on it, there's no one assigned or has started working on it as of now.

sanjanag avatar Apr 04 '23 20:04 sanjanag

Okay awesome, thanks!

addison-ch avatar Apr 04 '23 20:04 addison-ch

Some useful links that I used to put together the collage in the issue. https://note.nkmk.me/en/python-pillow-square-circle-thumbnail/ https://note.nkmk.me/en/python-pillow-concat-images/

Let me know if you need any other help.

sanjanag avatar Apr 04 '23 20:04 sanjanag

To run the example script, setup the python environment as shown in development guide and run python examples/run.py --path <path_to_dataset>

sanjanag avatar Apr 04 '23 20:04 sanjanag

Hello! I am new to cleanlab and would be happy to work on this issue. Is anyone already working on it?

Also to get myself familiar with code and cleanvision, I want to run the example script as guided in above comment. But couldn't find the file.

Update: I have found the new examples script file.

manulpatel avatar May 05 '23 06:05 manulpatel

Hi @manulpatel ! Great to see your interest in contributing. Right now there's no one working on this issue. However, it might be easier to get started with this visualization issue https://github.com/cleanlab/cleanvision/issues/122 before diving into constructing summary cards. Here are some more issues that you could help with: https://github.com/cleanlab/cleanvision/issues/90 https://github.com/cleanlab/cleanvision/issues/130 https://github.com/cleanlab/cleanvision/issues/124

sanjanag avatar May 09 '23 18:05 sanjanag