docs (EstimatorReport): need to finalize the example in the sphinx-gallery

[glemaitre]

Before 0.6, we need to review and finalize the example presenting the EstimatorReport in the example gallery.

Right now, there are a couple of TODO and some of the features are not presented. We might want to split this bit example into two examples: (i) a data science example and (ii) a more engineer/technical example a bit the insights of this reporter (cache mainly).

• split example
  • one dedicated to data science: the metrics
  • one dedicated to data science: the plots
  • another to tech (including cache)
• describe data set in example (code line). Answer is available in openML.
• Change warning to note (code line) -> docs: Minor changes of the doc examples for v0.6 #1212
• Make sense of the cost sensitive part with the right naming (code line) (cf this issue: docs: Minor fix the doc example about the custom metric #1206)
• minor change in doc “By default, the metrics are computed on the test set only.” (code line) -> docs: Minor changes of the doc examples for v0.6 #1212

[sylvaincom]

EDIT: added to the above

I'm also adding the following:

• describe the dataset using https://www.openml.org/search?type=data&sort=runs&id=42738&status=active
• minor change in doc “By default, the metrics are computed on the test set only.”

[MarieS-WiMLDS]

I started a TODO list to make this issue to ready. I added your points @sylvaincom.
@glemaitre, do you see anything else to add?

[glemaitre]

Closing since we made a new example. We can have new iteration on it.

[sylvaincom]

Indeed, closed by:

• docs: Add example to showcase EstimatorReport and CrossValidationReport #1156
• docs: Refine example plot_employee_salaries #1208
• docs: Refine example plot_cache_mechanism #1211
• docs: Minor changes of the doc examples for v0.6 #1212

This child issue is left to live on its own:

• docs: Minor fix the doc example about the custom metric #1206