Skip to content

Commit c24f01c

Browse files
committed
Add section to PerformanceEvaluation docs
1 parent 51552b1 commit c24f01c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/resampling.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,13 @@ pairs are recorded in the `train_test_rows` field of the
468468
aggregated over all train/test pairs, are recorded in `measurement`, a
469469
vector with one entry for each measure (metric) recorded in `measure`.
470470
471+
When displayed, a `PerformanceEvalution` object includes a value under
472+
the heading `1.96*SE`, derived from the standard error of the `per_fold`
473+
entries. This value is suitable for constructing a formal 95%
474+
confidence interval for the given `measurement`. Such intervals should
475+
be interpreted with caution. See, for example, Bates et al.
476+
[2021](https://arxiv.org/abs/2104.00673).
477+
471478
### Fields
472479
473480
These fields are part of the public API of the `PerformanceEvaluation`

0 commit comments

Comments
 (0)