Struct ResultSet 

pub struct ResultSet { /* private fields */ }

Results of one sweep, read from an output directory or from its files’ bytes.

Implementations

impl ResultSet

pub fn open_dir( dir: &Path, series_budget: usize, ) -> Result<Self, ResultSetError>

Available on non-WebAssembly only.

Reads the output directory at dir, holding at most series_budget bytes of series.

Errors

Returns ResultSetError when the manifest or runs.csv is missing or cannot be read, the manifest’s spec cannot be read back or the search it records has a setting out of range, or a complete record of a table is not one the sweep writes.

pub fn from_files( files: Vec<(String, Vec<u8>)>, series_budget: usize, ) -> Result<Self, ResultSetError>

Reads the files files of one output directory, each as its name and bytes, holding at most series_budget bytes of series.

A file is known by its contents, so a browser’s renamed download such as runs (1).csv is still read. The one JSON file is the manifest, and a CSV file is runs.csv, series.csv or a search table by its header. The manifest and runs.csv are needed, series.csv and the search tables are read when present, and every other file is left unread.

Errors

Returns ResultSetError when the manifest or runs.csv is missing or cannot be read, two files hold the same table, the manifest’s spec cannot be read back or the search it records has a setting out of range, or a complete record of a table is not one the sweep writes.

pub fn manifest(&self) -> &Manifest

Manifest as manifest.json holds it.

pub fn recorded_builds(&self, role: BuildRole) -> Vec<RecordedBuild>

Returns every distinct build recorded for role by the manifest’s sessions that wrote runs, in session order, as Manifest::recorded_builds lists them.

A session of a 0.2 manifest records no builds, and is treated as the engine build of its own commit and the manifest’s engine version, with no model build.

pub fn spec(&self) -> &SweepSpec

Spec the sweep ran, as its manifest records it.

pub fn dir(&self) -> Option<&Path>

Directory the files were read from, None for files passed as bytes.

pub fn value_columns(&self) -> &[String]

Names of the parameter and action columns of runs.csv, in order.

Empty when runs.csv has no header yet, as in a directory whose sweep has written no run.

pub fn reducer_columns(&self) -> &[String]

Names of the reducer columns of runs.csv, one per value of a run’s RunOutcome::reducers.

Empty when runs.csv has no header yet.

pub fn stat_columns(&self) -> &[String]

Names of the stat columns of series.csv, one per value of a series row.

pub fn runs(&self) -> &[RunRow]

Runs in the order runs.csv lists them.

pub fn run(&self, run_id: u64) -> Option<&RunRow>

Returns run run_id, or None when runs.csv holds no such run.

pub fn held_series_count(&self) -> usize

Number of runs held with their series.

pub fn is_complete(&self) -> bool

Returns whether the sweep ran every run of its shard.

A directory a sweep left running, aborted or failed, or a merge left incomplete, can be resumed.

pub fn schema_matches(&self, schema: ModelSchema<'_>) -> bool

Returns whether schema declares the parameters, stats and actions the sweep ran with.

A replay of a run through a model that does not match might differ from the run. A host passes entry.schema() for a ModelEntry.

pub fn plan(&self, schema: ModelSchema<'_>) -> Result<Plan, PlanError>

Plans the recorded spec against schema.

Errors

Returns PlanError when the model rejects the spec.

pub fn replay( &self, schema: ModelSchema<'_>, run_id: u64, ) -> Result<Replay, ResultReplayError>

Returns the Replay of run run_id through the model schema declares.

The spec is planned afresh on each call. A host that replays several runs of a sweep plans once with Self::plan and calls Plan::replay. A search’s run is rebuilt from the config its row records.

Errors

Returns ResultReplayError when the model rejects the spec, runs.csv holds no run run_id, or the plan assigns the run a different config, replicate, seed or run key than its row. The run key covers the config’s parameter values and action ticks. It also hashes the model’s declarations, so it is compared only while Self::schema_matches holds for schema.

pub fn is_search(&self) -> bool

Returns whether the results come from a search.

pub fn search_table(&self, file: &str) -> Option<&str>

Returns the text of the search table file, such as evaluations.csv, or None when the results hold no such table.

pub fn search_history(&self) -> Result<Option<SearchHistory>, ResultSetError>

Returns the course of a search batch by batch, from its tables, or None for a sweep.

Errors

Returns ResultSetError::Table when a search table cannot be read.

pub fn read_run_series( &self, run_ids: &BTreeSet<u64>, series_budget: usize, ) -> Result<DirectorySeries, ResultSetError>

Available on non-WebAssembly only.

Reads the whole series of each run of run_ids from the directory the set was read from, while the series fit series_budget bytes, as read_directory_series does.

Errors

Returns ResultSetError::Missing for a set read from bytes, and ResultSetError::Table when series.csv cannot be read or its header does not list the stat columns.

pub fn into_runs(self) -> Vec<RunRow>

Returns the runs in the order runs.csv lists them, and drops the rest of the set.

Trait Implementations

impl Clone for ResultSet

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 ResultSet

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

Formats the value using the given formatter.