fitbenchmarking.utils.fitbm_result module
FitBenchmarking results object
- class fitbenchmarking.utils.fitbm_result.FittingResult(controller: Controller, accuracy: float | list[float] = inf, runtimes: float | list[float] = inf, emissions: float = inf, dataset: Optional[int] = None)
Bases:
objectMinimal definition of a class to hold results from a fitting problem test.
- init_blank()
Initialise a new blank version of the class with the required placeholder values not set during standard initialisation.
- modified_minimizer_name(with_software: bool = False) str
Get a minimizer name which contains jacobian and hessian information. Optionally also include the software.
- Parameters
with_software (bool, optional) – Add software to the name, defaults to False
- Returns
A name for the result combination
- Return type
str
- property norm_acc
Getting function for norm_acc attribute
- Returns
normalised accuracy value
- Return type
float
- property norm_emissions
Getting function for norm_emissions attribute
- Returns
normalised emissions value
- Return type
float
- property norm_runtime
Getting function for norm_runtime attribute
- Returns
normalised runtime value
- Return type
float
- sanitised_min_name(with_software=False)
Sanitise the modified minimizer name into one which can be used as a filename.
- Returns
sanitised name
- Return type
str
- property sanitised_name
Sanitise the problem name into one which can be used as a filename.
- Returns
sanitised name
- Return type
str