Skip to content

check_estimator to return structured info #30133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adrinjalali opened this issue Oct 22, 2024 · 0 comments · Fixed by #30149
Closed

check_estimator to return structured info #30133

adrinjalali opened this issue Oct 22, 2024 · 0 comments · Fixed by #30149
Labels
Developer API Third party developer API related

Comments

@adrinjalali
Copy link
Member

From #29951 (comment) (@ogrisel)

Somehow related, side note: maybe check_estimator could be made to return a structured result object that is programmatically introspectable.

This would allow third-party libraries to build and publish a scikit-learn compliance table to be integrated as part of their documentation. In case of XFAILed checks, the reason could be displayed as part of the report.

Currently, users would have to dig into CI logs and grep the pytest output, assuming those projects use the parametrize_with_checks as part of a pytest test suite instead of just calling check_estimator.

Thinking about, we could even start by eating our own dog food: we have no simple summary of all the XFAILed/XPASSed cases for scikit-learn estimators at the moment.

I like the idea, but in order not to forget about it, creating its own issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer API Third party developer API related
1 participant