The purpose of the renaming is to better reflect when/why to call the functions instead of focusing too much on technical details, which are likely of less interest to the user.
The old names are kept as aliases but are marked as deprecated. Using them will trigger a FutureWarning.
BREAKING: I used this occasion to remove the following options from initialize_job/read_params_from_cmdline:
make_immutable: Parameters are always immutable now. If one really needs a mutable structure, this is still possible by copying the data.
save_params: It simply always saves now.
Let me know if you think this is a problem, then I'll undo that part.
Generally, I'd like to remove the direct smart_settings options, so the cluster_utils API is not directly dependent on the configuration parser that is used. dynamic is still there, as I wasn't sure what it is doing. Are there use-cases where one would want to set it to False, or could I remove that as well?
Rename
read_params_from_cmdlinetoinitialize_job, andsave_metrics_paramstofinalize_job.as discussed in https://github.com/martius-lab/cluster_utils/pull/99#discussion_r1634365846
The purpose of the renaming is to better reflect when/why to call the functions instead of focusing too much on technical details, which are likely of less interest to the user.
The old names are kept as aliases but are marked as deprecated. Using them will trigger a FutureWarning.
BREAKING: I used this occasion to remove the following options from
initialize_job/read_params_from_cmdline:make_immutable: Parameters are always immutable now. If one really needs a mutable structure, this is still possible by copying the data.save_params: It simply always saves now.Let me know if you think this is a problem, then I'll undo that part. Generally, I'd like to remove the direct
smart_settingsoptions, so the cluster_utils API is not directly dependent on the configuration parser that is used.dynamicis still there, as I wasn't sure what it is doing. Are there use-cases where one would want to set it to False, or could I remove that as well?Do not merge before
106