Merge pull request #367 from CITCOM-project/jmafoster1/filter-inputs

Added filter parameter for testing inputs

Author: jmafoster1

causal_testing/testing/metamorphic_relation.py

@@ -204,7 +204,12 @@ def generate_metamorphic_relations(
 
 
 def generate_causal_tests(
-    dag_path: str, output_path: str, ignore_cycles: bool = False, threads: int = 0, **json_stub_kargs
+    dag_path: str,
+    output_path: str,
+    ignore_cycles: bool = False,
+    threads: int = 0,
+    test_inputs: bool = False,
+    **json_stub_kargs,
 ):
     """
     Generate and output causal tests for a given DAG.
@@ -216,6 +221,8 @@ def generate_causal_tests(
                           be omitted from the test set.
     :param threads: The number of threads to use to generate tests in parallel. If unspecified, tests are generated in
                     serial. This is tylically fine unless the number of tests to be generated is >10000.
+    :param test_inputs: Whether to test independences between inputs (i.e. root nodes in the DAG). Defaults to False
+    as they will typically be independent by construction.
     :param json_stub_kargs: Kwargs to pass into `to_json_stub` (see docstring for details.)
     """
     causal_dag = CausalDAG(dag_path, ignore_cycles=ignore_cycles)
@@ -241,7 +248,7 @@ def generate_causal_tests(
     tests = [
         relation.to_json_stub(**json_stub_kargs)
         for relation in relations
-        if len(list(causal_dag.predecessors(relation.base_test_case.outcome_variable))) > 0
+        if test_inputs or len(list(causal_dag.predecessors(relation.base_test_case.outcome_variable))) > 0
     ]
 
     logger.warning(

tests/testing_tests/test_metamorphic_relations.py

@@ -120,7 +120,10 @@ def test_should_cause_logistic_json_stub(self):
         should_cause_mr = ShouldCause(BaseTestCase("X1", "Z"), adj_set)
         self.assertEqual(
             should_cause_mr.to_json_stub(
-                effect_type="total", estimate_type="unit_odds_ratio", estimator="LogisticRegressionEstimator", skip=False
+                effect_type="total",
+                estimate_type="unit_odds_ratio",
+                estimator="LogisticRegressionEstimator",
+                skip=False,
             ),
             {
                 "effect": "total",
@@ -291,6 +294,22 @@ def test_generate_causal_tests(self):
             )
             self.assertEqual(tests["tests"], expected)
 
+    def test_generate_causal_tests_test_inputs(self):
+        dag = CausalDAG(self.dag_dot_path)
+        relations = generate_metamorphic_relations(dag)
+        with tempfile.TemporaryDirectory() as tmp:
+            tests_file = os.path.join(tmp, "causal_tests.json")
+            generate_causal_tests(self.dag_dot_path, tests_file, test_inputs=True)
+            with open(tests_file, encoding="utf8") as f:
+                tests = json.load(f)
+            expected = list(
+                map(
+                    lambda x: x.to_json_stub(skip=False),
+                    relations,
+                )
+            )
+            self.assertEqual(tests["tests"], expected)
+
     def test_shoud_cause_string(self):
         sc_mr = ShouldCause(BaseTestCase("X", "Y"), ["A", "B", "C"])
         self.assertEqual(str(sc_mr), "X --> Y | ['A', 'B', 'C']")