Repository navigation
docs: update browser summary report documentation and docstrings - #425
Conversation
Update user_guide/06-summary-reports.qmd and public docstrings for create_summary_report(), create_summary_report_times(), and create_probs_histogram() to reflect the current 6-section static browser report, 5-section time-dependent browser report, offline self-contained HTML packaging model, and updated neutral terminology without altering any statistical behavior, schemas, or public API contracts. Co-authored-by: uriahf <11351434+uriahf@users.noreply.github.com>
|
👋 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 New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
…er parameter - Add user-facing prose to create_summary_report_times() docstring documenting its 5 top-level report sections (Event Probability, Calibration, Discrimination, Utility, Performance Table) and intentional omissions relative to static reports. - Clarify in user_guide/06-summary-reports.qmd that renderer="browser" is an opt-in parameter for create_summary_report(), whereas create_summary_report_times() generates browser summary reports directly. Co-authored-by: uriahf <11351434+uriahf@users.noreply.github.com>
FOCUSED DOCUMENTATION TASK — UPDATE PYTHON SUMMARY REPORT DOCUMENTATION
Summary of Changes:
user_guide/06-summary-reports.qmd:create_summary_report(..., renderer="browser")with six top-level sections in exact order: Prevalence, Prediction Distribution, Calibration, Discrimination, Utility, Performance Table.rtichoke_viz v0.5.0with version-neutral wording referencing the vendored immutablertichoke_vizrenderer.create_summary_report_times()section describing its five top-level sections (Event Probability, Calibration, Discrimination, Utility, Performance Table) and intentional omissions (no Prevalence, no Prediction Distribution, no AUROC summary metric).Public Docstrings (
src/rtichoke/summary_report/summary_report.py&src/rtichoke/probs_distribution.py):create_summary_report()docstring to describe the 6 top-level static report sections.create_probs_histogram()docstring to replacerisk percentile rank distributionsandPPCR / Risk Percentilewith neutralprediction percentile rank distributionsandPPCRterminology.Obsolete Statements Removed:
rtichoke_viz v0.5.0hard-coded version tag.Risk Percentileterminology in public docstrings and guide.Preserved Scope Boundaries:
_event_risk_summary_metrics_spec,event_risk,event-risk, andcompeting_heuristic.Verification Results:
uv run pytest: 389 passed, 12 skipped.#Correct#.PR created automatically by Jules for task 2034281685793898620 started by @uriahf