You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update README and "Getting Started" tutorial
Updates the project's documentation to be more user-friendly for new users.
- The main `README.md` has been updated with installation instructions, a clearer "Getting Started" section, and links to the blog and official documentation.
- The "Getting Started" tutorial (`docs/tutorials/getting_started.qmd`) has been restructured to clearly explain and provide examples for the three main use cases: single model evaluation, model comparison, and population comparison.
- All code examples in both the README and the tutorial now use more realistic and intuitive sample data where model predictions are clearly correlated with outcomes, making the visualizations more meaningful.
@@ -54,13 +60,26 @@ Often, you want to compare the performance of several different models on the *s
54
60
For this, you provide `probs` with an entry for each model you want to compare. `reals` will still have a single entry, since the outcome data is the same for all models.
55
61
56
62
```python
57
-
# Generate sample data for three models
63
+
# Generate data for a "Good Model", a "Bad Model", and a "Random Guess"
64
+
# The "Good Model" has a clearer separation of probabilities.
65
+
good_probs_pos = np.random.rand(50) *0.4+0.6# 0.6 to 1.0
66
+
good_probs_neg = np.random.rand(50) *0.4# 0.0 to 0.4
0 commit comments