Struct SweepRun 

pub struct SweepRun { /* private fields */ }

Handle on a running sweep or search.

Dropping the handle aborts the sweep. On native it then waits for the sweep’s thread to write its files.

Implementations

impl SweepRun

pub fn start( entry: ModelEntry, gpu: Option<GpuContext>, spec: SweepSpec, output: SweepOutput, options: SweepRunOptions, ) -> Result<Self, SweepStartError>

Plans spec against entry and starts the sweep, or the search when spec has a [search] table, writing its files to output.

gpu is a device the host shares with the sweep, its FaultSink included. Note that the sink holds one fault, and whichever side reads it first takes it. A fault that the sweep takes first ends every live run, whichever side raised it, and a fault that the host takes first leaves the runs going. When gpu is None, the sweep acquires a device on its own thread for a GPU model, sized to the entry’s gpu_needs, and builds entry on it. The manifest records the adapter of a shared device only when its context carries RuntimeInfo, as GpuContext::with_runtime_info attaches it.

Planning happens before this returns. The probe build and the runs happen after it, on native on the sweep’s own thread and in a browser in Self::update.

Errors

Returns SweepStartError when spec specifies a different model, cannot be planned, or targets a GPU model in a browser, when output is a directory that holds results, or when the sweep’s thread cannot start. A device the sweep cannot acquire fails the sweep with a SweepEvent::Failed.

pub fn resume_directory( entry: ModelEntry, gpu: Option<GpuContext>, dir: &Path, options: SweepRunOptions, ) -> Result<Self, SweepStartError>

Available on non-WebAssembly only.

Resumes the sweep whose results the directory dir holds, running only the runs it lacks.

The spec, source and shard come from the directory’s manifest, and the sweep runs as crate::sweep::run_spec resumes a sweep. Note that the execution settings come from options alone. The [execution] table the manifest records is not applied. gpu is the device a GPU model runs on, as in Self::start.

Errors

Returns SweepStartError when another sweep, search or merge is writing to dir, the manifest or its spec cannot be read, the spec specifies a different model or cannot be planned, or the sweep’s thread cannot start. A directory whose runs do not fit the plan, or a device the sweep cannot acquire, fails the sweep with a SweepEvent::Failed.

pub fn plan(&self) -> &Arc<Plan>

Plan of the sweep’s configs and runs, or of a search’s fixed values and actions alone.

pub fn search_plan(&self) -> Option<&Arc<SearchPlan>>

Plan of a search, None for a sweep.

A search’s configs are chosen as it runs. Each config arrives in a SweepEvent::SearchBatchTold, and SearchPlan::replay rebuilds any of its runs.

pub fn pause(&mut self)

Holds every run at its next slice of steps.

pub fn resume(&mut self)

Lets a paused sweep continue.

pub fn abort(&mut self)

Ends the sweep at its next slice of steps, paused runs included. The runs written so far stay in its files.

pub fn is_paused(&self) -> bool

Returns whether the sweep is paused.

pub fn is_ended(&self) -> bool

Returns whether the last event, SweepEvent::Finished or SweepEvent::Failed, has been received.

pub fn update(&mut self, _dt: f64)

Available on non-WebAssembly only.

Steps the sweep within a frame’s budget in a browser. On native the sweep runs on its own thread.

pub fn try_recv(&mut self) -> Option<SweepEvent>

Returns the next event, or None when no event is waiting.

pub fn progress(&self) -> SweepProgress

Returns the progress of the sweep as it stands.

Trait Implementations

impl Debug for SweepRun

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

Formats the value using the given formatter.

impl Drop for SweepRun

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.