Skip to content

Commit f1ac0ad

Browse files
link json_front_end.rst to autoapi pages
1 parent f2b0022 commit f1ac0ad

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/source/frontends/json_front_end.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ The basic workflow of using the JSON frontend is as follows:
1010
#. Specify your test cases in the JSON format (more details below)
1111
#. Create your DAG in a dot file
1212
#. Initialise the JsonUtility class in python with a path of where you want the outputs saved
13-
#. Set the paths pointing the Json class to your json file, dag file and optionally your data file (see data section below) using the .set_paths method
14-
#. Run the .setup method providing your scenario
15-
#. Run the .run_json_tests method, which will execute the test cases provided by the JSON file.
13+
#. Set the paths pointing the Json class to your json file, dag file and optionally your data file (see data section below) using the :func:`causal_testing.json_front.json_class.JsonUtility.set_paths` method
14+
#. Run the :func:`causal_testing.json_front.json_class.JsonUtility.setup` method providing your scenario
15+
#. Run the :func:`causal_testing.json_front.json_class.JsonUtility.run_json_tests` method, which will execute the test cases provided by the JSON file.
1616

1717
Example Walkthrough
1818
-------------------
@@ -24,6 +24,7 @@ run_causal_tests.py
2424
`examples/poisson/run_causal_tests.py <https://github.com/CITCOM-project/CausalTestingFramework/blob/main/examples/poisson/run_causal_tests.py>`_
2525
contains python code written by the user to implement scenario specific features
2626
such as:
27+
2728
#. Custom Estimators
2829
#. Causal Variable specification
2930
#. Causal test case outcomes

0 commit comments

Comments
 (0)