From dc1f1af41beb556b463a745dfb4178274d434008 Mon Sep 17 00:00:00 2001 From: Schmid Timo Date: Mon, 6 Nov 2023 16:17:48 +0100 Subject: [PATCH] docstring update --- climada/util/calibrate/base.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/climada/util/calibrate/base.py b/climada/util/calibrate/base.py index c6d7ef45b..95707dff2 100644 --- a/climada/util/calibrate/base.py +++ b/climada/util/calibrate/base.py @@ -174,10 +174,14 @@ def plot_impf_variability( Args: cost_func_diff (float, optional): Max deviation from optimal cost - function value (as fraction). Defaults to 0.1 (i.e. 10%). + function value (as fraction). Defaults to 0.1 (i.e. 10%). p_space_df (pd.DataFrame, optional): parameter space. Defaults to None. plot_haz (bool, optional): Whether or not to plot hazard intensity - distibution. Defaults to False. + distibution. Defaults to False. + plot_impf_kws (dict, optional): Keyword arguments for impact + function plot. Defaults to None. + plot_hist_kws (dict, optional): Keyword arguments for hazard + intensity distribution plot. Defaults to None. """ # Initialize plot keyword arguments @@ -193,10 +197,10 @@ def plot_impf_variability( # which is defined for the BayesianOptimizerOutput class if not hasattr(self.output,"p_space_to_dataframe"): raise TypeError( - f"To derive the full impact function parameter space, " - f"plot_impf_variability requires BayesianOptimizerOutput " - f"as output attribute, which provides the method " - f"p_space_to_dataframe()." + "To derive the full impact function parameter space, " + "plot_impf_variability() requires BayesianOptimizerOutput " + "as OutputEvaluator.output attribute, which provides the " + "method p_space_to_dataframe()." ) p_space_df = self.output.p_space_to_dataframe()