update evaluate! docstring

JuliaAI · Apr 25, 2024 · 5bd8f82 · 5bd8f82
1 parent bc55ffd
commit 5bd8f82
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/resampling.jl b/src/resampling.jl
@@ -1000,7 +1000,11 @@ Although `evaluate!` is mutating, `mach.model` and `mach.args` are not mutated.
 
 - `logger` - a logger object (see [`MLJBase.log_evaluation`](@ref))
 
-See also [`evaluate`](@ref), [`PerformanceEvaluation`](@ref)
+- `compact=false` - if `true`, the returned evaluation object excludes these fields:
+  `fitted_params_per_fold`, `report_per_fold`, `train_test_rows`.
+
+See also [`evaluate`](@ref), [`PerformanceEvaluation`](@ref),
+[`CompactPerformanceEvaluation`](@ref).
 
 """
 function evaluate!(