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

document upsert_append #314

Closed edublancas closed 1 year ago

edublancas commented 1 year ago

In https://github.com/ploomber/sklearn-evaluation/pull/313, we added an upsert_append method to the SQLiteTracker

we need to add inline examples in the method's docstring, and update the tutorials:

https://sklearn-evaluation.ploomber.io/en/latest/classification/SQLiteTracker_classification.html https://sklearn-evaluation.ploomber.io/en/latest/comparison/SQLiteTracker.html https://sklearn-evaluation.ploomber.io/en/latest/comparison/nn_tracking.html

Sohlar commented 1 year ago

Would you rather have a seperate code block in the documentation for specifically this function, or adjust the current examples to include upsert_append()?

edublancas commented 1 year ago

For this one: https://sklearn-evaluation.ploomber.io/en/latest/comparison/nn_tracking.html

let's modify the calls to .upsert to use .upsert_append

for instructions on writing tutorials, see this: https://github.com/ploomber/contributing/blob/main/documentation/notebooks.md

And let's also create a docstring example so it shows up here: https://sklearn-evaluation.ploomber.io/en/latest/api/SQLiteTracker.html

if you encounter issues, feel free to ask!