@fkiraly if cap and floor cols exist in y should the values from the columns be used as growth_cap and growth_floor params and removed from y? Since Prophet expects univariate.

Thank you for the corrections gents. I have noticed another [BUG] while implementing this PR. Will open new issue #2621.

@fkiraly if cap and floor cols exist in y should the values from the columns be used as growth_cap and growth_floor params and removed from y? Since Prophet expects univariate.

No, I think in no case should values from y columns be used as parameters. That would break the unified interface.

See #2626 on the interval_width param. I think it can be removed?

• optional parameter growth_cap needs to be indicated as optional in the docstring. Conditionally non-optional parameter growth_floor should say it is non-optional if growth="logistic" in the docstring.

• growth_cap is conditionally optional if growth="logistic" and growth_floor optionality implied by default=0?

• I think array-like growth_cap and growth_floor do not work? So, docstring should not mention them.

• removed

• we can't change existing default params without deprecation, but I also think interval_width is not used, so I'd leave it or remove it entirely

• reverted to 0

is conditionally optional if growth="logistic" and growth_floor optionality implied by default=0?

Well, docstring needs to make clear that growth_cap is usually optional.
Currently, a reader could think setting growth_cap is mandatory in all cases.

growth_floor: float, default=0
    Growth saturation minimum value.

growth_cap: float, default=None
    Growth saturation maximum aka carrying capacity.
    Conditionally optional: must be specified if `growth="logistic"`.

Is this ok?

Is this ok?

Not sure - is None not ok for growth_cap if growth="logistic"?
Would 1 make sense as a sensible default?

I would also write "Used only if growth="logistic"" for growth_floor.

@k1m190r, are you still working on this?

    growth: str, default="linear"
        String 'linear' or 'logistic' to specify a linear or logistic
        trend. If 'logistic' specified float for 'growth_cap' must be provided.
    growth_floor: float, default=0
        Growth saturation minimum value.
    growth_cap: float, default=None
        Growth saturation maximum aka carrying capacity.
        Conditionally optional: must be float if 'growth="logistic"'.

Ok I think this would be it.

• if growth="linear": both growth_floor and growth_cap` are optional.
• if growth="logistic": growth_floor is still optional (default=0) but growth_cap is not optional and must be non None - float.

makes sense. I would remove the "conditionally optional" in favour of a clearer formulation, since this does not state what the condition is.

Last line, I would change to:

mandatory (float) iff `growth="logistic"`, has no effect and is optional, otherwise (if `growth` is not `"logistic"`)

To growth_floor, I would add:

used only if  `growth="logistic"`, has no effect otherwise (if `growth` is not `"logistic"`)

Done.

    growth: str, default="linear"
        String 'linear' or 'logistic' to specify a linear or logistic
        trend. If 'logistic' specified float for 'growth_cap' must be provided.
    growth_floor: float, default=0
        Growth saturation minimum value.
        Used only if  `growth="logistic"`, has no effect otherwise
        (if `growth` is not `"logistic"`).
    growth_cap: float, default=None
        Growth saturation maximum aka carrying capacity.
        Mandatory (float) iff `growth="logistic"`, has no effect and is optional,
        otherwise (if `growth` is not `"logistic"`).