Skip to content
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

docs: Add example to showcase EstimatorReport and CrossValidationReport #1156

Merged
merged 133 commits into from
Jan 22, 2025

Conversation

glemaitre
Copy link
Member

@glemaitre glemaitre commented Jan 19, 2025

Build upon #1091
We should merge #1091 to make it easy to review.

This PR revisits the documentation for the EstimatorReport and CrossValidationReport.

The idea is to provide different examples for different purposes:

  • technical section: it is a section to explain more in details some internal for user that might be interested. I think that we should move those inside this specific section because we should have more a pure data science section to only show the added values of our tools on data science
  • use-case section: it is indeed the section to show case our tools on real data. Here we want to show the added value on the data science side.

@glemaitre glemaitre marked this pull request as ready for review January 22, 2025 14:49
@sylvaincom
Copy link
Contributor

Please address this 🙏

#1156 (review)

@glemaitre
Copy link
Member Author

@sylvaincom already done ;)

@glemaitre
Copy link
Member Author

I prefer the use-case to be higher. It should the one thing our user should look at.

MarieS-WiMLDS
MarieS-WiMLDS previously approved these changes Jan 22, 2025
@MarieS-WiMLDS MarieS-WiMLDS merged commit 501ad11 into probabl-ai:main Jan 22, 2025
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants