File tree Expand file tree Collapse file tree 1 file changed +5
-3
lines changed
causal_testing/json_front Expand file tree Collapse file tree 1 file changed +5
-3
lines changed Original file line number Diff line number Diff line change @@ -6,14 +6,16 @@ whilst retaining the flexibility of the Causal Testing Framework (CTF).
6
6
An example is provided in ` examples/poisson ` which will be walked through in this README to better understand
7
7
the framework
8
8
9
- ` examples/poisson/causal_test_setup .py ` contains python code written by the user to implement scenario specific features
9
+ ` examples/poisson/run_causal_tests .py ` contains python code written by the user to implement scenario specific features
10
10
such as:
11
11
1 . Custom Estimators
12
12
2 . Causal Variable specification
13
13
3 . Causal test case outcomes
14
14
4 . Meta constraint functions
15
15
5 . Mapping JSON distributions, effects, and estimators to python objects
16
16
17
+ Use case specific information is also declared here such as the paths to the relevant files needed for the tests.
18
+
17
19
` examples/poisson/causal_tests.json ` is the JSON file that allows for the easy specification of multiple causal tests.
18
20
Each test requires:
19
21
1 . Test name
@@ -25,8 +27,8 @@ Each test requires:
25
27
7 . Skip: boolean that if set true the test won't be executed and will be skipped
26
28
27
29
To run the JSON frontend example from the root directory of the project, use
28
- ` python examples/poisson/causal_test_setup .py --directory_path="examples/poisson " `
30
+ ` python examples/poisson/run_causal_tests .py" `
29
31
30
32
A failure flag ` -f ` can be specified to stop the framework running if a test is failed
31
- ` python examples/poisson/causal_test_setup .py -f --directory_path="examples/poisson " `
33
+ ` python examples/poisson/run_causal_tests .py -f" `
32
34
You can’t perform that action at this time.
0 commit comments