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

Add html_meta to all doc/.md #327

Closed Sohlar closed 1 year ago

Sohlar commented 1 year ago

Describe your changes

TODO: .rst files

Issue ticket number and link

Partially Closes #290

Checklist before requesting a review


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

idomic commented 1 year ago

@Sohlar tag when ready for review! Also I think the CI is failing on the docs, please fix.

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 4563170126

Warning: This coverage report may be inaccurate.

We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report. To ensure accuracy in future PRs, please see these guidelines. A quick fix for this PR: rebase it; your next report should be accurate.


Files with Coverage Reduction New Missed Lines %
src/sklearn_evaluation/plot/precision_recall.py 1 98.51%
src/sklearn_evaluation/plot/plot.py 2 72.73%
src/sklearn_evaluation/plot/calibration.py 6 93.02%
src/sklearn_evaluation/plot/roc.py 6 95.11%
<!-- Total: 15 -->
Totals Coverage Status
Change from base Build 4469212696: 0.05%
Covered Lines: 3555
Relevant Lines: 3876

💛 - Coveralls
edublancas commented 1 year ago

note that due to an update in jupyter-book, the html_meta has to appear under the myst section: https://github.com/ploomber/contributing/blob/main/documentation/seo.md

Also if you're the formatting tool, ensure you add notebook_metadata_filter: myst to the metadata, otherwise the metadata is deleted (this is a bug we recently discovered)

more info here: https://github.com/ploomber/contributing/blob/main/documentation/notebooks.md

edublancas commented 1 year ago

FYI: the docs started failing due to an unrelated reason https://github.com/ploomber/sklearn-evaluation/issues/329 we can either wait for a fix or merge without a doc preview