gemseo.problems.mdo.scalable.data_driven.study.result module#

Scalability study - Result.

class ScalabilityResult(name, id_scaling, id_sample)[source]#

Bases: object

Scalability Result.

Parameters:

  • name (str) -- The name of the scalability result.

  • id_scaling (int) -- The scaling identifier.

  • id_sample (int) -- The sample identifier.

get(algo, algo_options, formulation, formulation_options, scaling, n_calls, n_calls_linearize, n_calls_top_level, n_calls_linearize_top_level, exec_time, status, is_feasible, disc_names, output_names, old_varsizes, new_varsizes)[source]#

Get a scalability result given optimization and scaling strategies.

Parameters:

  • algo (str) -- The name of the optimization algorithm.

  • algo_options (StrKeyMapping) -- The options of the optimization algorithm.

  • formulation (str) -- The name of the MDO formulation.

  • formulation_options (StrKeyMapping) -- The options of the MDO formulation.

  • scaling (StrKeyMapping) -- The scaling strategy.

  • n_calls (Iterable[int]) -- The number of calls per discipline.

  • n_calls_linearize (Iterable[int]) -- The number of linearization per discipline

  • n_calls_top_level (Iterable[int]) -- The number of calls per discipline

  • n_calls_linearize_top_level (Iterable[int]) -- The number of linearizations per discipline.

  • exec_time (float) -- The execution time.

  • status (int) -- The status of the optimization scenario.

  • is_feasible (bool) -- Whether the solution is feasible.

  • disc_names (Sequence[str]) -- The names of the disciplines.

  • output_names (Sequence[str]) -- The names of the outputs.

  • old_varsizes (Mapping[str, int]) -- The sizes of the original variables.

  • new_varsizes (Mapping[str, int]) -- The sizes of the new variables.

Return type:

None

get_file_path(study_directory)[source]#

Return file path.

Parameters:

study_directory (str) -- The study directory name.

Return type:

Path

load(study_directory)[source]#

Load a scalability result from a pickle file.

The file has the same name as the ScalabilityResult instance.

Return type:

None

to_pickle(study_directory)[source]#

Save a scalability result into a pickle file.

The file has the same name as the ScalabilityResult instance.

Parameters:

study_directory (str) -- The study directory name.

Returns:

The path to the result.

Return type:

Path