ENH Extend user guide to include classification report

[BenjaminBossan]

Fixes #103

Description

It is currently already possible to add classification reports to the
model card, but it might not be completely obvious. Therefore, the model
card user guide now includes an example of how to add the classification
report.

Some of the texts in the user guide are rewritten to (hopefully) provide
more clarity and to remove some outdated info.

The model card for plot_model_card.py after the change in this PR can
be seen here.

Implementation

As mentioned, the current code already supports adding the classification
report. However, it is unfortunately necessary to "massage" the report a bit
before it is shown in a useful way. First of all, tabulate cannot parse the
format of the output dict, so we need to go through a DataFrame first. Next, the
"accuracy" key has to be deleted, because it is only a single value, not a
collection, and would otherwise confuse pandas. And finally, the df needs to be
transposed and the index reset. Overall, I'm not sure of this is too hassle for
the user so that we should provide a utility function.

[BenjaminBossan]

@adrinjalali Ready for review.

[adrinjalali]

This looks pretty good, but I'm wondering if we should put tables which have like more than N (maybe 10) rows in a details tag. The hyperparameter search table is rather long.

[BenjaminBossan]

This looks pretty good, but I'm wondering if we should put tables which have like more than N (maybe 10) rows in a details tag. The hyperparameter search table is rather long.

I had an idea regarding detail tags, maybe that would solve the issue (though in a separate PR): How about we add an additional argument to all add_* methods like detail_tag=False. If True, everything that is added is automatically enclosed in a detail tag. That would give the user more control over that, instead of setting arbitrary limits like 10 rows/columns. WDYT?

[adrinjalali]

That sounds good to me, and having it in a separate PR sounds good too.

[adrinjalali]

I'm happy with this. What I have in mind is to have these in our examples, and see their usage, and then figure out a better API to make it easier for users to create a nice modelcard with minimal lines of code kinda thing. Shall I merge?

[BenjaminBossan]

That sounds good to me, and having it in a separate PR sounds good too.
Great, I'll create an issue.

What I have in mind is to have these in our examples, and see their usage, and then figure out a better API to make it easier for users to create a nice modelcard with minimal lines of code kinda thing.

I assume this refers to my comment about how the classification report needs to be massaged to have the right format? If so, I agree.

Shall I merge?
It can be merged from my side.