Struct SweepOptions 

#[non_exhaustive]
pub struct SweepOptions {
    pub concurrency: Concurrency,
    pub memory_budget: Option<u64>,
    pub gpu_memory_budget: Option<u64>,
    pub control: SweepControl,
    pub shard: Shard,
    pub resume: bool,
    pub retry_failed: bool,
    pub spec_source: SpecSource,
    pub provenance: Provenance,
    /* private fields */
}

Settings of a sweep that never change its results.

Self::new returns the defaults, and a caller sets the other fields by assignment. A spec file’s [execution] table goes in through Self::apply_execution, before the caller’s own settings.

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, as CPU lanes or GPU tracks.

memory_budget: Option<u64>

Host memory budget in bytes for all live runs together, None for no limit. The lanes are sized from the probed run, and a probed run larger than the budget leaves one lane.

gpu_memory_budget: Option<u64>

Device memory budget in bytes for all live GPU runs together, None for the device’s largest buffer. A run larger than the budget runs alone.

control: SweepControl

Switch that pauses or aborts the sweep from another thread.

shard: Shard

Share of the plan’s runs that this sweep executes.

resume: bool

Whether to add to a directory that holds runs of the same plan, running only the runs it lacks.

A directory that holds no results starts afresh, and so does a sweep held in memory.

retry_failed: bool

Whether a resume reruns the runs that ended on a fault. A run that timed out always runs again.

Note that a sweep held in memory resumes nothing, so no run runs again.

spec_source: SpecSource

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

provenance: Provenance

Build of the host and its command line, for the manifest.

Implementations

impl SweepOptions

pub fn new(provenance: Provenance) -> Self

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

pub fn apply_execution(&mut self, execution: &ExecutionTable)

Copies the concurrency and memory settings of a spec’s [execution] table into the options.

Note that this overwrites all three. A caller with its own settings applies the table first and those settings after it.

Trait Implementations

impl Clone for SweepOptions

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 SweepOptions

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

Formats the value using the given formatter.