Skip to content

docs: update browser summary report documentation and docstrings - #425

Merged
uriahf merged 2 commits into
mainfrom
jules-2034281685793898620-97eb79ce
Sep 17, 2026
Merged

uriahf merged 2 commits into
mainfrom
jules-2034281685793898620-97eb79ce

Conversation

@uriahf

@uriahf uriahf commented Sep 17, 2026

Copy link
Copy Markdown
Owner

FOCUSED DOCUMENTATION TASK — UPDATE PYTHON SUMMARY REPORT DOCUMENTATION

Summary of Changes:

  1. user_guide/06-summary-reports.qmd:

    • Documented current static browser report produced by create_summary_report(..., renderer="browser") with six top-level sections in exact order: Prevalence, Prediction Distribution, Calibration, Discrimination, Utility, Performance Table.
    • Clarified that the Summary Report browser backend produces a single offline, self-contained HTML file with embedded renderer JS/CSS, without claiming this for all standalone components.
    • Replaced hard-coded rtichoke_viz v0.5.0 with version-neutral wording referencing the vendored immutable rtichoke_viz renderer.
    • Added 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).
  2. Public Docstrings (src/rtichoke/summary_report/summary_report.py & src/rtichoke/probs_distribution.py):

    • Updated create_summary_report() docstring to describe the 6 top-level static report sections.
    • Updated create_probs_histogram() docstring to replace risk percentile rank distributions and PPCR / Risk Percentile with neutral prediction percentile rank distributions and PPCR terminology.
  3. Obsolete Statements Removed:

    • rtichoke_viz v0.5.0 hard-coded version tag.
    • Claims that static summary report contains only Performance Table + ROC + calibration.
    • Claims that generated Summary Report HTML requires sibling JS/CSS files.
    • Risk Percentile terminology in public docstrings and guide.
  4. Preserved Scope Boundaries:

    • Zero runtime, statistical, schema, ID, or public API signature changes.
    • Preserved internal statistical identifiers such as _event_risk_summary_metrics_spec, event_risk, event-risk, and competing_heuristic.

Verification Results:

  • uv run pytest: 389 passed, 12 skipped.
  • Code review rating: #Correct#.

PR created automatically by Jules for task 2034281685793898620 started by @uriahf

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>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions

github-actions Bot commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-09-17 09:55 UTC

…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>
@uriahf
uriahf merged commit 3f212d2 into main Sep 17, 2026
7 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.

1 participant