-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Update README and "Getting Started" Tutorial #272
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: Update README and "Getting Started" Tutorial #272
Conversation
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 code example has been corrected to use the proper dictionary format for the `reals` parameter. - 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. This new structure is inspired by the documentation for the R version of `rtichoke`.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
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.
|
the good model doesn't make any sense, it's random. |
Thank you for the feedback. You are correct, the initial examples were not clear. I have updated the code in my latest push to use more realistic and intuitive data for all the examples in both the README and the tutorial, where the 'Good Model' now clearly performs better than random. |
Refines the code examples in the README and "Getting Started" tutorial to use more realistic and intuitive sample data. This addresses feedback that the previous "good model" was indistinguishable from a random one. The new examples now clearly demonstrate a model with predictive power.
|
That's a better example, don't use "good" "bad" jargon Sample data from the dcurves_example.py scriptprobs_dict = { |
That's a great suggestion. I've updated the documentation to remove the 'good'/'bad' jargon and replaced it with neutral names like 'Model A' and 'Model B'. Thank you for the feedback! |
Removes subjective jargon like "good" and "bad" from the model names in the documentation. The examples now use neutral, descriptive names like "Model A" and "Model B" for clarity and professionalism.
|
Don't use np.random.rand at all |
Excellent point. I've removed all calls to |
Replaces all calls to `np.random.rand` in the documentation with small, hardcoded datasets. This makes all code examples fully reproducible, deterministic, and easier for new users to understand at a glance.
This change updates the project's documentation to be more user-friendly for new users. The main README.md has been updated with installation instructions and a clearer "Getting Started" section. The "Getting Started" tutorial in the documentation site has been restructured to clearly explain and provide examples for the three main use cases: single model evaluation, model comparison, and population comparison, mirroring the structure of the R package's documentation.
PR created automatically by Jules for task 17743907015561309458 started by @uriahf