google-meridian 1.2.1__py3-none-any.whl → 1.3.1__py3-none-any.whl

google_meridian-1.3.1.dist-info/METADATA

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: google-meridian
+Version: 1.3.1
+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>
+Project-URL: homepage, https://github.com/google/meridian
+Project-URL: repository, https://github.com/google/meridian
+Project-URL: changelog, https://github.com/google/meridian/blob/main/CHANGELOG.md
+Project-URL: documentation, https://developers.google.com/meridian
+Keywords: mmm
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Other/Nonlisted Topic
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arviz
+Requires-Dist: altair>=5
+Requires-Dist: immutabledict
+Requires-Dist: joblib
+Requires-Dist: natsort<8,>=7.1.1
+Requires-Dist: numpy<3,>=2.0.2
+Requires-Dist: pandas<3,>=2.2.2
+Requires-Dist: patsy<1,>=0.5.3
+Requires-Dist: scipy<2,>=1.13.1
+Requires-Dist: statsmodels>=0.14.5
+Requires-Dist: tensorflow<2.19,>=2.18
+Requires-Dist: tensorflow-probability<0.26,>=0.25
+Requires-Dist: tf-keras<2.19,>=2.18
+Requires-Dist: xarray
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: pylint>=2.6.0; extra == "dev"
+Requires-Dist: pyink; extra == "dev"
+Provides-Extra: colab
+Requires-Dist: psutil; extra == "colab"
+Requires-Dist: python-calamine; extra == "colab"
+Provides-Extra: and-cuda
+Requires-Dist: tensorflow[and-cuda]<2.19,>=2.18; extra == "and-cuda"
+Provides-Extra: mlflow
+Requires-Dist: mlflow; extra == "mlflow"
+Provides-Extra: jax
+Requires-Dist: jax==0.4.26; extra == "jax"
+Requires-Dist: jaxlib==0.4.26; extra == "jax"
+Requires-Dist: tensorflow-probability[substrates-jax]==0.25.0; extra == "jax"
+Provides-Extra: schema
+Requires-Dist: mmm-proto-schema; extra == "schema"
+Requires-Dist: semver; extra == "schema"
+Dynamic: license-file
+
+# About Meridian
+
+Marketing mix modeling (MMM) is a statistical analysis technique that measures
+the impact of marketing campaigns and activities to guide budget planning
+decisions and improve overall media effectiveness. MMM uses aggregated data to
+measure impact across marketing channels and account for non-marketing factors
+that impact sales and other key performance indicators (KPIs). MMM is
+privacy-safe and does not use any cookie or user-level information.
+
+Meridian is an MMM framework that enables advertisers to set up and run their
+own in-house models. Meridian helps you answer key questions such as:
+
+*   How did the marketing channels drive my revenue or other KPI?
+*   What was my marketing return on investment (ROI)?
+*   How do I optimize my marketing budget allocation for the future?
+
+Meridian is a highly customizable modeling framework that is based on
+[Bayesian causal inference](https://developers.google.com/meridian/docs/causal-inference/bayesian-inference).
+It is capable of handling large scale geo-level data, which is encouraged if
+available, but it can also be used for national-level modeling. Meridian
+provides clear insights and visualizations to inform business decisions around
+marketing budget and planning. Additionally, Meridian provides methodologies to
+support calibration of MMM with experiments and other prior information, and to
+optimize target ad frequency by utilizing reach and frequency data.
+
+If you are using LightweightMMM, see the
+[migration guide](https://developers.google.com/meridian/docs/migrate) to help
+you understand the differences between these MMM projects.
+
+## Install Meridian
+
+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 T4 GPU using 16 GB of RAM.
+
+To install Meridian, run the following command to automatically install the
+latest release from PyPI.
+
+*   For Linux-GPU users:
+
+    Note: CUDA toolchain and a compatible GPU device is necessary for
+    `[and-cuda]` extra to activate.
+
+    ```sh
+    $ pip install --upgrade google-meridian[and-cuda]
+    ```
+
+*   For macOS and general CPU users:
+
+    Note: There is no official GPU support for macOS.
+
+    ```sh
+    $ pip install --upgrade google-meridian
+    ```
+
+Alternatively, run the following command to install the most recent, unreleased
+version from GitHub.
+
+*   For GPU users:
+
+    ```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).
+
+## How to use the Meridian library
+
+To get started with Meridian, you can run the code programmatically using sample
+data with the [Getting Started Colab][3].
+
+The Meridian model uses a holistic MCMC sampling approach called
+[No U Turn Sampler (NUTS)](https://www.tensorflow.org/probability/api_docs/python/tfp/experimental/mcmc/NoUTurnSampler)
+which can be compute intensive. To help with this, GPU support has been
+developed across the library (out-of-the-box) using tensors. We recommend
+running your Meridian model on GPUs to get real time optimization results and
+significantly reduce training time.
+
+## Meridian Documentation & Tutorials
+
+The following documentation, colab, and video resources will help you get
+started quickly with using Meridian:
+
+| Resource                    | Description                                    |
+| --------------------------- | ---------------------------------------------- |
+| [Meridian documentation][1] | Main landing page for Meridian documentation.  |
+| [Meridian basics][2]        | Learn about Meridian features, methodologies, and the model math. |
+| [Getting started colab][3]  | Install and quickly learn how to use Meridian with this colab tutorial using sample data. |
+| [User guide][4]             | A detailed walk-through of how to use Meridian and generating visualizations using your own data. |
+| [Pre-modeling][5]           | Prepare and analyze your data before modeling. |
+| [Modeling][6]               | Modeling guidance for model refinement and edge cases. |
+| [Post-modeling][7]          | Post-modeling guidance for model fit, visualizations, optimizations, refreshing the model, and debugging. |
+| [Migrate from LMMM][8]      | Learn about the differences between Meridian and LightweightMMM as you consider migrating. |
+| [API Reference][9]          | API reference documentation for the Meridian package. |
+| [Reference list][10]        | White papers and other referenced material.    |
+
+[1]: https://developers.google.com/meridian
+[2]: https://developers.google.com/meridian/docs/basics/meridian-introduction
+[3]: https://developers.google.com/meridian/notebook/meridian-getting-started
+[4]: https://developers.google.com/meridian/docs/user-guide/installing
+[5]: https://developers.google.com/meridian/docs/pre-modeling/collect-data
+[6]: https://developers.google.com/meridian/docs/advanced-modeling/control-variables
+[7]: https://developers.google.com/meridian/docs/post-modeling/model-fit
+[8]: https://developers.google.com/meridian/docs/migrate
+[9]: https://developers.google.com/meridian/reference/api/meridian
+[10]: https://developers.google.com/meridian/docs/reference-list
+
+## Support
+
+**Questions about methodology**: Please see the [Modeling](https://developers.google.com/meridian/docs/basics/meridian-introduction) tab in the technical documentation.
+
+**Issues installing or using Meridian**: Feel free to post questions in the
+[Discussions](https://github.com/google/meridian/discussions) or [Issues](https://github.com/google/meridian/issues) tabs of the Meridian GitHub repository. The Meridian team responds to
+these questions weekly in batches, so please be patient and don't reach out
+directly to your Google Account teams.
+
+**Bug reports**: Please post bug reports to the [Issues](https://github.com/google/meridian/issues)
+tab of the Meridian GitHub repository. We also encourage the community to share
+tips and advice with each other on the [Issues](https://github.com/google/meridian/issues)
+tab. When our team addresses or resolves a new bug, we will notify you through
+the comments on the issue.
+
+**Feature requests**: Please post these to the [Discussions](https://github.com/google/meridian/discussions)
+tab of the Meridian GitHub repository. We have an internal roadmap for Meridian
+development, but would love your inputs for new feature requests so that we can
+prioritize them based on the roadmap.
+
+**Pull requests**: These are appreciated but are very difficult for us to merge
+because the code in this repository is linked to Google internal systems and has
+to pass internal review. If you submit a pull request and we believe that we can
+incorporate a change in the base code, we will reach out to you directly about
+this.
+
+## Citing Meridian
+
+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.3.1},
+  year = {2025},
+}
+```

google_meridian-1.3.1.dist-info/RECORD

@@ -0,0 +1,76 @@
+google_meridian-1.3.1.dist-info/licenses/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+meridian/__init__.py,sha256=0fOT5oNZF7-pbiWWGUefV-ysafttieG079m1ijMFQO8,861
+meridian/constants.py,sha256=ZmMIoJDFQvKIOVG9oPOQ7Cj16wt4HDS5fCPBrz_KiLE,20308
+meridian/version.py,sha256=mmCkrGRWB8mI33apVnverT2ysfJofSyhlXSCVNotj9U,644
+meridian/analysis/__init__.py,sha256=NWDhtRkKs-n66C6746rXT7Wk8tLdkrT9NDvuPG_B_5c,874
+meridian/analysis/analyzer.py,sha256=EUKoN69EEz4vt4BpyRvrwEoHt7eLZ8UM6emNe14Tbj0,219975
+meridian/analysis/formatter.py,sha256=AN2M4jdUV88XjNdi5-dK_mITES1J1Dk3Zs7DYo3OTKg,7290
+meridian/analysis/optimizer.py,sha256=RX8HXSUi-tvLSjzF2OIbXQT3pMT75PzA5Y0xK6PPE_I,126277
+meridian/analysis/summarizer.py,sha256=7hHBf2Bj0lKqamg7DGvaKIuCf06CSsPPhDM2wKsXUPk,19035
+meridian/analysis/summary_text.py,sha256=I_smDkZJYp2j77ea-9AIbgeraDa7-qUYyb-IthP2qO4,12438
+meridian/analysis/test_utils.py,sha256=aZq88pxtpMHwhcpfYz8nHhR0Alhi_OvgS9qBR4LBgO0,78346
+meridian/analysis/visualizer.py,sha256=1vjX3XQF_BoXEGDUS4o2GheZQ5c0VGdHuc-nXySnpsY,94091
+meridian/analysis/review/__init__.py,sha256=cF24EbhiVSs-tvtRf59uVin39tu6aCTTCaeEdv6ISZ8,804
+meridian/analysis/review/checks.py,sha256=CBBZ0uNN91b_0H9DGdbDRVdiTRI4D7xptLCq_gK5WAI,25002
+meridian/analysis/review/configs.py,sha256=5JJ8v6n22GNBmE78xNX6jwdjkZz2qar4Q9YTcVqzcoI,3653
+meridian/analysis/review/constants.py,sha256=bL-se2BFfRxPr3F0Rfpdy7d8s3idMoaka_t6hN1K3Sc,1369
+meridian/analysis/review/results.py,sha256=jsOPohmwozCrx8yt9p7_GiVxGmRDVeAbA8W48MUfAPA,16168
+meridian/analysis/review/reviewer.py,sha256=BcfmqHjp-30iZBlrzWfXDN1IJU-UIjINxZ7lsrj5Mts,6675
+meridian/analysis/templates/card.html.jinja,sha256=pv4MVbQ25CcvtZY-LH7bFW0OSeHobkeEkAleB1sfQ14,1284
+meridian/analysis/templates/chart.html.jinja,sha256=87i0xnXHRBoLLxBpKv2i960TLToWq4r1aVQZqaXIeMQ,1086
+meridian/analysis/templates/chips.html.jinja,sha256=t-ovn-2pcPCn1ev1VtSaSC3W7QxSy_iAO_L5-p68mdg,1030
+meridian/analysis/templates/insights.html.jinja,sha256=6hEWipbOMiMzs9QGZ6dcB_73tNkj0ZtNiC8E89a98zg,606
+meridian/analysis/templates/stats.html.jinja,sha256=9hQOG02FX1IHVIvdWS_-LI2bbSaqdyHEtCZkiArwAg0,772
+meridian/analysis/templates/style.css,sha256=RODTWc2pXcG9zW3q9SEJpVXgeD-WwQgzLpmFcbXPhLg,5492
+meridian/analysis/templates/style.scss,sha256=nSrZOpcIrVyiL4eC9jLUlxIZtAKZ0Rt8pwfk4H1nMrs,5076
+meridian/analysis/templates/summary.html.jinja,sha256=LuENVDHYIpNo4pzloYaCR2K9XN1Ow6_9oQOcOwD9nGg,1707
+meridian/analysis/templates/table.html.jinja,sha256=mvLMZx92RcD2JAS2w2eZtfYG-6WdfwYVo7pM8TbHp4g,1176
+meridian/backend/__init__.py,sha256=ftXcdb3tIky_m8exhD9RRhaEqTEvMcqZ8lGkkR1PjsE,39495
+meridian/backend/config.py,sha256=B9VQnhBfg9RW04GNbt7F5uCugByenoJzt-keFLLYEp8,3561
+meridian/backend/test_utils.py,sha256=DYU5IpWiyM26aTY9Q84mOGRw0dQ9XmsZRsAJNFuZDp0,11667
+meridian/data/__init__.py,sha256=StIe-wfYnnbfUbKtZHwnAQcRQUS8XCZk_PCaEzw90Ww,929
+meridian/data/arg_builder.py,sha256=Kqlt88bOqFj6D3xNwvWo4MBwNwcDFHzd-wMfEOmLoPU,3741
+meridian/data/data_frame_input_data_builder.py,sha256=_hexZMFAuAowgo6FaOGElHSFHqhGnHQwEEBcwnT3zUE,27295
+meridian/data/input_data.py,sha256=Qlxm4El6h1SRPsWDqZoKkOcMtrjiRWr3z8sU2mtghRA,43151
+meridian/data/input_data_builder.py,sha256=tbZjVXPDfmtndVyJA0fmzGzZwZb0RCEjXOTXb-ga8Nc,25648
+meridian/data/load.py,sha256=X2nmYCC-7A0RUgmdolTqCt0TD3NEZabQ5oGv-TugE00,40129
+meridian/data/nd_array_input_data_builder.py,sha256=lfpmnENGuSGKyUd7bDGAwoLqHqteOKmHdKl0VI2wCQA,16341
+meridian/data/test_utils.py,sha256=mw-QPTP15oXf32I7cxMe8iSFBLB3seqEiITZMTz_Eg8,59838
+meridian/data/time_coordinates.py,sha256=C5A5fscSLjPH6G9YT8OspgIlCrkMY7y8dMFEt3tNSnE,9874
+meridian/mlflow/__init__.py,sha256=elwXUqPQYi7VF9PYjelU1tydfcUrmtuoq6eJCOnV9bk,693
+meridian/mlflow/autolog.py,sha256=SZsrynLjozcyrAFCNWiqchSa2yOszVnwFBGz23BmWUU,6379
+meridian/model/__init__.py,sha256=mhF5VkRxvwamRa_0AihgbFuXLMueRCK-Je_ZZvU5IFw,1013
+meridian/model/adstock_hill.py,sha256=HoRKjyL03pCTBz6Utof9wEvlQCFM43BvrEW_oupj7NU,17688
+meridian/model/knots.py,sha256=87kw5oa3T1k9GgT_aWXTqQx5XCxLsS2w1hnzc581XL0,26677
+meridian/model/media.py,sha256=skjy4Vd8LfDQWlqR_2lJ1qbG9UcS1dow5W45BAu4qk8,14599
+meridian/model/model.py,sha256=jMtfl7woWtJ8M8AX42QeZ5hUS8hlhPdZ-9OU8KahjKA,68984
+meridian/model/model_test_data.py,sha256=XGBz8RGdCsjAUOmgxX3CfWSj-_hdq2Lc8saFCqmImwM,23901
+meridian/model/posterior_sampler.py,sha256=f3MayglIgBeBjWeXJU_RgT9cCugcjJ3aEjHqaWPsTbg,26806
+meridian/model/prior_distribution.py,sha256=ZArW4uXIPPQL6hRWiGZUzcHktbkjE_vOklvlbp9LR64,57662
+meridian/model/prior_sampler.py,sha256=iLvCefhA4WY0ENcnLK9471WUZPPyzQ1je58MRjxKv74,25460
+meridian/model/spec.py,sha256=VlK6WJiPo2lzOF0O2judtJ6O3uEw7wYL5AT8bioq4gE,19188
+meridian/model/transformers.py,sha256=HxlVJitxP-wu-NOHU0tArFUZ4NAO3c7adAYj4Zvqnvo,8363
+meridian/model/eda/__init__.py,sha256=w3p7ZUZLq5TOEHm8n2P1CWjGrzuNrkqSSnVFdlw17Dk,812
+meridian/model/eda/constants.py,sha256=V9aOHQDvB3WAEyT0NE4gE8rqbStaGVh3XDlBPOKpuLc,739
+meridian/model/eda/eda_engine.py,sha256=5Ikgiz-6d3uTBan71WwsgPHOqk0fAy390ZLCq9L6HoY,64846
+meridian/model/eda/eda_outcome.py,sha256=P-0kNIbNXcyqMaNvFxiL3x6fhtYOL2trw-zPPZGXh5w,5670
+meridian/model/eda/eda_spec.py,sha256=diieYyZH0ee3ZLy0rGFMcWrrgiUrz2HctMwOrmtJR6w,2871
+meridian/model/eda/meridian_eda.py,sha256=GTdBaAtfsHS5s6P5ZESaeh1ElKV_o7dSqQosiMnFBKg,7537
+schema/__init__.py,sha256=Df2XKjMKa0ry7CTlDuJnyxuTdSgAd5za922wMlE98cg,681
+schema/serde/__init__.py,sha256=xyydIcWB5IUpcn3wu1m9HL1fK4gMWURbwTyRsQtolF0,975
+schema/serde/constants.py,sha256=aYtD_RuA0GCkpC4TIQq3VjMqEc837Wn-TlJNm-yn_4Y,1842
+schema/serde/distribution.py,sha256=jy3h6JD1TSs4gwociMis814sz_Fm2kFQ2UbkgjYJW9k,19347
+schema/serde/eda_spec.py,sha256=uOqBeZpUU3Dzzc19rU1LjHWmUhRmVcx8oIZvZfVJHT8,7180
+schema/serde/function_registry.py,sha256=GbgC5_9NDcA9Y7nqmdJ-4-LK5JPhhfI50Lmfy5ZBJOg,4858
+schema/serde/hyperparameters.py,sha256=Igm-PZmIozrsKZH6c-XkrU_Nlf8OAuxpnJJfv7W1SfQ,13524
+schema/serde/inference_data.py,sha256=DrwE9hU8LMrl0z8W_sUSIaPrRdym_lu0iOqpT4KZxsA,3623
+schema/serde/marketing_data.py,sha256=yb-fRTe84Sjg7-v3wsvYRRXvrxLSFWSenO0_ikMvUpk,44845
+schema/serde/meridian_serde.py,sha256=ZG05JaBG4LW8mhl-Cunje9Q6xyR4tyNTtLYedzMBYjA,15985
+schema/serde/serde.py,sha256=8vUqhJxvZgX9UY3rXTyWJznRgapwDzzaHXDHwV_kKTA,1612
+schema/serde/test_data.py,sha256=7hfEWyvZ9WcAkVAOXt6elX8stJlsfhfd-ASlHo9SRb8,107342
+schema/utils/__init__.py,sha256=AkC4NMbmXC3PFBY9dFYxlf3qFsxt5OOBVdc9zmFXsC8,675
+schema/utils/time_record.py,sha256=-KzHFjvSBUUXsfESPAfcJP_VFxaFLqj90Ac0kgKWfpI,4624
+google_meridian-1.3.1.dist-info/METADATA,sha256=wu5D6r6v46vd5g4uKLfXEVuhxkO3jwEgS68wn6m0jR4,9547
+google_meridian-1.3.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+google_meridian-1.3.1.dist-info/top_level.txt,sha256=yWkWDLV_UUanhKmk_xNPiKNdPDl1oyU1sBYwEnhaSf4,16
+google_meridian-1.3.1.dist-info/RECORD,,

{google_meridian-1.2.1.dist-info → google_meridian-1.3.1.dist-info}/top_level.txt

@@ -1 +1,2 @@
 meridian
+schema

meridian/analysis/__init__.py

@@ -17,5 +17,7 @@
 from meridian.analysis import analyzer
 from meridian.analysis import formatter
 from meridian.analysis import optimizer
+from meridian.analysis import review
 from meridian.analysis import summarizer
 from meridian.analysis import visualizer
+