Blocker: Decomposition vs return_components

[tennlee]

@durgals, @nicholasloveday. I have noticed that kge uses the argument "return_components" to indicate that the various terms should be returned as a part of the score. By contrast, the various crps_for_ensembles methods use the argument "decomposition" to indicate that the various terms should be returned as a part of the score.

It would be better to be consistent across our scores in naming the argument.

I don't have any preference for which name to use. Is it important in either case what this argument is called exactly? I can go through and do the renaming, but before I proceed I'll need to hear back whether it mattes if I rename it. For example, if the literature refers to a "decomposition" or a "components", we might need to be consistent with the literature even if that means we have to use different argument names in different places in the scores codebase.

[tennlee]

Further, the existing crps_cdf method uses "include_components" for the same purpose. Should all the new scores use "include_components" as the argument name? Otherwise, crps_cdf should also be updated to match whatever we decide is the best name for consistency. Changing this name in crps_cdf would be regarded as a "breaking change" and require an update to the major version number, to flag to people their code may break. We could also issue a deprecation warning for a few versions, and could in principle support multiple optional arguments for the same purpose.

The easiest path is to use "include_components" in all cases. Hopefully there aren't any other synonyms lurking in the current releases.

[nicholasloveday]

I'm happy to use "include_components" in all cases. I can update the twCRPS for ensembles if needed.

[tennlee]

Thanks Nick.

@durgals - are you happy if kge is changed to use "include_components" as the argument name instead of "return_components"?

[durgals]

p

Thanks @tennlee : Yes, I am happy with the changes.

[tennlee]

Great, thank you both. Nick - feel free to go ahead and make the changes in your code or across the board. Otherwise I will get to it as soon as practicable.