Skip to content

Commit

Permalink
Adding Experimental note
Browse files Browse the repository at this point in the history
  • Loading branch information
cetagostini committed Sep 29, 2023
1 parent 975a89d commit cef8c86
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions pymc_marketing/mmm/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -617,7 +617,7 @@ def plot_budget_scenearios(
self, *, base_data: Dict, method: str, **kwargs
) -> plt.Figure:
"""
Plots the budget and contribution bars side by side for multiple scenarios.
Experimental: Plots the budget and contribution bars side by side for multiple scenarios.
Parameters
----------
Expand Down Expand Up @@ -842,7 +842,7 @@ def optimize_channel_budget_for_maximum_contribution(
parameters: Dict[str, Tuple[float, float]],
) -> pd.DataFrame:
"""
Optimize the allocation of a given total budget across multiple channels to maximize the expected contribution.
Experimental: Optimize the allocation of a given total budget across multiple channels to maximize the expected contribution.
The optimization is based on the method provided, where each channel's contribution
follows a saturating function of its allocated budget. The function seeks the budget allocation
Expand Down Expand Up @@ -896,7 +896,7 @@ def compute_channel_curve_optimization_parameters_original_scale(
self, method: str
) -> Dict:
"""
Estimate the parameters for the saturating function of each channel's contribution.
Experimental: Estimate the parameters for the saturating function of each channel's contribution.
The function estimates the parameters (alpha, constant) for each channel based on the specified method (either 'sigmoid' or 'michaelis-menten').
These parameters represent the maximum possible contribution (alpha) and the constant parameter which vary their definition based on the function (constant) for each channel.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ maintainers = [{ name = "PyMC Labs", email = "[email protected]" }]
dependencies = [
"arviz>=0.13.0",
"matplotlib>=3.5.1",
"numpy>=1.17,<1.25",
"numpy>=1.17",
"pandas",
# NOTE: Keep minimum pymc version in sync with ci.yml `OLDEST_PYMC_VERSION`
"pymc>=5.8.2",
Expand Down

0 comments on commit cef8c86

Please sign in to comment.