From 3d515ea77dd1535cbd28bcb5e52cffb476b2a44d 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                                      | 2 +-
 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, 19 insertions(+), 98 deletions(-)

diff --git a/README.rst b/README.rst
index c2b425db6c..300e265d99 100755
--- a/README.rst
+++ b/README.rst
@@ -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 4adb51d108..cc9e94ff90 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 5d46845c01..a8d75243fb 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 eff1bf6af1..ff9fbc8eae 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 05e8c449fc..e033a2753f 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 74517e3d00..2813c6e916 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 addb220e1d..a4b68cdaf5 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 36077999b8..6e481d4d16 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 95126301ee..007bd73eb2 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 dec1cbd959..28b608ad4f 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 87f213cbd8..3902b339d1 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 415b136772..08830e8e6a 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 f04a2df6f3..80afd3f182 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 88ac0cb888..d8758a45cb 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 2f26b5e8b8..b61633dc55 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 a929220d8c..55ceb7b104 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 7fe949ed5e..710231e1ed 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 07057d3f2b..d4eaac39d0 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 2b5c96b216..7b4a6e07eb 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 087f8735dd..89345164c6 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 36056dbfa7..bb554f7567 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 96fc8b6279..3f6763adce 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 3e14161d11..15eb4caa0e 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 613cd9e018..97d43c7bf8 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 d486b343d0..6418e735e7 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 c01a7b040b..de8f3fcab3 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