diff --git a/orbit/utils/stan.py b/orbit/utils/stan.py index 773e620e..4f8441c3 100644 --- a/orbit/utils/stan.py +++ b/orbit/utils/stan.py @@ -31,7 +31,7 @@ def get_compiled_stan_model( - stan_model_name: str = "", + stan_model_name: str = "", stan_file_path: Optional[str] = None, exe_file_path: Optional[str] = None, force_compile: bool = False, @@ -43,12 +43,12 @@ def get_compiled_stan_model( ---------- stan_model_name : The name of the Stan model to use. Use this for the built in models (dlt, ets, ktrlite, lgt) - stan_file_path : + stan_file_path : The path to the Stan file to use. If not provided, the default is to search for the file in the 'orbit' package. If provided, function will ignore the stan_model_name parameter, and will compile the provide stan_file_path into executable in place (same folder as stan_file_path) - exe_file_path : - The path to the Stan-exe file to use. If not provided, the default is to search for the file + exe_file_path : + The path to the Stan-exe file to use. If not provided, the default is to search for the file in the 'orbit' package. If provided, function will ignore the stan_model_name parameter, and will compile the provide stan_file_path into executable in place (same folder as stan_file_path) Returns @@ -57,7 +57,9 @@ def get_compiled_stan_model( A compiled Stan model. """ if (stan_file_path is not None) or (exe_file_path is not None): - sm = CmdStanModel(stan_file=stan_file, exe_file=exe_file_path, force_compile=force_compile) + sm = CmdStanModel( + stan_file=stan_file, exe_file=exe_file_path, force_compile=force_compile + ) else: # Load orbit included cmdstan models # Some oddities here. if not providing exe_file, CmdStanModel would delete the actual executable file.