Skip to content

Commit 9dd94f8

Browse files
committed
fix: misc typos
1 parent 61d1e3d commit 9dd94f8

File tree

3 files changed

+7
-14
lines changed

3 files changed

+7
-14
lines changed

docs/source/dev/actions_and_webhooks.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Github Actions and Webhooks
44
Actions
55
--------------
66

7-
Currently, this project makes use of 4 `Github Actions <https://github.com/features/actions>`_,
7+
Currently, this project makes use of 5 `Github Actions <https://github.com/features/actions>`_,
88
which can be found in the
99
`.github/workflows <https://github.com/CITCOM-project/CausalTestingFramework/tree/main/.github/workflows>`_ directory.
1010

docs/source/frontends/json_front_end.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The second method of specifying a test is to specify the test in a concrete form
6060

6161
Alternatively, a ``causal_tests.json`` file can be created from a ``dag.dot`` file using the ``causal_testing/specification/metamorphic_relation.py`` script as follows::
6262

63-
python causal_testing/specification/metamorphic_relation.py --dag_path dag.dot --output_path causal_tests.json
63+
python causal_testing/testing/metamorphic_relation.py --dag_path dag.dot --output_path causal_tests.json
6464

6565
Run Commands
6666
************
@@ -88,4 +88,4 @@ Runtime Data
8888
There are currently 2 methods to inputting your runtime data into the JSON frontend:
8989

9090
#. Providing one or more file paths to `.csv` files containing your data
91-
#. Setting a dataframe to the .data attribute of the JSONUtility instance, this must be done before the setup method is called.
91+
#. Setting a dataframe to the `.data` attribute of the JSONUtility instance, this must be done before the setup method is called.

docs/source/frontends/test_suite.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ This structure is defined by the parameters in the class: :class:`causal_testing
77
A current limitation of the Test Suite is that it requires references to the estimator class, not instances (objects) of
88
estimator classes, which prevents the usage of some of the features of an estimator.
99

10-
Class
11-
--------------------
12-
The test_suite class is an extension of the python UserDict_, meaning it simulates a standard Python dictionary where
10+
The test_suite class is an extension of the Python UserDict_, meaning it simulates a standard Python dictionary where
1311
any dictionary method can be used. The class also features a setter to make adding new test cases quicker and less
1412
error prone :meth:`causal_testing.testing.causal_test_suite.CausalTestSuite.add_test_object`.
1513

@@ -23,14 +21,9 @@ the value is a test object in the format of another dictionary:
2321
Each ``base_test_case`` contains the treatment and outcome variables, and only causal_test_cases testing this relationship
2422
should be placed in the test object for that ``base_test_case``.
2523

26-
.. _UserDict: https://docs.python.org/3/library/collections.html#collections.UserDict
2724

28-
Execution
29-
-----------------------
30-
The test_suite can be executed by a call to the :meth:`causal_testing.testing.causal_test_engine.CausalTestEngine.execute_test_suite`.
31-
Here the causal_test_engine will iterate over all the test objects and execute each `test` once per `estimator` and per
32-
`estimate_type`.
25+
Following this, users can similarly execute a suite of causal tests and return the results in a list by executing the
26+
class's :meth:`causal_testing.testing.causal_test_suite.CausalTestSuite.execute_test_suite` method.
27+
3328

34-
This structure allows for some optimisations in running cost by only performing certain actions like identification
35-
when necessary and not for every `causal_test_case`.
3629

0 commit comments

Comments
 (0)