fitbenchmarking.core.results_output module¶
Functions that create the tables, support pages, figures, and indexes.
-
fitbenchmarking.core.results_output.
create_directories
(options, group_name)¶ Create the directory structure ready to store the results
Parameters: - options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting
- group_name (str) – name of the problem group
Returns: paths to the top level results, group results, support pages, and figures directories
Return type: (str, str, str, str)
-
fitbenchmarking.core.results_output.
create_plots
(options, results, best_results, figures_dir)¶ Create a plot for each result and store in the figures directory
Parameters: - options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting
- results (list of list of fitbenchmarking.utils.fitbm_result.FittingResult) – results nested array of objects
- best_results (list of fitbenchmarking.utils.fitbm_result.FittingResult) – best result for each problem
- figures_dir (str) – Path to directory to store the figures in
-
fitbenchmarking.core.results_output.
create_problem_level_index
(options, table_names, group_name, group_dir, table_descriptions)¶ Generates problem level index page.
Parameters: - options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting
- table_names (list) – list of table names
- group_name (str) – name of the problem group
- group_dir (str) – Path to the directory where the index should be stored
- table_descriptions (dict) – dictionary containing descriptions of the tables and the comparison mode
-
fitbenchmarking.core.results_output.
preproccess_data
(results_per_test)¶ Preprocess data into the right format for printing and find the best result for each problem
Parameters: results_per_test (list of list of fitbenchmarking.utils.fitbm_result.FittingResult) – results nested array of objects Returns: The best result for each problem Return type: list of fitbenchmarking.utils.fitbm_result.FittingResult
-
fitbenchmarking.core.results_output.
save_results
(options, results, group_name, failed_problems, unselected_minimzers)¶ Create all results files and store them. Result files are plots, support pages, tables, and index pages.
Parameters: - options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting
- results (list of list of fitbenchmarking.utils.fitbm_result.FittingResult) – results nested array of objects
- group_name (str) – name of the problem group
- failed_problems (list) – list of failed problems to be reported in the html output
Params unselected_minimzers: Dictionary containing unselected minimizers based on the algorithm_type option
Returns: Path to directory of group results
Return type: str