Skip to content

Commit 7f4893c

Browse files
update README.md
1 parent f5871b9 commit 7f4893c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

causal_testing/json_front/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ whilst retaining the flexibility of the Causal Testing Framework (CTF).
66
An example is provided in `examples/poisson` which will be walked through in this README to better understand
77
the framework
88

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
1010
such as:
1111
1. Custom Estimators
1212
2. Causal Variable specification
1313
3. Causal test case outcomes
1414
4. Meta constraint functions
1515
5. Mapping JSON distributions, effects, and estimators to python objects
1616

17+
Use case specific information is also declared here such as the paths to the relevant files needed for the tests.
18+
1719
`examples/poisson/causal_tests.json` is the JSON file that allows for the easy specification of multiple causal tests.
1820
Each test requires:
1921
1. Test name
@@ -25,8 +27,8 @@ Each test requires:
2527
7. Skip: boolean that if set true the test won't be executed and will be skipped
2628

2729
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"`
2931

3032
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"`
3234

0 commit comments

Comments
 (0)