Struct SpikeReport
pub struct SpikeReport { /* private fields */ }Expand description
The result of a spike run: the study and the (optional) test-seed report.
The study is handed back so a caller can inspect per-trial fans
(Study::trial_fan) — which is how the
pipeline test proves the common-random-numbers seeds reached the objective.
Implementations§
§impl SpikeReport
impl SpikeReport
pub const fn final_report(&self) -> Option<&FinalReport>
pub const fn final_report(&self) -> Option<&FinalReport>
The final test-seed re-evaluation report, if the stage ran.
pub fn best_tune_value(&self) -> Result<Option<f64>>
pub fn best_tune_value(&self) -> Result<Option<f64>>
The tune-ranked best trial’s aggregate objective, if any trial completed.
This stays tune-ranked even after re-evaluation (the sampler’s view
is a pure function of the tune aggregate); the honest held-out answer is
final_report’s best.
§Errors
Whatever the storage read returns.
pub fn trial_count(&self) -> Result<usize>
pub fn trial_count(&self) -> Result<usize>
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for SpikeReport
impl !RefUnwindSafe for SpikeReport
impl !UnwindSafe for SpikeReport
impl Send for SpikeReport
impl Sync for SpikeReport
impl Unpin for SpikeReport
impl UnsafeUnpin for SpikeReport
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more