google-meridian 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

{google_meridian-1.0.1.dist-info → google_meridian-1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: google-meridian
-Version: 1.0.1
+Version: 1.0.3
 Summary: Google's open source mixed marketing model library, helps you understand your return on investment and direct your ad spend with confidence. 
 Author-email: The Meridian Authors <no-reply@google.com>
 License: 
@@ -236,6 +236,8 @@ Requires-Dist: pylint>=2.6.0; extra == "dev"
 Requires-Dist: pyink; extra == "dev"
 Provides-Extra: colab
 Requires-Dist: psutil; extra == "colab"
+Provides-Extra: and-cuda
+Requires-Dist: tensorflow[and-cuda]<2.17,>=2.16; extra == "and-cuda"
 
 # About Meridian
 
@@ -271,11 +273,19 @@ you understand the differences between these MMM projects.
 Python 3.11 or 3.12 is required to use Meridian. We also recommend using a
 minimum of 1 GPU.
 
-Note: This project has been tested on V100 and T4 GPU using 16 GB of RAM.
+Note: This project has been tested on T4 GPU using 16 GB of RAM.
 
 To install Meridian, run the following command to automatically install the
 latest release from PyPI.
 
+For GPU users (requires CUDA toolchain to already be installed in the system):
+
+```sh
+$ pip install --upgrade google-meridian[and-cuda]
+```
+
+For CPU users:
+
 ```sh
 $ pip install --upgrade google-meridian
 ```
@@ -283,13 +293,22 @@ $ pip install --upgrade google-meridian
 Alternatively, run the following command to install the most recent, unreleased
 version from GitHub.
 
+For GPU users (requires CUDA toolchain to already be installed in the system):
+
+```sh
+$ pip install --upgrade "google-meridian[and-cuda] @ git+https://github.com/google/meridian.git"
+```
+
+For CPU users:
+
 ```sh
 $ pip install --upgrade git+https://github.com/google/meridian.git
 ```
 
 We recommend to install Meridian in a fresh
 [virtual environment](https://virtualenv.pypa.io/en/latest/user_guide.html#quick-start)
-to make sure that correct versions of all the dependencies are installed, as defined in [pyproject.toml](https://github.com/google/meridian/blob/main/pyproject.toml).
+to make sure that correct versions of all the dependencies are installed, as
+defined in [pyproject.toml](https://github.com/google/meridian/blob/main/pyproject.toml).
 
 ## How to use the Meridian library
 
@@ -362,12 +381,13 @@ this.
 
 To cite this repository:
 
-```
+<!-- mdlint off(SNIPPET_INVALID_LANGUAGE) -->
+```BibTeX
 @software{meridian_github,
   author = {Google Meridian Marketing Mix Modeling Team},
   title = {Meridian: Marketing Mix Modeling},
   url = {https://github.com/google/meridian},
-  version = {1.0.0},
+  version = {1.0.3},
   year = {2025},
 }
 ```

{google_meridian-1.0.1.dist-info → google_meridian-1.0.3.dist-info}/RECORD

@@ -1,7 +1,7 @@
-meridian/__init__.py,sha256=NOFLwvQJCCtuy7wTqdzPJ1h2aBhEejUJ_0N8ykNuM5E,714
+meridian/__init__.py,sha256=s6xSABYTSpITfC_qBN0xZkps655MgpI3P_3mzo8HchA,714
 meridian/constants.py,sha256=PhQX3S0b-Odv_bjl1YaO6vnLT4rBomiAcec0789VZNE,14599
 meridian/analysis/__init__.py,sha256=-FooDZ5OzePpyTVkvRoWQx_xBaRR_hjVLny9H8-kkyQ,836
-meridian/analysis/analyzer.py,sha256=tGZQUnq9O-NrpjGd4YmqhQXtj5HCbpxV1PG5lqiwVXM,202495
+meridian/analysis/analyzer.py,sha256=I08vm0wkpvwGYb_MpJFb3nh6uIVqGGkIjtOmvTYWml0,204803
 meridian/analysis/formatter.py,sha256=WpV9O_SznsSfJmx36V8nycXOA1g2nhZ9J5sm7kZ_QIQ,6821
 meridian/analysis/optimizer.py,sha256=4e-SN6WMqBzaEgWDB0sok91N_v5gCdhXfFVyH5f4OWI,72365
 meridian/analysis/summarizer.py,sha256=jzkmUNUy3lztPFcSj6XzGsmx39FqdmmsDzZ_G-g9Idk,17480
@@ -30,8 +30,8 @@ meridian/model/model.py,sha256=y7KxKADR0i9JiTLOAeTRXF8mg2DBDb615B4oG-wEpK4,79228
 meridian/model/prior_distribution.py,sha256=6fqx_XIM0DSQICd65XaSRhelsjvZ4ariBfeyOeoKld8,39075
 meridian/model/spec.py,sha256=xaHxfCLWLnWMAkMy2ouDoqGBHI_4tzzX8AaJOsKdu7Q,8878
 meridian/model/transformers.py,sha256=te3OJixprWLtv7O00a9GZWE4waTS94NNLVo3tWIl1-k,7420
-google_meridian-1.0.1.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-google_meridian-1.0.1.dist-info/METADATA,sha256=Ufpmb2JK76UUdlZYk3279zPpG-hU4gjT9EqlsFnhQiw,21418
-google_meridian-1.0.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-google_meridian-1.0.1.dist-info/top_level.txt,sha256=nwaCebZvvU34EopTKZsjK0OMTFjVnkf4FfnBN_TAc0g,9
-google_meridian-1.0.1.dist-info/RECORD,,
+google_meridian-1.0.3.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+google_meridian-1.0.3.dist-info/METADATA,sha256=SzPsRTObvuc5zbyrPnvGJ_5_YMD6A_UidLA5gWDSwQs,21916
+google_meridian-1.0.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+google_meridian-1.0.3.dist-info/top_level.txt,sha256=nwaCebZvvU34EopTKZsjK0OMTFjVnkf4FfnBN_TAc0g,9
+google_meridian-1.0.3.dist-info/RECORD,,

meridian/__init__.py

@@ -14,7 +14,7 @@
 
 """Meridian API."""
 
-__version__ = "1.0.1"
+__version__ = "1.0.3"
 
 
 from meridian import analysis

meridian/analysis/analyzer.py

@@ -2568,6 +2568,7 @@ class Analyzer:
       aggregate_geos: bool = False,
       aggregate_times: bool = False,
       split_by_holdout_id: bool = False,
+      non_media_baseline_values: Sequence[str | float] | None = None,
       confidence_level: float = constants.DEFAULT_CONFIDENCE_LEVEL,
   ) -> xr.Dataset:
     """Calculates the data for the expected versus actual outcome over time.
@@ -2579,6 +2580,13 @@ class Analyzer:
         are summed over all of the time periods.
       split_by_holdout_id: Boolean. If `True` and `holdout_id` exists, the data
         is split into `'Train'`, `'Test'`, and `'All Data'` subsections.
+      non_media_baseline_values: Optional list of shape (n_non_media_channels,).
+        Each element is either a float (which means that the fixed value will be
+        used as baseline for the given channel) or one of the strings "min" or
+        "max" (which mean that the global minimum or maximum value will be used
+        as baseline for the values of the given non_media treatment channel). If
+        None, the minimum value is used as baseline for each non_media treatment
+        channel.
       confidence_level: Confidence level for expected outcome credible
         intervals, represented as a value between zero and one. Default: `0.9`.
 
@@ -2604,6 +2612,7 @@ class Analyzer:
         aggregate_geos=False,
         aggregate_times=False,
         use_kpi=use_kpi,
+        non_media_baseline_values=non_media_baseline_values,
     )
     baseline = self._mean_and_ci_by_eval_set(
         baseline_expected_outcome,
@@ -2747,32 +2756,35 @@ class Analyzer:
     """Aggregates the incremental outcome of the media channels.
 
     Args:
-      use_posterior: Boolean. If `True` then the posterior distribution is
-        calculated. Otherwise, the prior distribution is calculated.
-      new_data: Optional `DataTensors` object with optional new tensors:
-        `media`, `reach`, `frequency`, `organic_media`, `organic_reach`,
-        `organic_frequency`, `non_media_treatments`, `controls`,
-        `revenue_per_kpi`. If provided, the summary metrics are calculated using
-        the values of the tensors passed in `new_data` and the original values
-        of all the remaining tensors. The new tensors' dimensions must match the
-        dimensions of the corresponding original tensors from
-        `meridian.input_data`. If `None`, the summary metrics are calculated
-        using the original values of all the tensors.
+      use_posterior: Boolean. If `True`, then the incremental outcome posterior
+        distribution is calculated. Otherwise, the prior distribution is
+        calculated.
+      new_data: Optional `DataTensors` container with optional tensors: `media`,
+        `reach`, `frequency`, `organic_media`, `organic_reach`,
+        `organic_frequency`, `non_media_treatments` and `revenue_per_kpi`. If
+        `None`, the incremental outcome is calculated using the `InputData`
+        provided to the Meridian object. If `new_data` is provided, the
+        incremental outcome is calculated using the new tensors in `new_data`
+        and the original values of the remaining tensors. For example,
+        `compute_incremental_outcome_aggregate(new_data=DataTensors(media=new_media))`
+        computes the incremental outcome using `new_media` and the original
+        values of `reach`, `frequency`, `organic_media`, `organic_reach`,
+        `organic_frequency`, `non_media_treatments` and `revenue_per_kpi`. If
+        any of the tensors in `new_data` is provided with a different number of
+        time periods than in `InputData`, then all tensors must be provided with
+        the same number of time periods.
       use_kpi: Boolean. If `True`, the summary metrics are calculated using KPI.
         If `False`, the metrics are calculated using revenue.
-      include_non_paid_channels: Boolean. If `True`, non-paid channels (organic
-        media, organic reach and frequency, and non-media treatments) are
-        included in the summary but only the metrics independent of spend are
-        reported. If `False`, only the paid channels (media, reach and
-        frequency) are included but the summary contains also the metrics
-        dependent on spend. Default: `True`.
+      include_non_paid_channels: Boolean. If `True`, then non-media treatments
+        and organic effects are included in the calculation. If `False`, then
+        only the paid media and RF effects are included.
       non_media_baseline_values: Optional list of shape (n_non_media_channels,).
         Each element is either a float (which means that the fixed value will be
         used as baseline for the given channel) or one of the strings "min" or
         "max" (which mean that the global minimum or maximum value will be used
-        as baseline for the values of the given non_media treatment channel). If
-        None, the minimum value is used as baseline for each non_media treatment
-        channel.
+        as baseline for the scaled values of the given non_media treatments
+        channel). If not provided, the minimum value is used as the baseline for
+        each non_media treatments channel.
       **kwargs: kwargs to pass to `incremental_outcome`, which could contain
         selected_geos, selected_times, aggregate_geos, aggregate_times,
         batch_size.
@@ -2814,6 +2826,7 @@ class Analyzer:
       confidence_level: float = constants.DEFAULT_CONFIDENCE_LEVEL,
       batch_size: int = constants.DEFAULT_BATCH_SIZE,
       include_non_paid_channels: bool = False,
+      non_media_baseline_values: Sequence[str | float] | None = None,
   ) -> xr.Dataset:
     """Returns summary metrics.
 
@@ -2880,6 +2893,13 @@ class Analyzer:
         reported. If `False`, only the paid channels (media, reach and
         frequency) are included but the summary contains also the metrics
         dependent on spend. Default: `False`.
+      non_media_baseline_values: Optional list of shape (n_non_media_channels,).
+        Each element is either a float (which means that the fixed value will be
+        used as baseline for the given channel) or one of the strings "min" or
+        "max" (which mean that the global minimum or maximum value will be used
+        as baseline for the values of the given non_media treatment channel). If
+        None, the minimum value is used as baseline for each non_media treatment
+        channel.
 
     Returns:
       An `xr.Dataset` with coordinates: `channel`, `metric` (`mean`, `median`,
@@ -2924,6 +2944,7 @@ class Analyzer:
         new_data=new_data,
         use_kpi=use_kpi,
         include_non_paid_channels=include_non_paid_channels,
+        non_media_baseline_values=non_media_baseline_values,
         **dim_kwargs,
         **batched_kwargs,
     )
@@ -2932,6 +2953,7 @@ class Analyzer:
         new_data=new_data,
         use_kpi=use_kpi,
         include_non_paid_channels=include_non_paid_channels,
+        non_media_baseline_values=non_media_baseline_values,
         **dim_kwargs,
         **batched_kwargs,
     )
@@ -3115,7 +3137,7 @@ class Analyzer:
           **batched_kwargs,
           # Drop mROI metric values in the Dataset's data_vars for the
           # aggregated "All Paid Channels" channel dimension value.
-          # "Marginal ROI"calculation must arbitrarily assume how the
+          # "Marginal ROI" calculation must arbitrarily assume how the
           # "next dollar" of spend is allocated across "All Paid Channels" in
           # this case, which may cause confusion in Meridian model and does not
           # have much practical usefulness, anyway.
@@ -3256,6 +3278,7 @@ class Analyzer:
       selected_times: Sequence[str] | None = None,
       aggregate_geos: bool = True,
       aggregate_times: bool = True,
+      non_media_baseline_values: Sequence[float | str] | None = None,
       confidence_level: float = constants.DEFAULT_CONFIDENCE_LEVEL,
       batch_size: int = constants.DEFAULT_BATCH_SIZE,
   ) -> xr.Dataset:
@@ -3270,6 +3293,13 @@ class Analyzer:
         all of the regions.
       aggregate_times: Boolean. If `True`, the expected outcome is summed over
         all of the time periods.
+      non_media_baseline_values: Optional list of shape (n_non_media_channels,).
+        Each element is either a float (which means that the fixed value will be
+        used as baseline for the given channel) or one of the strings "min" or
+        "max" (which mean that the global minimum or maximum value will be used
+        as baseline for the values of the given non_media treatment channel). If
+        None, the minimum value is used as baseline for each non_media treatment
+        channel.
       confidence_level: Confidence level for media summary metrics credible
         intervals, represented as a value between zero and one.
       batch_size: Integer representing the maximum draws per chain in each
@@ -3345,13 +3375,19 @@ class Analyzer:
 
     baseline_expected_outcome_prior = tf.expand_dims(
         self._calculate_baseline_expected_outcome(
-            use_posterior=False, use_kpi=use_kpi, **outcome_kwargs
+            use_posterior=False,
+            use_kpi=use_kpi,
+            non_media_baseline_values=non_media_baseline_values,
+            **outcome_kwargs,
         ),
         axis=-1,
     )
     baseline_expected_outcome_posterior = tf.expand_dims(
         self._calculate_baseline_expected_outcome(
-            use_posterior=True, use_kpi=use_kpi, **outcome_kwargs
+            use_posterior=True,
+            use_kpi=use_kpi,
+            non_media_baseline_values=non_media_baseline_values,
+            **outcome_kwargs,
         ),
         axis=-1,
     )