Result

The pypesto.Result object contains all results generated by the pypesto components. It contains sub-results for optimization, profiles, sampling.

class pypesto.result.OptimizeResult

Bases: object

Result of the minimize() function.

__init__()

Initialize self. See help(type(self)) for accurate signature.

append(optimizer_result: pypesto.optimize.result.OptimizerResult)

Append an optimizer result to the result object.

Parameters

optimizer_result – The result of one (local) optimizer run.

as_dataframe(keys=None) → pandas.core.frame.DataFrame

Get as pandas DataFrame. If keys is a list, return only the specified values.

as_list(keys=None) → Sequence

Get as list. If keys is a list, return only the specified values.

Parameters

keys (list(str), optional) – Labels of the field to extract.

get_for_key(key) → list

Extract the list of values for the specified key as a list.

sort()

Sort the optimizer results by function value fval (ascending).

class pypesto.result.ProfileResult

Bases: object

Result of the profile() function.

It holds a list of profile lists. Each profile list consists of a list of ProfilerResult objects, one for each parameter.

__init__()

Initialize self. See help(type(self)) for accurate signature.

append_empty_profile_list() → int

Append an empty profile list to the list of profile lists.

Returns

The index of the created profile list.

Return type

index

append_profiler_result(profiler_result: Optional[pypesto.profile.result.ProfilerResult] = None, profile_list: int = None) → None

Append the profiler result to the profile list.

Parameters

• profiler_result – The result of one profiler run for a parameter, or None if to be left empty.

• profile_list – Index specifying the profile list to which we want to append. Defaults to the last list.

get_profiler_result(i_par: int, profile_list: int = None) → pypesto.profile.result.ProfilerResult

Get theprofiler result at parameter index i_par of profile list profile_list.

Parameters

• i_par – Integer specifying the profile index.

• profile_list – Index specifying the profile list. Defaults to the last list.

set_profiler_result(profiler_result: pypesto.profile.result.ProfilerResult, i_par: int, profile_list: int = None) → None

Write a profiler result to the result object at i_par of profile list profile_list.

Parameters

• profiler_result – The result of one (local) profiler run.

• i_par – Integer specifying the parameter index.

• profile_list – Index specifying the profile list. Defaults to the last list.

class pypesto.result.Result(problem=None)

Bases: object

Universal result object for pypesto. The algorithms like optimize, profile, sample fill different parts of it.

problem

The problem underlying the results.

Type

pypesto.Problem

optimize_result

The results of the optimizer runs.

profile_result

The results of the profiler run.

sample_result

The results of the sampler run.

__init__(problem=None)

Initialize self. See help(type(self)) for accurate signature.

class pypesto.result.SampleResult

Bases: object

Result of the sample() function.

__init__()

Initialize self. See help(type(self)) for accurate signature.

pypesto.result.Sequence

The central part of internal API.

This represents a generic version of type ‘origin’ with type arguments ‘params’. There are two kind of these aliases: user defined and special. The special ones are wrappers around builtin collections and ABCs in collections.abc. These must have ‘name’ always set. If ‘inst’ is False, then the alias can’t be instantiated, this is used by e.g. typing.List and typing.Dict.

alias of Sequence