doubleml-pipeline 0.1.0__tar.gz

doubleml_pipeline-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

doubleml_pipeline-0.1.0/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.4
+Name: doubleml-pipeline
+Version: 0.1.0
+Summary: A causal inference pipeline utilizing DoubleML and FLAML
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: scikit-learn>=1.0
+Requires-Dist: doubleml>=0.5.0
+Requires-Dist: FLAML>=1.0.0
+Requires-Dist: scipy
+Requires-Dist: patsy
+Requires-Dist: matplotlib
+Requires-Dist: cloudpickle
+Requires-Dist: joblib
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# DoubleML Pipeline
+
+A robust Python library for automated causal inference utilizing Double Machine
+Learning (DoubleML) and FLAML AutoML.
+
+**By the Google Decision Science System Team**
+
+*Note: `doubleml-pipeline` refers to and builds upon the underlying `DoubleML`
+Python package published by [doubleml.org](http://doubleml.org).*
+
+--------------------------------------------------------------------------------
+
+> [!IMPORTANT] **Caveat on File Generation:** For verification purposes,
+> currently `doubleml_pipeline` generates CSV files and charts explicitly across
+> the process.
+
+## Why DoubleML Pipeline?
+
+With **DoubleML Pipeline**, you can estimate the true incremental impact and ROI
+of your marketing interventions including pricing and promotions by controlling
+for complex, high-dimensional confounders.
+
+Causal inference is challenging due to confounding bias. Standard regression
+models often fail to isolate true causal relationships. **DoubleML Pipeline**
+solves this by implementing a rigorous Double Machine Learning (DoubleML)
+framework, combining it with automated machine learning (AutoML) to make causal
+estimation both scientifically robust and highly automated.
+
+### Key Features:
+
+*   **Automated Nuisance Modeling**: Automates nuisance parameter estimation
+    using FLAML AutoML. It dynamically searches and tunes candidates (like
+    LightGBM, XGBoost) under a specified time budget, removing the guesswork of
+    model selection.
+*   **Safe Business Unit Scaling**: Normalizes and scales geographical and
+    population data securely, ensuring that descaled results represent accurate
+    real-world business metrics (KPI, ROI) without introducing mathematical
+    singularities.
+*   **Treatment Effect Heterogeneity (CATE)**: Automatically fits continuous
+    splines or binary bases to estimate how treatment effects vary across
+    different contexts (Conditional Average Treatment Effects).
+*   **Sensitivity Analysis (OVB)**: Runs robust omitted variable bias (OVB)
+    checks to evaluate how sensitive your causal estimates are to unobserved
+    confounders.
+*   **Publication-Ready Visualizations**: Generates comprehensive time series
+    line plots, stacked contribution bar charts, cross-sectional ROI
+    comparisons, and prior distribution shapes.
+
+--------------------------------------------------------------------------------
+
+## Getting Started
+
+### Prerequisites
+
+Before running the pipeline, ensure you have:
+
+*   **Python 3.9** or later.
+
+### Installation
+
+You can install the library directly from PyPI:
+
+```bash
+pip install doubleml-pipeline
+```
+
+Alternatively, to install from source:
+
+```bash
+git clone https://github.com/google/doubleml-pipeline.git
+cd doubleml-pipeline
+pip install .
+```
+
+### Quick Start Example
+
+Here is how to initialize and run the causal pipeline in a standard Python
+environment, explicitly configuring all scaling, modeling, and financial
+parameters:
+
+```python
+import pandas as pd
+from doubleml_pipeline.preprocessing.scalers import CausalDataScaler
+from doubleml_pipeline.workflow import CausalWorkflowOrchestrator
+
+# 1. Load your dataset
+df = pd.read_csv("path/to/your/marketing_data.csv")
+
+# 2. Initialize the scaler with explicit scaling strategies per column
+scaler = CausalDataScaler(
+    standardize_cols=["holiday_index", "seasonality_factor"],
+    population_standardize_cols=["competitor_spend"],
+    population_median_normalize_cols=["sales_revenue", "tv_spend"],
+    min_max_cols=["store_count"],
+    median_normalize_cols=["discount_rate"],
+    population_col="geo_population",
+)
+
+# 3. Initialize the orchestrator with all explicit configuration parameters
+orchestrator = CausalWorkflowOrchestrator(
+    # Primary target and treatments
+    y_col="sales_revenue",
+    d_cols=["discount_rate", "coupon_imps"],
+    x_cols_list=[
+        ["holiday_index", "seasonality_factor", "competitor_spend"],
+        ["holiday_index", "seasonality_factor", "competitor_spend"],
+    ],
+    # Nuisance estimation models & cross-validation setup
+    ml_models_y=["lgbm", "xgboost"],
+    ml_models_t=["lgbm", "xgboost"],
+    n_folds_list=[5],
+    output_dir="./causal_results",
+    n_jobs=-1,
+    # Conditional Average Treatment Effect (CATE) specification
+    covariates_for_cate_list=[
+        ["seasonality_factor"],
+        ["seasonality_factor"],
+    ],
+    cate_structure_list=[
+        {"type": "auto_additive", "df": 3, "degree": 2, "include_intercept": False},
+        {"type": "auto_additive", "df": 3, "degree": 2, "include_intercept": False},
+    ],
+    time_budget=30,
+    # Panel data dimensions
+    date_col="date",
+    geo_col="geo",
+    item_col="item",
+    geo_name_col="geo_name",
+    item_name_col="item_name",
+    # Sensitivity analysis (Omitted Variable Bias)
+    run_sensitivity=True,
+    sensitivity_scope=["total", "geo", "item"],
+    # Ground truth validation (set True if ground truth effect columns exist)
+    ground_truth_existence=False,
+    ground_truth_effect_column=None,
+    # Treatment type classification & monetary spend mapping
+    treatment_types={
+        "discount_rate": "percentage",
+        "coupon_imps": "spend",
+    },
+    treatment_spend_cols={
+        "coupon_imps": "coupon_cost",
+    },
+    sales_col="sales_revenue",
+)
+
+# 4. Execute the full 4-phase pipeline (Grid Search -> Shortlist -> Ensemble -> Consolidation)
+orchestrator.run_full_pipeline(
+    df=df,
+    scaler=scaler,
+    top_n=3,
+    n_reps=10,
+)
+```
+
+The orchestrator will execute the models in parallel, select the best
+estimators, run repetitions to calculate robust confidence bounds, perform
+sensitivity checks, and write all dataframes and plot artifacts to the specified
+`./causal_results` directory.
+
+### Important Notes on Outputs & Optimization
+
+1.  **ROI Charts:** ROI charts (`003_promo_roi_by_month` and
+    `004_promo_roi_by_entity`) are generated only if `treatment_types` is set to
+    `"percentage"` or `"impressions"` (requires `treatment_spend_cols`
+    specification). The default value for `treatment_types` is `"spend"`. For
+    `"spend"` treatments, ROI charts will not be generated specifically because
+    they are redundant with the output generated in Phase 4.
+2.  **Optimization:** Currently, optimization calculations can only be performed
+    if `optimize = True` and `simple_optimization = True` with a single
+    treatment. Optimization is not calculated if `simple_optimization = False`
+    because the optimization function is under development and optimization for
+    multiple treatments is not supported yet.
+
+--------------------------------------------------------------------------------
+
+## Engaging with the Project
+
+### Documentation & Examples
+
+*   **API Reference**: For a comprehensive list of modules, classes, and
+    function signatures, refer to the [API Reference](docs/api_reference.md).
+*   **Interactive Sample**: Check out the
+    [Sample Jupyter Notebook](examples/sample_notebook.ipynb) which walks
+    through simulating realistic panel marketing data, engineering lagged
+    features, scaling, running the DML pipeline, and plotting the results.
+
+### Contributing & Feedback
+
+We welcome contributions!
+
+*   **Reporting Issues**: If you encounter bugs or want to request features,
+    please open an issue in the GitHub repository issue tracker.
+*   **Submitting Changes**: Please see `CONTRIBUTING.md` for our guidelines on
+    submitting pull requests.
+
+--------------------------------------------------------------------------------
+
+## References
+
+1.  **Debiased Machine Learning method** Victor Chernozhukov, Denis Chetverikov,
+    Mert Demirer, Esther Duflo, Christian Hansen, Whitney Newey, James Robins.
+    *Double/debiased machine learning for treatment and structural parameters*.
+    [arXiv:1608.00060](https://arxiv.org/abs/1608.00060)
+
+2.  **Hyperparameter Tuning for Causal Inference with Double Machine Learning: A
+    Simulation Study** Martin Spindler, et al.
+    [arXiv:2212.04351](https://arxiv.org/abs/2212.04351)
+
+3.  **Debiased Machine Learning of Conditional Average Treatment Effects and
+    Other Causal Functions** Vira Semenova, Victor Chernozhukov.
+    [arXiv:1702.06240](https://arxiv.org/abs/1702.06240)
+
+4.  **Multiway Cluster Robust Double/Debiased Machine Learning** Harold D.
+    Chiang, Kengo Kato, Yukitoshi Matsushita, Takuya Ishihara.
+    [arXiv:1909.05294](https://arxiv.org/abs/1909.05294)

doubleml_pipeline-0.1.0/README.md

@@ -0,0 +1,216 @@
+# DoubleML Pipeline
+
+A robust Python library for automated causal inference utilizing Double Machine
+Learning (DoubleML) and FLAML AutoML.
+
+**By the Google Decision Science System Team**
+
+*Note: `doubleml-pipeline` refers to and builds upon the underlying `DoubleML`
+Python package published by [doubleml.org](http://doubleml.org).*
+
+--------------------------------------------------------------------------------
+
+> [!IMPORTANT] **Caveat on File Generation:** For verification purposes,
+> currently `doubleml_pipeline` generates CSV files and charts explicitly across
+> the process.
+
+## Why DoubleML Pipeline?
+
+With **DoubleML Pipeline**, you can estimate the true incremental impact and ROI
+of your marketing interventions including pricing and promotions by controlling
+for complex, high-dimensional confounders.
+
+Causal inference is challenging due to confounding bias. Standard regression
+models often fail to isolate true causal relationships. **DoubleML Pipeline**
+solves this by implementing a rigorous Double Machine Learning (DoubleML)
+framework, combining it with automated machine learning (AutoML) to make causal
+estimation both scientifically robust and highly automated.
+
+### Key Features:
+
+*   **Automated Nuisance Modeling**: Automates nuisance parameter estimation
+    using FLAML AutoML. It dynamically searches and tunes candidates (like
+    LightGBM, XGBoost) under a specified time budget, removing the guesswork of
+    model selection.
+*   **Safe Business Unit Scaling**: Normalizes and scales geographical and
+    population data securely, ensuring that descaled results represent accurate
+    real-world business metrics (KPI, ROI) without introducing mathematical
+    singularities.
+*   **Treatment Effect Heterogeneity (CATE)**: Automatically fits continuous
+    splines or binary bases to estimate how treatment effects vary across
+    different contexts (Conditional Average Treatment Effects).
+*   **Sensitivity Analysis (OVB)**: Runs robust omitted variable bias (OVB)
+    checks to evaluate how sensitive your causal estimates are to unobserved
+    confounders.
+*   **Publication-Ready Visualizations**: Generates comprehensive time series
+    line plots, stacked contribution bar charts, cross-sectional ROI
+    comparisons, and prior distribution shapes.
+
+--------------------------------------------------------------------------------
+
+## Getting Started
+
+### Prerequisites
+
+Before running the pipeline, ensure you have:
+
+*   **Python 3.9** or later.
+
+### Installation
+
+You can install the library directly from PyPI:
+
+```bash
+pip install doubleml-pipeline
+```
+
+Alternatively, to install from source:
+
+```bash
+git clone https://github.com/google/doubleml-pipeline.git
+cd doubleml-pipeline
+pip install .
+```
+
+### Quick Start Example
+
+Here is how to initialize and run the causal pipeline in a standard Python
+environment, explicitly configuring all scaling, modeling, and financial
+parameters:
+
+```python
+import pandas as pd
+from doubleml_pipeline.preprocessing.scalers import CausalDataScaler
+from doubleml_pipeline.workflow import CausalWorkflowOrchestrator
+
+# 1. Load your dataset
+df = pd.read_csv("path/to/your/marketing_data.csv")
+
+# 2. Initialize the scaler with explicit scaling strategies per column
+scaler = CausalDataScaler(
+    standardize_cols=["holiday_index", "seasonality_factor"],
+    population_standardize_cols=["competitor_spend"],
+    population_median_normalize_cols=["sales_revenue", "tv_spend"],
+    min_max_cols=["store_count"],
+    median_normalize_cols=["discount_rate"],
+    population_col="geo_population",
+)
+
+# 3. Initialize the orchestrator with all explicit configuration parameters
+orchestrator = CausalWorkflowOrchestrator(
+    # Primary target and treatments
+    y_col="sales_revenue",
+    d_cols=["discount_rate", "coupon_imps"],
+    x_cols_list=[
+        ["holiday_index", "seasonality_factor", "competitor_spend"],
+        ["holiday_index", "seasonality_factor", "competitor_spend"],
+    ],
+    # Nuisance estimation models & cross-validation setup
+    ml_models_y=["lgbm", "xgboost"],
+    ml_models_t=["lgbm", "xgboost"],
+    n_folds_list=[5],
+    output_dir="./causal_results",
+    n_jobs=-1,
+    # Conditional Average Treatment Effect (CATE) specification
+    covariates_for_cate_list=[
+        ["seasonality_factor"],
+        ["seasonality_factor"],
+    ],
+    cate_structure_list=[
+        {"type": "auto_additive", "df": 3, "degree": 2, "include_intercept": False},
+        {"type": "auto_additive", "df": 3, "degree": 2, "include_intercept": False},
+    ],
+    time_budget=30,
+    # Panel data dimensions
+    date_col="date",
+    geo_col="geo",
+    item_col="item",
+    geo_name_col="geo_name",
+    item_name_col="item_name",
+    # Sensitivity analysis (Omitted Variable Bias)
+    run_sensitivity=True,
+    sensitivity_scope=["total", "geo", "item"],
+    # Ground truth validation (set True if ground truth effect columns exist)
+    ground_truth_existence=False,
+    ground_truth_effect_column=None,
+    # Treatment type classification & monetary spend mapping
+    treatment_types={
+        "discount_rate": "percentage",
+        "coupon_imps": "spend",
+    },
+    treatment_spend_cols={
+        "coupon_imps": "coupon_cost",
+    },
+    sales_col="sales_revenue",
+)
+
+# 4. Execute the full 4-phase pipeline (Grid Search -> Shortlist -> Ensemble -> Consolidation)
+orchestrator.run_full_pipeline(
+    df=df,
+    scaler=scaler,
+    top_n=3,
+    n_reps=10,
+)
+```
+
+The orchestrator will execute the models in parallel, select the best
+estimators, run repetitions to calculate robust confidence bounds, perform
+sensitivity checks, and write all dataframes and plot artifacts to the specified
+`./causal_results` directory.
+
+### Important Notes on Outputs & Optimization
+
+1.  **ROI Charts:** ROI charts (`003_promo_roi_by_month` and
+    `004_promo_roi_by_entity`) are generated only if `treatment_types` is set to
+    `"percentage"` or `"impressions"` (requires `treatment_spend_cols`
+    specification). The default value for `treatment_types` is `"spend"`. For
+    `"spend"` treatments, ROI charts will not be generated specifically because
+    they are redundant with the output generated in Phase 4.
+2.  **Optimization:** Currently, optimization calculations can only be performed
+    if `optimize = True` and `simple_optimization = True` with a single
+    treatment. Optimization is not calculated if `simple_optimization = False`
+    because the optimization function is under development and optimization for
+    multiple treatments is not supported yet.
+
+--------------------------------------------------------------------------------
+
+## Engaging with the Project
+
+### Documentation & Examples
+
+*   **API Reference**: For a comprehensive list of modules, classes, and
+    function signatures, refer to the [API Reference](docs/api_reference.md).
+*   **Interactive Sample**: Check out the
+    [Sample Jupyter Notebook](examples/sample_notebook.ipynb) which walks
+    through simulating realistic panel marketing data, engineering lagged
+    features, scaling, running the DML pipeline, and plotting the results.
+
+### Contributing & Feedback
+
+We welcome contributions!
+
+*   **Reporting Issues**: If you encounter bugs or want to request features,
+    please open an issue in the GitHub repository issue tracker.
+*   **Submitting Changes**: Please see `CONTRIBUTING.md` for our guidelines on
+    submitting pull requests.
+
+--------------------------------------------------------------------------------
+
+## References
+
+1.  **Debiased Machine Learning method** Victor Chernozhukov, Denis Chetverikov,
+    Mert Demirer, Esther Duflo, Christian Hansen, Whitney Newey, James Robins.
+    *Double/debiased machine learning for treatment and structural parameters*.
+    [arXiv:1608.00060](https://arxiv.org/abs/1608.00060)
+
+2.  **Hyperparameter Tuning for Causal Inference with Double Machine Learning: A
+    Simulation Study** Martin Spindler, et al.
+    [arXiv:2212.04351](https://arxiv.org/abs/2212.04351)
+
+3.  **Debiased Machine Learning of Conditional Average Treatment Effects and
+    Other Causal Functions** Vira Semenova, Victor Chernozhukov.
+    [arXiv:1702.06240](https://arxiv.org/abs/1702.06240)
+
+4.  **Multiway Cluster Robust Double/Debiased Machine Learning** Harold D.
+    Chiang, Kengo Kato, Yukitoshi Matsushita, Takuya Ishihara.
+    [arXiv:1909.05294](https://arxiv.org/abs/1909.05294)

doubleml_pipeline-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "doubleml-pipeline"
+version = "0.1.0"
+description = "A causal inference pipeline utilizing DoubleML and FLAML"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "numpy>=1.20.0",
+    "pandas>=1.3.0",
+    "scikit-learn>=1.0",
+    "doubleml>=0.5.0",
+    "FLAML>=1.0.0",
+    "scipy",
+    "patsy",
+    "matplotlib",
+    "cloudpickle",
+    "joblib"
+]
+
+[project.optional-dependencies]
+dev = ["pytest", "mypy", "black", "isort"]

doubleml_pipeline-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+