docs: update create_summary_report_times docstring and clarify renderer 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>

Author: google-labs-jules[bot]

src/rtichoke/summary_report/summary_report.py

@@ -78,6 +78,20 @@ def create_summary_report_times(
 ) -> Path:
     """Create a canonical browser time-dependent model-performance summary report.
 
+    The generated time-dependent browser report contains five top-level sections:
+
+    1. Event Probability
+    2. Calibration
+    3. Discrimination
+    4. Utility
+    5. Performance Table
+
+    Compared with the static browser Summary Report, it intentionally omits:
+
+    * Prevalence section (replaced by Event Probability over time);
+    * Prediction Distribution section;
+    * AUROC summary metric.
+
     Parameters
     ----------
     probs : Dict[str, np.ndarray]
@@ -92,7 +106,8 @@ def create_summary_report_times(
         List of heuristic configurations for censoring and competing events.
         Defaults to ``[{"censoring_heuristic": "adjusted", "competing_heuristic": "adjusted_as_negative"}]``.
     by : float, optional
-        Step size for probability thresholds / PPCR. Defaults to 0.01.
+        Step size for probability thresholds / Predicted Positives Condition Rate (PPCR).
+        Defaults to 0.01.
     output_file : str or pathlib.Path, optional
         HTML destination file path. Defaults to ``"summary_report_times.html"``.
 

user_guide/06-summary-reports.qmd

@@ -91,4 +91,4 @@ The time-dependent summary report intentionally differs from the binary static r
 * **No Prediction Distribution section**: Prediction distribution histograms are omitted in time-dependent reports.
 * **No AUROC summary metric**: AUROC summary metric cards are omitted in time-dependent reports.
 
-The browser backend does not replace Quarto or the historical R backend, and `renderer="browser"` is an opt-in path. Existing Plotly, Matplotlib, table, and standalone browser-chart APIs remain unchanged.
+The browser backend does not replace Quarto or the historical R backend. `renderer="browser"` is an explicit opt-in parameter for `create_summary_report()`, whereas `create_summary_report_times()` generates a browser summary report directly without requiring a `renderer` argument. Existing Plotly, Matplotlib, table, and standalone browser-chart APIs remain unchanged.