From cf14caab5c0c9652189892b7cd54311f5d7f9f92 Mon Sep 17 00:00:00 2001
From: Patrick Bloebaum <bloebp@amazon.com>
Date: Thu, 9 Nov 2023 16:04:10 -0800
Subject: [PATCH] Remove 'experimental' disclaimer from GCM modules

Also slightly change citation hint.

Signed-off-by: Patrick Bloebaum <bloebp@amazon.com>
---
 README.rst                                      | 8 ++++----
 docs/source/cite.rst                            | 2 +-
 dowhy/gcm/__init__.py                           | 5 +----
 dowhy/gcm/anomaly_scorers.py                    | 6 +-----
 dowhy/gcm/causal_mechanisms.py                  | 5 +----
 dowhy/gcm/causal_models.py                      | 5 +----
 dowhy/gcm/confidence_intervals.py               | 5 +----
 dowhy/gcm/confidence_intervals_cms.py           | 5 +----
 dowhy/gcm/density_estimators.py                 | 6 +-----
 dowhy/gcm/distribution_change.py                | 5 +----
 dowhy/gcm/divergence.py                         | 3 ---
 dowhy/gcm/falsify.py                            | 5 +----
 dowhy/gcm/feature_relevance.py                  | 5 +----
 dowhy/gcm/fitting_sampling.py                   | 5 +----
 dowhy/gcm/independence_test/kernel.py           | 3 ---
 dowhy/gcm/independence_test/kernel_operation.py | 4 ----
 dowhy/gcm/influence.py                          | 5 +----
 dowhy/gcm/ml/classification.py                  | 3 ---
 dowhy/gcm/ml/regression.py                      | 3 ---
 dowhy/gcm/shapley.py                            | 6 +-----
 dowhy/gcm/stats.py                              | 4 ----
 dowhy/gcm/stochastic_models.py                  | 5 +----
 dowhy/gcm/uncertainty.py                        | 5 +----
 dowhy/gcm/util/general.py                       | 4 ----
 dowhy/gcm/validation.py                         | 6 +-----
 dowhy/gcm/whatif.py                             | 5 +----
 26 files changed, 22 insertions(+), 101 deletions(-)

diff --git a/README.rst b/README.rst
index c2b425db6..376278bd3 100755
--- a/README.rst
+++ b/README.rst
@@ -54,7 +54,7 @@ News
   redirect your git command for cloning, pulling, etc., we recommend updating git remotes and bookmarks. Please note
   that the **documentation** has now moved to https://py-why.github.io/dowhy with **no** redirect from the old URL.
 
-* **Experimental support for GCM-based inference**
+* **Support for GCM-based inference**
 
   We have started adding support for graphical causal model-based inference (or in short GCM-based). At the moment,
   this includes support for interventions, counterfactuals, and attributing distribution changes. As part of this,
@@ -203,10 +203,10 @@ estimate (if any). Here's a sample output of the linear regression estimator.
 For a full code example, check out the `Getting Started with DoWhy <https://github.com/microsoft/dowhy/blob/main/docs/source/example_notebooks/dowhy_simple_example.ipynb>`_ notebook. You can also use Conditional Average Treatment Effect (CATE) estimation methods from other libraries such as EconML and CausalML, as shown in the `Conditional Treatment Effects <https://github.com/microsoft/dowhy/blob/main/docs/source/example_notebooks/dowhy-conditional-treatment-effects.ipynb>`_ notebook. For more examples of using DoWhy, check out the Jupyter notebooks in `docs/source/example_notebooks <https://github.com/microsoft/dowhy/tree/main/docs/source/example_notebooks/>`_ or try them online at `Binder <https://mybinder.org/v2/gh/microsoft/dowhy/main?filepath=docs%2Fsource%2F>`_.
 
 
-GCM-based inference (experimental)
+GCM-based inference
 ----------------------------------
 
-Graphical causal model-based inference, or GCM-based inference for short, is an experimental addition to DoWhy. For
+Graphical causal model-based inference, or GCM-based inference for short, is an addition to DoWhy. For
 details, check out the `documentation for the gcm sub-package <https://py-why.github.io/dowhy/main/user_guide/gcm_based_inference/index.html>`_. The basic
 recipe for this API works as follows:
 
@@ -497,7 +497,7 @@ As a practical example, `this notebook <https://github.com/microsoft/dowhy/blob/
 
 Citing this package
 ====================
-If you find DoWhy useful for your work, please cite the following two references:
+If you find DoWhy useful for your work, please cite **both** of the following two references:
 
 - Amit Sharma, Emre Kiciman. DoWhy: An End-to-End Library for Causal Inference. 2020. https://arxiv.org/abs/2011.04216
 - Patrick Blöbaum, Peter Götz, Kailash Budhathoki, Atalanti A. Mastakouri, Dominik Janzing. DoWhy-GCM: An extension of DoWhy for causal inference in graphical causal models. 2022. https://arxiv.org/abs/2206.06821
diff --git a/docs/source/cite.rst b/docs/source/cite.rst
index 4adb51d10..cc9e94ff9 100644
--- a/docs/source/cite.rst
+++ b/docs/source/cite.rst
@@ -1,7 +1,7 @@
 Citing this package
 -------------------
 
-If you find DoWhy useful for your work, please cite the following two references:
+If you find DoWhy useful for your work, please cite **both** of the following two references:
 
 - Amit Sharma, Emre Kiciman. DoWhy: An End-to-End Library for Causal Inference. 2020. https://arxiv.org/abs/2011.04216
 - Patrick Blöbaum, Peter Götz, Kailash Budhathoki, Atalanti A. Mastakouri, Dominik Janzing. DoWhy-GCM: An extension of DoWhy for causal inference in graphical causal models. 2022. https://arxiv.org/abs/2206.06821
diff --git a/dowhy/gcm/__init__.py b/dowhy/gcm/__init__.py
index 5d46845c0..a8d75243f 100644
--- a/dowhy/gcm/__init__.py
+++ b/dowhy/gcm/__init__.py
@@ -1,7 +1,4 @@
-"""The gcm sub-package provides features built on top of graphical causal model (GCM) based inference. The status of
-this addition and its API is considered experimental, meaning there might be breaking changes to its API in the
-future.
-"""
+"""The gcm sub-package provides features built on top of graphical causal model (GCM) based inference."""
 
 from . import auto, config, divergence, ml, shapley, stats, uncertainty, util
 from .anomaly import anomaly_scores, attribute_anomalies
diff --git a/dowhy/gcm/anomaly_scorers.py b/dowhy/gcm/anomaly_scorers.py
index eff1bf6af..ff9fbc8ea 100644
--- a/dowhy/gcm/anomaly_scorers.py
+++ b/dowhy/gcm/anomaly_scorers.py
@@ -1,8 +1,4 @@
-"""This module contains implementations of different anomaly scorers.
-
-Classes and functions in this module should be considered experimental, meaning there might be breaking API changes in
-the future.
-"""
+"""This module contains implementations of different anomaly scorers."""
 
 from typing import Optional
 
diff --git a/dowhy/gcm/causal_mechanisms.py b/dowhy/gcm/causal_mechanisms.py
index 05e8c449f..e033a2753 100644
--- a/dowhy/gcm/causal_mechanisms.py
+++ b/dowhy/gcm/causal_mechanisms.py
@@ -1,7 +1,4 @@
-"""This module implements different causal mechanisms.
-
-Classes in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module implements different causal mechanisms."""
 
 import copy
 from abc import ABC, abstractmethod
diff --git a/dowhy/gcm/causal_models.py b/dowhy/gcm/causal_models.py
index 74517e3d0..2813c6e91 100644
--- a/dowhy/gcm/causal_models.py
+++ b/dowhy/gcm/causal_models.py
@@ -1,7 +1,4 @@
-"""This module defines the fundamental classes for graphical causal models (GCMs).
-
-Classes in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module defines the fundamental classes for graphical causal models (GCMs)."""
 
 from typing import Any, Callable, Optional, Union
 
diff --git a/dowhy/gcm/confidence_intervals.py b/dowhy/gcm/confidence_intervals.py
index addb220e1..a4b68cdaf 100644
--- a/dowhy/gcm/confidence_intervals.py
+++ b/dowhy/gcm/confidence_intervals.py
@@ -1,7 +1,4 @@
-"""This module provides functionality to estimate confidence intervals via bootstrapping.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module provides functionality to estimate confidence intervals via bootstrapping."""
 
 from typing import Any, Callable, Dict, List, Tuple, Union
 
diff --git a/dowhy/gcm/confidence_intervals_cms.py b/dowhy/gcm/confidence_intervals_cms.py
index 36077999b..6e481d4d1 100644
--- a/dowhy/gcm/confidence_intervals_cms.py
+++ b/dowhy/gcm/confidence_intervals_cms.py
@@ -1,7 +1,4 @@
-"""This module provides functionality to estimate confidence intervals via bootstrapping the fitting and sampling.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module provides functionality to estimate confidence intervals via bootstrapping the fitting and sampling."""
 
 from functools import partial
 from typing import Any, Callable, Dict, Optional, Union
diff --git a/dowhy/gcm/density_estimators.py b/dowhy/gcm/density_estimators.py
index 95126301e..007bd73eb 100644
--- a/dowhy/gcm/density_estimators.py
+++ b/dowhy/gcm/density_estimators.py
@@ -1,8 +1,4 @@
-"""This module contains implementations of different density estimators.
-
-Classes and functions in this module should be considered experimental, meaning there might be breaking API changes in
-the future.
-"""
+"""This module contains implementations of different density estimators."""
 
 from typing import Optional
 
diff --git a/dowhy/gcm/distribution_change.py b/dowhy/gcm/distribution_change.py
index dec1cbd95..28b608ad4 100644
--- a/dowhy/gcm/distribution_change.py
+++ b/dowhy/gcm/distribution_change.py
@@ -1,7 +1,4 @@
-"""This module defines functions to attribute distribution changes.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module defines functions to attribute distribution changes."""
 
 import logging
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
diff --git a/dowhy/gcm/divergence.py b/dowhy/gcm/divergence.py
index 87f213cbd..3902b339d 100644
--- a/dowhy/gcm/divergence.py
+++ b/dowhy/gcm/divergence.py
@@ -1,6 +1,3 @@
-"""Functions in this module should be considered experimental, meaning there might be breaking API changes in the
-future.
-"""
 from functools import partial
 from typing import Callable, Union
 
diff --git a/dowhy/gcm/falsify.py b/dowhy/gcm/falsify.py
index 415b13677..08830e8e6 100644
--- a/dowhy/gcm/falsify.py
+++ b/dowhy/gcm/falsify.py
@@ -1,7 +1,4 @@
-"""This module provides functionality to falsify a user-given DAG given observed data.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module provides functionality to falsify a user-given DAG given observed data."""
 import warnings
 from dataclasses import dataclass, field
 from enum import Enum, auto
diff --git a/dowhy/gcm/feature_relevance.py b/dowhy/gcm/feature_relevance.py
index f04a2df6f..80afd3f18 100644
--- a/dowhy/gcm/feature_relevance.py
+++ b/dowhy/gcm/feature_relevance.py
@@ -1,10 +1,7 @@
 """This module allows to estimate the feature relevance of inputs with respect to a given model. While these models can
 be blackbox prediction models, it is also possible to explain causal mechanisms with respect to the direct parents.
 In these cases, it would be possible to incorporate the noise to represent the part of the generation process that
-cannot be explained by the parents.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+cannot be explained by the parents."""
 from typing import Any, Callable, Dict, Optional, Tuple, Union
 
 import numpy as np
diff --git a/dowhy/gcm/fitting_sampling.py b/dowhy/gcm/fitting_sampling.py
index 88ac0cb88..d8758a45c 100644
--- a/dowhy/gcm/fitting_sampling.py
+++ b/dowhy/gcm/fitting_sampling.py
@@ -1,7 +1,4 @@
-"""This module provides functionality for fitting probabilistic causal models and drawing samples from them.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module provides functionality for fitting probabilistic causal models and drawing samples from them."""
 
 from typing import Any
 
diff --git a/dowhy/gcm/independence_test/kernel.py b/dowhy/gcm/independence_test/kernel.py
index 2f26b5e8b..b61633dc5 100644
--- a/dowhy/gcm/independence_test/kernel.py
+++ b/dowhy/gcm/independence_test/kernel.py
@@ -1,6 +1,3 @@
-"""Functions in this module should be considered experimental, meaning there might be breaking API changes in the
-future.
-"""
 from typing import Callable, List, Optional, Union
 
 import numpy as np
diff --git a/dowhy/gcm/independence_test/kernel_operation.py b/dowhy/gcm/independence_test/kernel_operation.py
index a929220d8..55ceb7b10 100644
--- a/dowhy/gcm/independence_test/kernel_operation.py
+++ b/dowhy/gcm/independence_test/kernel_operation.py
@@ -1,7 +1,3 @@
-"""Functions in this module should be considered experimental, meaning there might be breaking API changes in the
-future.
-"""
-
 from typing import Optional
 
 import numpy as np
diff --git a/dowhy/gcm/influence.py b/dowhy/gcm/influence.py
index 7fe949ed5..710231e1e 100644
--- a/dowhy/gcm/influence.py
+++ b/dowhy/gcm/influence.py
@@ -1,7 +1,4 @@
-"""This module provides functions to estimate causal influences.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module provides functions to estimate causal influences."""
 import logging
 import warnings
 from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Union, cast
diff --git a/dowhy/gcm/ml/classification.py b/dowhy/gcm/ml/classification.py
index 07057d3f2..d4eaac39d 100644
--- a/dowhy/gcm/ml/classification.py
+++ b/dowhy/gcm/ml/classification.py
@@ -1,6 +1,3 @@
-"""Functions and classes in this module should be considered experimental, meaning there might be breaking API changes
-in the future.
-"""
 from abc import abstractmethod
 from typing import List
 
diff --git a/dowhy/gcm/ml/regression.py b/dowhy/gcm/ml/regression.py
index 2b5c96b21..7b4a6e07e 100644
--- a/dowhy/gcm/ml/regression.py
+++ b/dowhy/gcm/ml/regression.py
@@ -1,6 +1,3 @@
-"""Functions and classes in this module should be considered experimental, meaning there might be breaking API changes
-in the future.
-"""
 from abc import abstractmethod
 from typing import Any
 
diff --git a/dowhy/gcm/shapley.py b/dowhy/gcm/shapley.py
index 087f8735d..89345164c 100644
--- a/dowhy/gcm/shapley.py
+++ b/dowhy/gcm/shapley.py
@@ -1,8 +1,4 @@
-"""This module provides functionality for shapley value estimation.
-
-Classes and functions in this module should be considered experimental, meaning there might be breaking API changes in
-the future.
-"""
+"""This module provides functionality for shapley value estimation."""
 
 import itertools
 import math
diff --git a/dowhy/gcm/stats.py b/dowhy/gcm/stats.py
index 36056dbfa..bb554f756 100644
--- a/dowhy/gcm/stats.py
+++ b/dowhy/gcm/stats.py
@@ -1,7 +1,3 @@
-"""Functions in this module should be considered experimental, meaning there might be breaking API changes in the
-future.
-"""
-
 from typing import Callable, List, Optional, Union
 
 import numpy as np
diff --git a/dowhy/gcm/stochastic_models.py b/dowhy/gcm/stochastic_models.py
index 96fc8b627..3f6763adc 100644
--- a/dowhy/gcm/stochastic_models.py
+++ b/dowhy/gcm/stochastic_models.py
@@ -1,7 +1,4 @@
-"""This module defines multiple implementations of the abstract class :class:`~dowhy.gcm.graph.StochasticModel`.
-
-Classes in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module defines multiple implementations of the abstract class :class:`~dowhy.gcm.graph.StochasticModel`."""
 
 import warnings
 from typing import Dict, Optional, Tuple, Union
diff --git a/dowhy/gcm/uncertainty.py b/dowhy/gcm/uncertainty.py
index 3e14161d1..15eb4caa0 100644
--- a/dowhy/gcm/uncertainty.py
+++ b/dowhy/gcm/uncertainty.py
@@ -1,7 +1,4 @@
-"""Functions to estimate uncertainties such as entropy, KL divergence etc.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""Functions to estimate uncertainties such as entropy, KL divergence etc."""
 
 import numpy as np
 from numpy.linalg import det
diff --git a/dowhy/gcm/util/general.py b/dowhy/gcm/util/general.py
index 613cd9e01..97d43c7bf 100644
--- a/dowhy/gcm/util/general.py
+++ b/dowhy/gcm/util/general.py
@@ -1,7 +1,3 @@
-"""Functions in this module should be considered experimental, meaning there might be breaking API changes in the
-future.
-"""
-
 import random
 from typing import Dict, Optional, Union
 
diff --git a/dowhy/gcm/validation.py b/dowhy/gcm/validation.py
index d486b343d..6418e735e 100644
--- a/dowhy/gcm/validation.py
+++ b/dowhy/gcm/validation.py
@@ -1,8 +1,4 @@
-"""Contains a method to reject the causal graph and validate causal mechanisms such as post non-linear models.
-
-Classes and functions in this module should be considered experimental, meaning there might be breaking API changes in
-the future.
-"""
+"""Contains a method to reject the causal graph and validate causal mechanisms such as post non-linear models."""
 from enum import Enum, auto
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
 
diff --git a/dowhy/gcm/whatif.py b/dowhy/gcm/whatif.py
index c01a7b040..de8f3fcab 100644
--- a/dowhy/gcm/whatif.py
+++ b/dowhy/gcm/whatif.py
@@ -1,7 +1,4 @@
-"""This module provides functionality to answer what-if questions.
-
-Functions in this module should be considered experimental, meaning there might be breaking API changes in the future.
-"""
+"""This module provides functionality to answer what-if questions."""
 
 from typing import Any, Callable, Dict, Iterable, List, Optional, Union