Result Set#

Constructor#

ResultSet([results_metadata, params, attrs, ...])

Hold a set of results within their parameter space.

Compute and retrieve#

ResultSet.compute(res_name, params, **add_kwargs)

Compute result res_name for set of parameters params.

ResultSet.get(res_name, params, **add_kwargs)

Get the value of result res_name for set of parameters params.

ResultSet.get_all_computed_values(res_name)

Get a dictionary giving all computed values and their parameters.

ResultSet.get_nth_last_result(res_name[, n])

Get the nth last computed value of result res_name.

ResultSet.get_nth_last_params(res_name[, n])

Get the dictionary of parameters for the nth last computation of res_name.

ResultSet.is_computed(res_name, params)

ResultSet.set(res_name, value, params[, ...])

Set value value for result res_name for set of parameters params.

Input-output#

ResultSet.save(res_name, params[, save_path_fmt])

Save the value of result res_name for set of parameters params.

ResultSet.load(res_name[, params, ...])

Load the value of result res_name for set of parameters params.

ResultSet.get_save_path(res_name, params[, ...])

Get the path at which to save a result for a set of parameter values.

ResultSet.save_path_fmt

Return the default format for the path where to save the results.

ResultSet.set_save_fun(res_name, save_fun)

Set the computing funtion for res_name.

Timing#

ResultSet.get_time(res_name, params)

Get the computing time of result res_name for parameters params.

ResultSet.get_nth_last_time(res_name[, n])

Get the computing time for the nth last computation of result res_name.

ResultSet.get_timing_stats([res_names])

Get the summary statistics of the distirbutions of computing times for results.

ResultSet.rank_longest_to_compute(res_name)

Return the ranking of parameters from longest to compute to shortest.

Accessing the parameter space#

ResultSet.__getitem__()

Get the parameter space for one or a set of the results.

ResultSet.param_space

Parameter space within which the results are computed.

ResultSet.coords

Return the coordinates of the parameter space.

ResultSet.attrs

Return the attributes dictionary of the ResultSet.

ResultSet.populated_mask

ResultSet.populated_space

Parameters manipulation#

ResultSet.parameters

Return the data describing the parameters of the set and their values.

ResultSet.params_defaults

Return a dictionary with the default values of all parameters.

ResultSet.params_values

Return a dictionary with the possible values of all parameters.

ResultSet.coords

Return the coordinates of the parameter space.

ResultSet.fill_with_defaults()

Fill params with the default values of the unspecified parameters.

ResultSet.add_param_values(params_values)

Add new values to existing parameters.

ResultSet.add_params(params)

Add new parameters to the set.

Results manipulation#

ResultSet.results

Return the metadata describing the results of the set.

ResultSet.set_compute_fun(res_name, compute_fun)

Set the computing funtion for res_name.

ResultSet.set_save_fun(res_name, save_fun)

Set the computing funtion for res_name.

ResultSet.add_results(results_metadata)

Add new results to the set.

Create other sets#

ResultSet.get_subspace_res(subspace_params)

Return the subset of the result set for the given parameter values.