Struct SweepRunOptions 

#[non_exhaustive]
pub struct SweepRunOptions {
    pub concurrency: Concurrency,
    pub memory_budget: Option<u64>,
    pub gpu_memory_budget: Option<u64>,
    pub retry_failed: bool,
    pub series_budget: usize,
    pub spec_source: SpecSource,
    pub provenance: Provenance,
    pub wake: Option<WakeFn>,
}

Settings of a sweep that a SweepRun runs. None of them change its results.

Self::new returns the defaults, and a caller sets the other fields by assignment. A spec file’s [execution] settings go in before the caller’s settings, in the order SweepOptions::apply_execution sets them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

concurrency: Concurrency

Number of runs stepped at once on native. A browser steps one run at a time regardless of this setting.

memory_budget: Option<u64>

Host memory budget in bytes for all live runs together, None for no limit.

gpu_memory_budget: Option<u64>

GPU memory budget in bytes for all live runs of a GPU model together, None for the device’s largest buffer.

retry_failed: bool

Whether a resume reruns the runs that ended on a fault.

series_budget: usize

Maximum total size in bytes of the series that the SweepEvent::RunFinished events carry.

Once a run’s series would pass it, that run and every later one arrive without their series. The files keep every series.

spec_source: SpecSource

Spec file the sweep was read from, for the manifest.

provenance: Provenance

Build of the host, for the manifest.

wake: Option<WakeFn>

Called after each event, so that an idle host wakes up to collect it. It must not block.

Implementations

impl SweepRunOptions

pub fn new(provenance: Provenance) -> Self

Returns the options at their defaults, recording provenance in every manifest the sweep writes.

Trait Implementations

impl Clone for SweepRunOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SweepRunOptions

Prints whether a wake callback is set, instead of the callback.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.