ploomber / sklearn-evaluation

Machine learning model evaluation made easy: plots, tables, HTML reports, experiment tracking and Jupyter notebook analysis.
https://sklearn-evaluation.ploomber.io
Apache License 2.0
455 stars 54 forks source link

Docs reorganisation #297

Closed neelasha23 closed 1 year ago

neelasha23 commented 1 year ago

Reorganisation of the classification module.

Issue ticket number and link

Closes #283

Checklist before requesting a review


:books: Documentation preview :books:: https://sklearn-evaluation--297.org.readthedocs.build/en/297/

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 4290054029


Totals Coverage Status
Change from base Build 4287965346: 0.0%
Covered Lines: 3118
Relevant Lines: 3429

💛 - Coveralls
neelasha23 commented 1 year ago

Couple of queries:

  1. The optimization section : There are four plots here : Confusion matrix, ROC, feature importances and Grid search results. If we want to shorten this tutorial we can just retain Grid search results plot and remove Confusion matrix, ROC, feature importances and add reference to some other doc for these plots. Currently there isn't an API Reference for RandomForestClassifierGrid so should it be added ?
  2. Since Grid search is now moved to the classification section, the model optimization section now contains Feature Ranking only. Does this need to be here or moved to some other section?

@edublancas

edublancas commented 1 year ago

The optimization section : There are four plots here : Confusion matrix, ROC, feature importances and Grid search results. If we want to shorten this tutorial we can just retain Grid search results plot and remove Confusion matrix, ROC, feature importances and add reference to some other doc for these plots. Currently there isn't an API Reference for RandomForestClassifierGrid so should it be added ?

I agree, let's just keep the grid search results plot. mention that there are other plots available and link to the API docs (we need to create the API docs) so let's create a new sklearn_evaluation.grid section in the docs and put it there. Let's also add some embedded examples in the docstring.

Since Grid search is now moved to the classification section, the model optimization section now contains Feature Ranking only. Does this need to be here or moved to some other section?

Looks like this methods are generic, right? they could be used in classification or regression. If so, I think it's fine to leave them there, we can decide later

neelasha23 commented 1 year ago

Made the changes @edublancas

neelasha23 commented 1 year ago

Made the above changes.

I think you mentioned something about some error in this plot, right?

This was fixed. I think the plots are showing up only when we are calling the from_raw_data method and assigning to a variable. Not sure why this is happening.

@edublancas