Extend the rich EstimatorReport.help to an HTML representation

[glemaitre]

Right now, EstimatorReport.help shows a tree representation of all available functionalities available for the reporter using rich. However, it will become overwhelming at the time that we add more and more accessors.

Therefore, I think that we should still have rich backend whenever we are in a terminal but we should come with a richer representation with dropdown menu whenever we are in a notebook or IDE environment where we can leverage HTML. It will the UI/UX more enjoyable. I can also foresee to be able to click on a specific method to copy and then paste the access to a specific method of an accessor.

[rouk1]

@anasstarfaoui please see what @glemaitre has implemented so far.

╭─────────── 📓 Tools to diagnose estimator HistGradientBoostingClassifier ───────────╮
│ reporter                                                                            │
│ ├── .metrics 📏                                                                     │
│ │   ├── .accuracy(...)         (↗︎)     - Compute the accuracy score.                │
│ │   ├── .brier_score(...)      (↘︎)     - Compute the Brier score.                   │
│ │   ├── .log_loss(...)         (↘︎)     - Compute the log loss.                      │
│ │   ├── .precision(...)        (↗︎)     - Compute the precision score.               │
│ │   ├── .recall(...)           (↗︎)     - Compute the recall score.                  │
│ │   ├── .roc_auc(...)          (↗︎)     - Compute the ROC AUC score.                 │
│ │   ├── .custom_metric(...)            - Compute a custom metric.                   │
│ │   ├── .report_metrics(...)           - Report a set of metrics for our estimator. │
│ │   └── .plot 🎨                                                                    │
│ │       ├── .precision_recall(...)     - Plot the precision-recall curve.           │
│ │       └── .roc(...)                  - Plot the ROC curve.                        │
│ ├── .cache_predictions(...)            - Force caching of estimator's predictions.  │
│ ├── .clean_cache(...)                  - Clean the cache.                           │
│ └── Attributes                                                                      │
│     ├── .X_test                                                                     │
│     ├── .X_train                                                                    │
│     ├── .y_test                                                                     │
│     ├── .y_train                                                                    │
│     ├── .estimator                                                                  │
│     └── .estimator_name                                                             │
│                                                                                     │
│                                                                                     │
│ Legend:                                                                             │
│ (↗︎) higher is better (↘︎) lower is better                                            │
╰─────────────────────────────────────────────────────────────────────────────────────╯

Branches like metrics, plot will expand in the future. Could you help design a widget ? 🙇🏻

[anasstarfaoui]

Hello!

Some questions:

• Should descriptions be visible immediately or on hover/click?
• What's the expected screen size/environment constraints?
• Do users need to see relationships between different methods?

[anasstarfaoui]

Feedbacks

• On hover : Indication on parameters
• Being able to quickly jump to documentation
• No necessity to see relations there
• Need to be easy to switch to sckit-learn documentation

2 design : 1 for terminal and one UI (HTML)

[sylvaincom]

Thanks, +1